com.crystaldecisions.sdk.plugin.desktop.common
Interface IPublicationDynamicRecipients

public interface IPublicationDynamicRecipients

This interface defines a collection that contains IPublicationDynamicRecipient objects. It is used to create a subset of recipients to whom the publication is delivered. Recipients in this collection must match recipients in the dynamic recipient provider. When populated, only the dynamic recipients who are in this collection and whose profile values match those specified recieve the publication. All other dynamic recipients in the provider are ignored.

Method Summary

void	add(java.lang.Object objValue) Adds a dynamic recipient to the collection.
void	clear() Removes all dynamic recipients from the collection.
java.lang.Object	get(int index) Returns the dynamic recipient object at the specified index.
java.lang.Object	remove(int index) Removes the dynamic recipient at the specified index.
boolean	remove(java.lang.Object objValue) Removes the specified dynamic recipient.
void	removeAll(java.util.Collection collectionVal) Removes the specified dynamic recipients from the collection.
void	set(int index, java.lang.Object objValue) Sets a dynamic recipient.
int	size() Returns the size of the collection.

Method Detail

add

void add(java.lang.Object objValue)

Adds a dynamic recipient to the collection.

Parameters:

objValue - the object containing the properties of the dynamic recipient

get

java.lang.Object get(int index)

Returns the dynamic recipient object at the specified index.

Parameters:

index - the position of the recipient within the collection

Returns:

An Object that contains the properties of the dynamic recipient.

set

void set(int index,
         java.lang.Object objValue)
         throws SDKException

Sets a dynamic recipient.

Parameters:

index - the location to be added

objValue - the object that contains the properties of the dynamic recipient

Throws:

SDKException

remove

java.lang.Object remove(int index)
                        throws SDKException

Removes the dynamic recipient at the specified index.

Parameters:

index - the index of the dynamic recipient to remove

Throws:

SDKException

removeAll

void removeAll(java.util.Collection collectionVal)
               throws SDKException

Removes the specified dynamic recipients from the collection.

Parameters:

collectionVal - A Collection containing the dynamic recipients to be removed

Throws:

SDKException

remove

boolean remove(java.lang.Object objValue)

Removes the specified dynamic recipient.

Parameters:

objValue - An Object represent the object value

clear

void clear()
           throws SDKException

Removes all dynamic recipients from the collection.

Throws:

SDKException

size

int size()

Returns the size of the collection.

Returns:

The number of dynamic recipients in the collection.