com.sapportals.wcm.service.indexmanagement.retrieval.classification
Class DocClassificationMapList

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.service.indexmanagement.retrieval.classification.DocClassificationMapList

All Implemented Interfaces:

IDocClassificationMapList

public class DocClassificationMapList

extends java.lang.Object

implements IDocClassificationMapList

List of documents with their classifications.

Constructor Summary

DocClassificationMapList()

Method Summary

boolean	add(IDocClassificationMap docClassificationMap)
void	add(int index, IDocClassificationMap docClassificationMap)
boolean	addAll(IDocClassificationMapList docClassificationMapList) Add All to the IDocClassificationMapList object.
void	addFirst(IDocClassificationMap docClassificationMap) Add First to the IDocClassificationMap object.
void	addLast(IDocClassificationMap docClassificationMap) Add Last to the IDocClassificationMapList object.
void	clear() clears/initializes the list
boolean	contains(IDocClassificationMap docClassificationMap)
IDocClassificationMap	get(int index)
IDocClassificationMap	get(RID documentRid)
boolean	isEmpty() Get the Empty attribute of the IDocClassificationMapList object.
IDocClassificationMapIterator	listIterator()
IDocClassificationMapIterator	listIterator(int index)
void	remove(IDocClassificationMap docClassificationMap)
IDocClassificationMap	remove(int index)
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocClassificationMapList

public DocClassificationMapList()

Method Detail

size

public int size()

Specified by:

size in interface IDocClassificationMapList

Returns:

size of the IDocClassificationMapList

isEmpty

public boolean isEmpty()

Get the Empty attribute of the IDocClassificationMapList object.

Specified by:

isEmpty in interface IDocClassificationMapList

Returns:

The Empty value

add

public boolean add(IDocClassificationMap docClassificationMap)

Specified by:

add in interface IDocClassificationMapList

Parameters:

docClassificationMap - IDocClassificationMap to add to list

Returns:

true if map has been added successfully

get

public IDocClassificationMap get(int index)

Specified by:

get in interface IDocClassificationMapList

Parameters:

index - position in list to get IDocClassificationMap from

Returns:

IDocClassificationMap at the requested position

add

public void add(int index,
                IDocClassificationMap docClassificationMap)

Specified by:

add in interface IDocClassificationMapList

Parameters:

index - position where to add the IDocClassificationMap

docClassificationMap - IDocClassificationMap to add at the position

addAll

public boolean addAll(IDocClassificationMapList docClassificationMapList)

Add All to the IDocClassificationMapList object.

Specified by:

addAll in interface IDocClassificationMapList

Parameters:

docClassificationMapList - All to be added

Returns:

true if list could be added successfully

addLast

public void addLast(IDocClassificationMap docClassificationMap)

Add Last to the IDocClassificationMapList object.

Specified by:

addLast in interface IDocClassificationMapList

Parameters:

docClassificationMap - Last to be added

addFirst

public void addFirst(IDocClassificationMap docClassificationMap)

Add First to the IDocClassificationMap object.

Specified by:

addFirst in interface IDocClassificationMapList

Parameters:

docClassificationMap - First to be added

remove

public IDocClassificationMap remove(int index)

Specified by:

remove in interface IDocClassificationMapList

Parameters:

index - position where the element has to be removed

Returns:

IDocClassificationMap that has been removed

remove

public void remove(IDocClassificationMap docClassificationMap)

Specified by:

remove in interface IDocClassificationMapList

Parameters:

IDocClassificationMap - that has to be removed

listIterator

public IDocClassificationMapIterator listIterator()

Specified by:

listIterator in interface IDocClassificationMapList

Returns:

IDocClassificationMap iterator

listIterator

public IDocClassificationMapIterator listIterator(int index)

Specified by:

listIterator in interface IDocClassificationMapList

Parameters:

index - position to start for iterator

Returns:

IDocClassificationMap iterator

contains

public boolean contains(IDocClassificationMap docClassificationMap)

Specified by:

contains in interface IDocClassificationMapList

Parameters:

docClassificationMap - IDocClassificationMap for that the existence has to be tested in the list

Returns:

true if IDocClassificationMap is in the list

get

public IDocClassificationMap get(RID documentRid)
                          throws WcmException

Specified by:

get in interface IDocClassificationMapList

Parameters:

document - rid for IDocClassificationMap to get

Returns:

requested IDocClassificationMap

clear

public void clear()

clears/initializes the list

Specified by:

clear in interface IDocClassificationMapList