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

boolean	canSubscribeDirectly() Returns a boolean indicating if this type of object can be subscribed to directly for alerts.
java.lang.String	getCategory() Returns the category to which the plugin belongs.
java.lang.String	getCUID() Returns a String that is the CUID of this plugin info object.
java.lang.String	getDefaultPSSServiceCUID() Returns the CUID of the default service used to process plugins of this type.
java.lang.String	getDescription() Returns the description of the plugin.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of the plugin.
IPluginFactory	getFactory() Returns the factory object for this plugin.
java.util.List	getFileExtensions() Returns a List that suggest potential file extensions of this type.
java.lang.String	getKind() Returns the InfoObject type.
java.lang.String	getName() Returns the friendly name of the plugin.
java.lang.String	getName(java.util.Locale locale) Returns the localized friendly name of the plugin.
java.lang.String	getObjectTypeName() Returns the processing DLL name.
java.io.InputStream	getPicture() Returns the default icon for this plugin.
java.io.InputStream	getPicture(java.lang.String pictureName) Returns an icon for this plugin.
java.lang.String	getProgID() Returns the plugin's ProgID.
java.lang.String	getPropertyIndex() Returns the plugin property index list.
int	getRootFolderID() Deprecated. use IPluginInfo.getRootFolderIDs() instead
int[]	getRootFolderIDs() Returns the root folder IDs.
IPluginSecurityInfo	getSecurityInfo() Deprecated. Since 12.0, security model has been changed, please see custom roles
java.lang.String	getStringDescription(java.lang.String descID, java.util.Locale locale) Returns the localized description for an string resource id.
short	getType() Returns the plugin's type.
java.lang.String	getTypeCollection(java.util.Locale locale) Returns a localized string corresponding to the return value of getTypeCollectionID
int	getTypeCollectionID() Returns a CePluginCollection representing the type collection the plugin belongs to.
java.lang.String	getVersion() Returns the version number of the plugin.
boolean	hasPlugin() Returns a boolean that indicates whether the type has plugin for the current platform this method is called.
boolean	hasTypeSpecificRights() Returns a boolean that indicates whether the object has type specific rights.
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	isSchedulableInPublications() Returns a boolean that indicates whether this object can be scheduled in publications.
boolean	isSendable() Returns a boolean that indicates whether the object can be sent to a destination.
boolean	isSupportCategoryContent() Returns a boolean that indicates whether the object supports category content.
boolean	isSupportRecentDocs()
boolean	isTranslatable() Returns a boolean that indicates whether this type of plugin is translatable
boolean	isWebAppContent() Returns a boolean that indicates whether the object is supported by web applications.

Method Detail

getCategory

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

java.lang.String getName()

Returns the friendly name of the plugin.

Returns:

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

getName

java.lang.String getName(java.util.Locale locale)

Returns the localized friendly name of the plugin.

Returns:

A String containing the localized friendly name of the plugin.

getDescription

java.lang.String getDescription()

Returns the description of the plugin.

Returns:

A String containing the description of the plugin.

getDescription

java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of the plugin.

Returns:

A String containing the localized description of the plugin.

getObjectTypeName

java.lang.String getObjectTypeName()

Returns the processing DLL name.

Returns:

A String containing the processing DLL name.

getFactory

IPluginFactory getFactory()

Returns the factory object for this plugin.

Returns:

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

getProgID

java.lang.String getProgID()

Returns the plugin's ProgID.

Returns:

A String containing the plugin's ProgID.

getPropertyIndex

java.lang.String getPropertyIndex()

Returns the plugin property index list.

Returns:

A String containing the plugin property index list.

getType

short getType()

Returns the plugin's type.

Returns:

The plugin's type as a short.

getKind

java.lang.String getKind()

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

Returns:

A String that indicates the InfoObject type.

getVersion

java.lang.String getVersion()

Returns the version number of the plugin.

Returns:

A String containing the plugin's version number.

