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

All Superinterfaces:

IDestinationScheduleOptions

public interface IManagedOptions
extends IDestinationScheduleOptions

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.
IOptionsByDocs	getOptionsByDocs() Collection of options associated with a set of documents to be delivered.
int	getSendOption() Returns the send option for the object.
java.util.Set	getSourceObjects() Returns a collection of source object IDs.
java.lang.String	getTargetObjectName() Returns the name of the target object.
boolean	isAddFileExtension() Gets the boolean value for the SI_ADD_FILE_EXTENSION property bag which is used to determine if there needs to be file extensions in destination file names
boolean	isCreateNewObject() Returns a boolean value that indicates whether a new object of the report instance will be created when the operation is successfully processed.
boolean	isIncludeInstance() Returns a boolean that indicates whether an instance of the scheduled object and the input files are sent to the specified location(s) when it is successfully processed.
boolean	isInstanceAsParent() Returns a boolean value that indicates whether the instance of the scheduled object is set as the parent of the input files when the object is successfully processed and sent to the specified locations(s).
boolean	isKeepSavedData() Returns a boolean value that indicates whether the instance of the scheduled object will include saved data even if the report itself has the same option turned off.
void	setAddFileExtension(boolean addFileExtension) Sets a boolean value for the SI_ADD_FILE_EXTENSION property bag which is used to determine if there needs to be file extensions in the destination file names
void	setCreateNewObject(boolean createNewObj) Sets a boolean value that indicates whether a new object of the report instance will be created when the operation is successfully processed.
void	setDestinationOption(int option) Sets the managed destination option.
void	setIncludeInstance(boolean include) Sets a boolean that indicates whether an instance of the scheduled object and the input files are sent to the specified location(s) when it is successfully processed.
void	setInstanceAsParent(boolean parent) Sets a boolean value that indicates whether the instance of the scheduled object is set as the parent of the input files when the object is successfully processed and sent to the specified locations(s).
void	setKeepSavedData(boolean bKeepSavedData) Sets a boolean value that indicates whether the instance of the scheduled object will include saved data even if the report itself has the same option turned off.
void	setSendOption(int option) Sets the send option for the object.
void	setTargetObjectName(java.lang.String name) Sets the name of the target object.

Methods inherited from interface com.crystaldecisions.sdk.plugin.destination.common.IDestinationScheduleOptions

getInputFiles

Method Detail

getSendOption

int getSendOption()

Returns the send option for the object.

Send options:

• IManagedOptions.CeManagedSendOption.ceCopy - A copy of the instance of the object is sent to the specified managed destination.
• IManagedOptions.CeManagedSendOption.ceShortcut - A shortcut link to the copy of the instance of the object is sent to the specified managed destination.

Returns:

A CeManagedSendOption that indicates the send option.

See Also:

IManagedOptions.CeManagedSendOption

setSendOption

void setSendOption(int option)

Sets the send option for the object.

Send options:

• IManagedOptions.CeManagedSendOption.ceCopy - A copy of the instance of the object is sent to the specified managed destination.
• IManagedOptions.CeManagedSendOption.ceShortcut - A shortcut link to the copy of the instance of the object is sent to the specified managed destination.

Parameters:

option - An int that specifies the send option.

See Also:

IManagedOptions.CeManagedSendOption

getDestinationOption

int getDestinationOption()

Returns the managed destination.

Managed destination options:

• IManagedOptions.CeDestinationOption.ceInbox - Indicates that the object will be sent to the user's inbox.
• IManagedOptions.CeDestinationOption.ceFavoritesFolder - Indicates that the object is sent to the user's favorites folder.

Returns:

An int that indicates the managed destination option.

See Also:

IManagedOptions.CeDestinationOption

setDestinationOption

void setDestinationOption(int option)

Sets the managed destination option.

Managed destination options:

• IManagedOptions.CeDestinationOption.ceInbox - Specifies that the object will be sent to the user's inbox.
• IManagedOptions.CeDestinationOption.ceFavoritesFolder - Specifies that the object is sent to the user's favorites folder.

