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


public interface IManagedOptions

The IManagedOptions interface allows you to set the managed destination options for a managed destination.


Nested Class Summary
static interface IManagedOptions.CeDestinationOption
           This interface defines constants that describe the managed destination options for an object.
static interface IManagedOptions.CeManagedSendOption
           This interface defines constants that describe the send options for an object being sent to a managed destination.
 
Method Summary
 int getDestinationOption()
           Returns the managed destination.
 java.util.Set getDestinations()
           Returns a collection of destination IDís.
 int getSendOption()
           Returns the send option for the object.
 java.util.Set getSourceObjects()
           Returns a collection of source object IDís.
 java.lang.String getTargetObjectName()
           Returns the name of the target object.
 boolean isIncludeInstance()
           Returns a boolean that indicates whether the instance of the scheduled object will be sent to the specified location(s) when it is successfully processed.
 void setDestinationOption(int option)
           Sets the managed destination option.
 void setIncludeInstance(boolean include)
           Sets a boolean that indicates whether the instance of the scheduled object is sent to the specified location(s) when it is successfully processed.
 void setSendOption(int option)
           Sets the send option for the object.
 void setTargetObjectName(java.lang.String name)
           Sets the name of the target object.
 

Method Detail

getSendOption

public int getSendOption()

Returns the send option for the object.

Send options:

Returns:
A CeManagedSendOption that indicates the send option.
See Also:
IManagedOptions.CeManagedSendOption

setSendOption

public void setSendOption(int option)

Sets the send option for the object.

Send options:

Parameters:
option - An int that specifies the send option.
See Also:
IManagedOptions.CeManagedSendOption

getDestinationOption

public int getDestinationOption()

Returns the managed destination.

Managed destination options:

Returns:
An int that indicates the managed destination option.
See Also:
IManagedOptions.CeDestinationOption

setDestinationOption

public void setDestinationOption(int option)

Sets the managed destination option.

Managed destination options:

Parameters:
option - An int that specifies the managed destination option.
See Also:
IManagedOptions.CeDestinationOption

getSourceObjects

public java.util.Set getSourceObjects()

Returns a collection of source object IDís.

These identifiers are used to reference the instance objects that will be sent along with the original object that was selected to be sent or scheduled to a managed destination.

Note: A source object is defined as an existing object or instance; it does not cause the system to run the object and create new instances or request that data be refreshed.

Returns:
A Set that contains source object IDs.

getDestinations

public java.util.Set getDestinations()

Returns a collection of destination IDís.

These identifiers are used to reference the different locations that the object instances will be sent to. Each ID must be a valid user or user group ID. In addition, if the ID added to the collection is associated with a user group then all of its members will be part of the distribution list.

Note: An object instance is an object that does not require further processing; it does not cause the system to run the object and create new instances or request that data be refreshed.

Returns:
A Set that contains destination IDs.

getTargetObjectName

public java.lang.String getTargetObjectName()

Returns the name of the target object.

Use this property to retrieve the name of the shortcut or copy that you are sending. If this property is not set the name is automatically generated. In both scenario's the target object name is appended to the object ID.

Returns:
A String that indicates the name of the managed send option.
See Also:
IManagedOptions.CeManagedSendOption

setTargetObjectName

public void setTargetObjectName(java.lang.String name)

Sets the name of the target object.

Use this property to customize the name of the shortcut or copy that you are sending. If this property is not set the name is automatically generated. In both scenario's the target object name is appended to the object ID.

Parameters:
name - A String that specifies the name of the managed send option.
See Also:
IManagedOptions.CeManagedSendOption

isIncludeInstance

public boolean isIncludeInstance()

Returns a boolean that indicates whether the instance of the scheduled object will be sent to the specified location(s) when it is successfully processed.

The instance of the scheduled object is generated after the job has completed processing and no error has been encountered. This instance will contain fresh data.

This property only applies to objects that have been scheduled to a managed destination. The following objects can be scheduled:

Returns:
true if the instance of the scheduled object will be sent to the specified location(s) when it is successfully processed, and false otherwise.

setIncludeInstance

public void setIncludeInstance(boolean include)

Sets a boolean that indicates whether the instance of the scheduled object is sent to the specified location(s) when it is successfully processed.

The instance of the scheduled object is generated after the job has completed processing and no error has been encountered. This instance will contain fresh data.

This property only applies to objects that have been scheduled to a managed destination. The following objects can be scheduled: