com.crystaldecisions.sdk.occa.pluginmgr
Interface IPluginInfo

public interface IPluginInfo

This interface is used to retrieve description information related to a plugin. The information is originally retrieved from the .pin file of a plugin and is written to the local registry after plugin installation.

Method Summary

java.lang.String	getCategory() Returns the category to which the plugin belongs.
IPluginFactory	getFactory() Returns the factory object for this plugin.
java.lang.String	getKind() Returns the InfoObject type.
java.lang.String	getName() Returns the friendly name or description of the plugin.
java.lang.String	getObjectTypeName() Returns the processing DLL name.
java.lang.String	getProgID() Returns the plugin's ProgID.
java.lang.String	getPropertyIndex() Returns the plugin property index list.
int	getRootFolderID() Deprecated. use #getFolderIDs instead
int[]	getRootFolderIDs() Returns the root folder IDs.
IPluginSecurityInfo	getSecurityInfo() Returns the custom rights info for this plugin.
short	getType() Returns the plugin's type.
java.lang.String	getVersion() Returns the version number of the plugin.
boolean	isManagedDestination() Returns a boolean that indicates whether the object is a destination within the BusinessObjects Enterprise Infrastructure.
boolean	isSchedulable() Returns a boolean that indicates whether this object can be scheduled.
boolean	isSendable() Returns a boolean that indicates whether the object can be sent.

Method Detail

getCategory

public java.lang.String getCategory()

Returns the category to which the plugin belongs. For example, desktop plugin or admin plugin.

Returns:

A String containing the category that the plugin belongs to.

getName

public java.lang.String getName()

Returns the friendly name or description of the plugin.

Returns:

A String containing the friendly name or description of the plugin.

getObjectTypeName

public java.lang.String getObjectTypeName()

Returns the processing DLL name.

Returns:

A String containing the processing DLL name.

getFactory

public IPluginFactory getFactory()

Returns the factory object for this plugin.

Returns:

The IPluginFactory object for this plugin or null if it is not installed.

getProgID

public java.lang.String getProgID()

Returns the plugin's ProgID.

Returns:

A String containing the plugin's ProgID.

getPropertyIndex

public java.lang.String getPropertyIndex()

Returns the plugin property index list.

Returns:

A String containing the plugin property index list.

getType

public short getType()

Returns the plugin's type.

Returns:

The plugin's type as a short.

getKind

public java.lang.String getKind()

Returns the InfoObject type. For more information see the CeKind class.

Returns:

A String that indicates the InfoObject type.

getVersion

public java.lang.String getVersion()

Returns the version number of the plugin.

Returns:

A String containing the plugin's version number.

getSecurityInfo

public IPluginSecurityInfo getSecurityInfo()

Returns the custom rights info for this plugin.

Returns:

A IPluginSecurityInfo object specifying the rights for this plugin.

getRootFolderID

public int getRootFolderID()

Deprecated. use #getFolderIDs instead

Returns the root folder ID.

Returns:

A int indicating the root folder ID of this plugin.

isSchedulable

public boolean isSchedulable()

Returns a boolean that indicates whether this object can be scheduled.

Returns:

true if this object can be scheduled, false otherwise.

getRootFolderIDs

public int[] getRootFolderIDs()

Returns the root folder IDs.

Returns:

A int[] array that contains the root folder IDs of these InfoObject types.

isSendable

public boolean isSendable()

Returns a boolean that indicates whether the object can be sent.

Returns:

true if the object can be sent, and false otherwise.

isManagedDestination

public boolean isManagedDestination()

Returns a boolean that indicates whether the object is a destination within the BusinessObjects Enterprise Infrastructure.

Returns:

true if the object is a destination within the BusinessObjects Enterprise Infrastructure, and false otherwise.