com.crystaldecisions.sdk.occa.pluginmgr
Interface IPluginMgr

public interface IPluginMgr

The Plugin Manager manages the deployment of desktop plugins.

The IPluginManager interface can be obtained from EnterpriseSession object by calling the getPluginManager() method. Note that the PluginManager interface cannot be used separately from the EnterpriseSession object.

Nested Class Summary

static interface	IPluginMgr.Category This interface defines possible values for the plugin category.
static interface	IPluginMgr.Type This interface defines possible values for the types of plugin interface retrieval.

Method Summary

IPluginInfo	getPluginInfo(java.lang.Object plgkey) Returns information on an available plugin at the CMS.
java.lang.Object	getPluginInterface(java.lang.Object plgkey, java.lang.String type) Retrieves a specific plugin interface given the ProgID or object type.
IPluginInfo[]	getPlugins(java.lang.String Category) Returns a collection of plugins in a given category that are installed on the CMS.
IPluginInfo[]	getPluginsByFileExtensions(java.lang.String fileExt) Returns a collection of plugins that contains the potential file extension specified.
IPluginInfo[]	getPluginsCanSubscribeDirectly() Returns a collection of plugins to which you can directly subscribe for alerts.
IPluginInfo[]	getPluginsSupportRecentDocuments() Returns a collection of plugins that support recent document feature.
IPluginInfo[]	getPluginsWithTypeSpecificRights() Returns a collection of plugins that contains type specific rights.
IPluginInfo[]	getWebAppContentPlugins() Returns a collection of plugins that consider as Web application content.

Method Detail

getPluginInfo

IPluginInfo getPluginInfo(java.lang.Object plgkey)
                          throws SDKException

Returns information on an available plugin at the CMS.

Parameters:

plgkey - An Object specifying a ProgID or the Type of the plugin for which information is to be retrieved.

Returns:

An IPluginInfo object containing information on the specified plugin.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginInterface

java.lang.Object getPluginInterface(java.lang.Object plgkey,
                                    java.lang.String type)
                                    throws SDKException

Retrieves a specific plugin interface given the ProgID or object type.

Parameters:

plgkey - An Object specifying a ProgID of the plugin.

type - Specifies the type of plugin interface to retrieve. This should be one of type IPluginMgr.Type.

Returns:

An Object containing the plugin interface specified. The type that this object can be cast as depends on the ProgID or Type of the plugin that was supplied as an argument. For example, if the ProgID supplied was 'CrystalEnterprise.Server' then the returned Object will be of type IServer.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPluginMgr.Type, CePropertyID

getPlugins

IPluginInfo[] getPlugins(java.lang.String Category)
                         throws SDKException

Returns a collection of plugins in a given category that are installed on the CMS.

Parameters:

Category - The category for which a collection of plugin is to be retrieved.

Returns:

An array of IPluginInfo objects containing the plugins in a given category that are installed on the CMS.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IPluginMgr.Category

getWebAppContentPlugins

IPluginInfo[] getWebAppContentPlugins()
                                      throws SDKException

Returns a collection of plugins that consider as Web application content.

Returns:

An array of IPluginInfo objects consider as Web application content.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginsWithTypeSpecificRights

IPluginInfo[] getPluginsWithTypeSpecificRights()
                                               throws SDKException

Returns a collection of plugins that contains type specific rights.

Returns:

An array of IPluginInfo objects that contains type specific rights.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginsSupportRecentDocuments

IPluginInfo[] getPluginsSupportRecentDocuments()
                                               throws SDKException

Returns a collection of plugins that support recent document feature.

Returns:

An array of IPluginInfo that support recent document feature.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginsByFileExtensions

IPluginInfo[] getPluginsByFileExtensions(java.lang.String fileExt)
                                         throws SDKException

Returns a collection of plugins that contains the potential file extension specified.

Parameters:

fileExt - The file extension you want to find what plugins contain.

Returns:

An array of IPluginInfo objects that contains the potential file extension specified.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginsCanSubscribeDirectly

IPluginInfo[] getPluginsCanSubscribeDirectly()
                                             throws SDKException

Returns a collection of plugins to which you can directly subscribe for alerts. Some event types can be subscribed to directly and will be returned in this collection. Others are exposed in the UI only within the context of their source object (eg. CrystalReport for a CR Event). In the latter case, the source object type will be returned in this collection but not the dependent event type.

Throws:

SDKException

Since:

4.0