Parameters:

option - An int that specifies the managed destination option.

See Also:

IManagedOptions.CeDestinationOption

getSourceObjects

java.util.Set getSourceObjects()

Returns a collection of source object IDs.

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

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. This Set contains Integer objects.

getTargetObjectName

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

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

getOptionsByDocs

IOptionsByDocs getOptionsByDocs()

Collection of options associated with a set of documents to be delivered. Options include target object name associated with each deliverable document. For details on target object names, refer to getTargetObjectName

Returns:

Collection of target names mapped to a set of documents

isIncludeInstance

boolean isIncludeInstance()

Returns a boolean that indicates whether an instance of the scheduled object and the input files are sent to the specified location(s) when it is successfully processed.

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

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Returns:

A boolean that indicates whether the instance should be included in the object set that is being sent to the specified location(s) when it is successfully processed.

setIncludeInstance

void setIncludeInstance(boolean include)

Sets a boolean that indicates whether an instance of the scheduled object and the input files are 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:

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Parameters:

include - A boolean that indicates whether the instance should be included in the object set that is being sent to the specified location(s) when it is successfully processed.

isInstanceAsParent

boolean isInstanceAsParent()

Returns a boolean value that indicates whether the instance of the scheduled object is set as the parent of the input files when the object is successfully processed and sent to the specified locations(s).

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

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Returns:

A boolean value that indicates whether the instance should be set as the parent of the input files when the object set is successfully processed and sent to specific location(s).

setInstanceAsParent

void setInstanceAsParent(boolean parent)

Sets a boolean value that indicates whether the instance of the scheduled object is set as the parent of the input files when the object is successfully processed and sent to the specified locations(s).

Setting parent to be true indicates that the currently running instance of the scheduled object is set as a parent of the input files that are processed.

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

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Parameters:

parent - A boolean value that indicates whether the instance should be set as the parent of the input files when the object set is successfully processed and sent to specific location(s).

isCreateNewObject

boolean isCreateNewObject()

Returns a boolean value that indicates whether a new object of the report instance will be created when the operation is successfully processed.

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

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Returns:

A boolean value that indicates whether a new object of the report instance should be created when the object set is successfully processed and sent to the specified location(s).

setCreateNewObject

void setCreateNewObject(boolean createNewObj)

Sets a boolean value that indicates whether a new object of the report instance will be created when the operation is successfully processed.

The SI_FILES of the created object will be populated with data from one of the following fields in the current running report instance:

• SI_INPUT_FILES specified in the destination options.
• SI_FILES if destination options is not specified.

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:

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Parameters:

createNewObj - A boolean value that indicates whether a new object of the report instance should be created when the object set is successfully processed and sent to the specified location(s).

isKeepSavedData

boolean isKeepSavedData()

Returns a boolean value that indicates whether the instance of the scheduled object will include saved data even if the report itself has the same option turned off.

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:

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Returns:

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

setKeepSavedData

void setKeepSavedData(boolean bKeepSavedData)

Sets a boolean value that indicates whether the instance of the scheduled object will include saved data even if the report itself has the same option turned off.

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:

• reports (Crystal Reports, Web Intelligence documents, and Web Intelligence reports)
• programs (Java, Executable, and Script)
• object packages

Parameters:

createNewObj - A boolean value that indicates whether the instance should be included in the object set that is being sent to the specified location(s) when it is successfully processed.

isAddFileExtension

boolean isAddFileExtension()

Gets the boolean value for the SI_ADD_FILE_EXTENSION property bag which is used to determine if there needs to be file extensions in destination file names

Returns:

true or false

setAddFileExtension

void setAddFileExtension(boolean addFileExtension)

Sets a boolean value for the SI_ADD_FILE_EXTENSION property bag which is used to determine if there needs to be file extensions in the destination file names

Parameters:

addFileExtension - the boolean value to set