com.crystaldecisions.sdk.occa.infostore
Interface IDestinations

All Superinterfaces:
java.util.Collection, java.lang.Iterable, java.util.List

public interface IDestinations
extends java.util.List

Returns a collection of IDestination objects.


Method Summary
 IDestination add(java.lang.String name)
           Add a new destination.
 void addAll(IDestinations destinations)
           
 boolean isCleanup()
           
 void setCleanup(boolean cleanup)
           
 
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

add

IDestination add(java.lang.String name)
                 throws SDKException

Add a new destination. The name of the new destination should be a string that equals the prog id of the intended destination plugin.

Note: For a scheduling destination, it can be:

Note: For an alert destination, it can only be:

Parameters:
name - A String specifying the name of the new destination to be added. Equals the progid of the intended destination plugin. They are case sensitive so better to use CeProgID.
Returns:
the new destination.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isCleanup

boolean isCleanup()
                  throws SDKException
Throws:
SDKException

setCleanup

void setCleanup(boolean cleanup)
                throws SDKException
Throws:
SDKException

addAll

void addAll(IDestinations destinations)