Package com.crystaldecisions.sdk.plugin.destination.managed

This package contains two classes that provide a framework through which managed destination options can be maintained.

See:
Description

Interface Summary

IManaged	This interface extends the IInfoObject and the IDestinationPlugin interfaces.
IManagedOptions	The IManagedOptions interface allows you to set the managed destination options for a managed destination.
IManagedOptions.CeDestinationOption	This interface defines constants that describe the managed destination options for an object.
IManagedOptions.CeManagedSendOption	This interface defines constants that describe the send options for an object being sent to a managed destination.
IOptionsByDocs	This interface provides access to a collection of options associated with a document to be delivered.
IOptionsPerDoc	This interface represents a collection of documents to be delivered and their associated options for the managed destination.

Package com.crystaldecisions.sdk.plugin.destination.managed Description

This package contains two classes that provide a framework through which managed destination options can be maintained.

A managed destination is a location that resides within the SAP BusinessObjects Enterprise system. Specifically it refers to an inbox or favorites folder that is associated with an existing user.

Three types of options can be set for this type of destination: global, scheduling, and send:

• Global options are the default destination settings for a particular job server.
• Scheduling options are the default settings for the destination plugin and can be copied to any schedulable object. For more information on which objects can be scheduled, see the SAP BusinessObjects Enterprise Administrator’s Guide.
• Send options are the default settings for the destination plugin and can be copied to any SAP BusinessObjects Enterprise object. An object that is sent directly to a managed destination cannot require further processing; it does not cause the system to run the object and create new instances or request that the data be refreshed. The destination job server is responsible for transferring these types of objects to a managed destination; this server is unlike other job servers in that it does not handle scheduling or processing. For more information on objects, the destination job server and managed destinations in the SAP BusinessObjects Enterprise, see the SAP BusinessObjects Enterprise Administrator’s Guide.

Note:When an object is scheduled and processed, the global and scheduling options are compared; the scheduling options override the global option. When an object is sent to a destination, the global and send options are compared ; the send options override the global options.

The global, schedule, and send options are set through the corresponding object: the IDiskUnmanagedOptions object, IFtpOptions object, IManagedOptions object, and ISMTPOptions object. Set the global options by using the getPluginInterface() method of the IJobServerDestination object to retrieve the destination plugin. Set the schedule options by directly querying the CMS InfoStore for the destination plugin. The query returns the plugin's default object, through which you can access the destination options object.

Note: Enable the destination with IJobServerDestination before a job for that destination is run.

Example

The following example retrieves the Managed interface:

IInfoObjects serverObjs = iStore.query( "SELECT SI_NAME, SI_SERVER_KIND FROM CI_SYSTEMOBJECTS WHERE 
        SI_KIND='Server' AND SI_SERVER_KIND='jobserver'");

for (int i = 0; i < serverObjs.size(); i++)
{
        IInfoObject obj = (IInfoObject) serverObjs.get(i);
        IServer serverObj = (IServer) obj;
        IJobServerAdmin jobServer = (IJobServerAdmin) serverObj.getServerAdmin();
        IJobServerDestination[] jobServerDests = jobServer.getDestinations( iStore );
        
        for ( int j = 0; j < jobServerDests.length; j++ )
        {
                IJobServerDestination jobServerDest = jobServerDests[ j ];

                if ( jobServerDest.getName().equals( "Managed" ) )
                {                       
                        IManagedOptions managedOptions = (IManagedOptions) jobServerDest.getPluginInterface();          
                }
        }
}

The query method returns a collection of InfoObjects, which in this case are Server plugin objects. Like other InfoObjects, these objects are uniquely represented by their ID property. For each object in the collection, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

The process for retrieving a destination plugin is as follows:

1. Query the IInfoStore object for the job server objects.
2. For each job server object, get the job server admin.
3. Using the job server admin, retrieve the job server destinations. The destinations will be returned as an array.
4. For each item in the array, check whether the destination has the SI_KIND "Managed".
5. If the destination is the Managed destination, retrieve the plugin interface.
6. From the plugin interface the IManagedOptions object can be retrieved. This object allows you to modify the properties of the managed destination.