com.crystaldecisions.sdk.plugin.destination.managed
Interface IOptionsByDocs

All Superinterfaces:

java.util.Collection, ISDKList, java.lang.Iterable, java.util.List

public interface IOptionsByDocs
extends ISDKList

This interface provides access to a collection of options associated with a document to be delivered.

Method Summary

IOptionsPerDoc	addDoc(int docID) Adds a document
IOptionsPerDoc	getDoc(int docID) Gets the options associated with a document to be delivered
boolean	removeDoc(int docID) Removes a document entry from the collection

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKList

get

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

addDoc

IOptionsPerDoc addDoc(int docID)

Adds a document

Parameters:

docID - Document ID

Returns:

The IOptionsPerDoc object in the collection associated with the document ID

removeDoc

boolean removeDoc(int docID)

Removes a document entry from the collection

Parameters:

docID - Document ID

Returns:

true if the document is removed successfully, false otherwise

getDoc

IOptionsPerDoc getDoc(int docID)

Gets the options associated with a document to be delivered

Parameters:

docID - Document ID

Returns:

The IOptionsPerDoc object in the collection associated with the document ID