org.mydm.core
Interface EDocResSet

All Known Implementing Classes:

EDocResSetImpl

public interface EDocResSet

An Interface describing the container for EDocuments.

Method Summary

void	addEDoc(EDocument edoc) Adds an EDocument to the container
void	addEDocs(EDocResSet edocresset) Adds the EDocuments from the EDocResSet to the current set.
void	addEDocs(EDocument[] edocary) Adds an array of EDocument Objects.
void	clear() Clears the Current set
EDocument	getEDoc(long index) Gets the EDocument at particular index.
EDocResSet	getEDocs(long from, long to) Returns the EDocResSet of certain range.
EDocument[]	getEDocsAsArray(long from, long to) Returns an array of EDocument Object.
EDocResIterator	getIterator() Gets an iterator for the container
long	getSize() Gets the size of the set
void	removeEDoc(long index) Removes an EDocument at a given index.

Method Detail

clear

public void clear()

Clears the Current set

addEDoc

public void addEDoc(EDocument edoc)

Adds an EDocument to the container

Parameters:

edoc -

addEDocs

public void addEDocs(EDocResSet edocresset)

Adds the EDocuments from the EDocResSet to the current set.

Parameters:

edocresset - edocresource set

addEDocs

public void addEDocs(EDocument[] edocary)

Adds an array of EDocument Objects.

Parameters:

edocary - array of EDocument Objects.

getIterator

public EDocResIterator getIterator()

Gets an iterator for the container

Returns:

iterator EDocResIterator

getEDoc

public EDocument getEDoc(long index)
                  throws MyDMException

Gets the EDocument at particular index.

Parameters:

index - the index of the EDocument to retrieve

Returns:

edoc EDocument

Throws:

MyDMException

getEDocs

public EDocResSet getEDocs(long from,
                           long to)
                    throws MyDMException

Returns the EDocResSet of certain range.

Parameters:

from - start index

to - stop index

Returns:

edocs result set

Throws:

MyDMException

getEDocsAsArray

public EDocument[] getEDocsAsArray(long from,
                                   long to)
                            throws MyDMException

Returns an array of EDocument Object. This can be very handy.

Parameters:

from - start index

to - until index

Returns:

Array of EDocument Objects

Throws:

MyDMException

getSize

public long getSize()

Gets the size of the set

Returns:

size of the set

removeEDoc

public void removeEDoc(long index)
                throws MyDMException

Removes an EDocument at a given index.

Parameters:

index -

Throws:

MyDMException