getSecurityInfo

IPluginSecurityInfo getSecurityInfo()

Deprecated. Since 12.0, security model has been changed, please see custom roles

Returns the custom rights info for this plugin.

Returns:

A IPluginSecurityInfo object specifying the rights for this plugin.

getRootFolderID

int getRootFolderID()

Deprecated. use IPluginInfo.getRootFolderIDs() instead

Returns the root folder ID.

Returns:

A int indicating the root folder ID of this plugin.

isSchedulable

boolean isSchedulable()

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

Returns:

true if this object can be scheduled, false otherwise.

isSchedulableInPublications

boolean isSchedulableInPublications()

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

Returns:

true if this object can be scheduled, false otherwise.

getDefaultPSSServiceCUID

java.lang.String getDefaultPSSServiceCUID()

Returns the CUID of the default service used to process plugins of this type.

Returns:

The CUID of the default service used to process plugins of this type. 0 if no default service exists for InfoObjects of this type.

getRootFolderIDs

int[] getRootFolderIDs()

Returns the root folder IDs.

Returns:

An int array that contains the root folder IDs of these InfoObject types.

isSendable

boolean isSendable()

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

Returns:

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

isManagedDestination

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.

getPicture

java.io.InputStream getPicture(java.lang.String pictureName)

Returns an icon for this plugin.

Parameters:

pictureName - the icon type, which is one of SI_PLUGIN_ICON_1, SI_PLUGIN_ICON_2, or null.

Returns:

the icon for this plugin

getPicture

java.io.InputStream getPicture()

Returns the default icon for this plugin.

Returns:

the default icon for this plugin.

isSupportCategoryContent

boolean isSupportCategoryContent()

Returns a boolean that indicates whether the object supports category content.

Returns:

true if the object supports category content, false otherwise.

isWebAppContent

boolean isWebAppContent()

Returns a boolean that indicates whether the object is supported by web applications.

Returns:

true if the object is supported by web applications, false otherwise.

isSupportRecentDocs

boolean isSupportRecentDocs()

hasTypeSpecificRights

boolean hasTypeSpecificRights()

Returns a boolean that indicates whether the object has type specific rights.

Returns:

true if the object has type specific rights, false otherwise.

getTypeCollectionID

int getTypeCollectionID()

Returns a CePluginCollection representing the type collection the plugin belongs to. It's one of application object, system object, or content object

Returns:

a CePluginCollection representing the type collection the plugin belongs to. It's one of application object, system object, or content object

getTypeCollection

java.lang.String getTypeCollection(java.util.Locale locale)

Returns a localized string corresponding to the return value of getTypeCollectionID

Parameters:

locale -

Returns:

a localized string corresponding to the return value of getTypeCollectionID

hasPlugin

boolean hasPlugin()

Returns a boolean that indicates whether the type has plugin for the current platform this method is called. Note true meant there's a plugin of this platform for this type, it does not indicate whether the plugin is installed or not.

Returns:

true if you are running java and the type has java plugin, false otherwise.

getStringDescription

java.lang.String getStringDescription(java.lang.String descID,
                                      java.util.Locale locale)

Returns the localized description for an string resource id.

Returns:

A String containing the localized description of a string resource id. null will be returned if couldn't find one

isTranslatable

boolean isTranslatable()

Returns a boolean that indicates whether this type of plugin is translatable

Returns:

true if this type of plugin is translatable.

getFileExtensions

java.util.List getFileExtensions()

Returns a List that suggest potential file extensions of this type.

Returns:

List that suggest potential file extensions of this type.

canSubscribeDirectly

boolean canSubscribeDirectly()

Returns a boolean indicating if this type of object can be subscribed to directly for alerts. Some event types can be subscribed to directly and will return true. 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 return true but the dependent event type will not.

getCUID

java.lang.String getCUID()

Returns a String that is the CUID of this plugin info object.

Returns:

String that is the CUID of this plugin info object.