com.webmethods.portal.service.portlet.info

Interface IPortletInfo

All Superinterfaces:

IComponentData, IView, Serializable

public interface IPortletInfo
extends IComponentData, IView

Portlet descriptor information defined as:

<tag> <!-- the name tag defines the portlet name --> <name>wm_testwizard</name> <!-- the info tag defines a description of the portlet. This value is currently not used anywhere. You should use the caption attribute on the editor tag instead. --> <info>testwizard</info> <!-- the editor tag defines additional metadata about the portlet that is used primarily by the editors and when publishing a new standalone instance of a portlet. The meaning of the various attributes are as follows: status: the initial status of the portlet when it is installed. possible values: "enabled" - the portlet is visible in the portlet pickers and new instances of the portlet can be created "hidden" - the portlet is not visible in the portlet pickers but existing instances will continue to function normally. "disabled" - the portlet is not visible in the portlet pickers and existing instances will display an error message indicating that the portlet has been disabled. category: the default category for the portlet when it is installed. possible values: any category name image: the path (relative to the portlet's root folder) to the icon to use for the portlet possible values: any valid relative image path. caption: a long description of the portlet. possible values: any descriptive text title: a short description of the portlet. A shorter version of the caption. possible values: any descriptive text. --> <editor status="enabled" category="SDK" image="images/obj_widget.gif" caption="testwizard" title="testwizard" /> .... <attribute ... /> .... <groups ... /> .... <controller ... /> .... </tag>

Field Summary

Fields

Modifier and Type	Field and Description
static int	PCA_TYPE_NONE
static int	PCA_TYPE_RESTFUL
static int	PCA_TYPE_SESSION
static int	STATUS_DISABLED Portlet status DISABLED
static int	STATUS_ENABLED Portlet status ENABLED
static int	STATUS_HIDDEN Portlet status HIDDEN

Fields inherited from interface com.webmethods.portal.service.view.IView

PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

Modifier and Type	Method and Description
void	clear() Called during shutdown to cleanup retained objects
String	getAlias() Returns alias for this portlet type
String	getAttrValue(String name) Returns value of the attribute with the given name.
String	getBaseTypeName() Returns base type name for the Portlet/DBO
String	getBeanClassName() Returns the portlet bean class name.
String	getBundleName() Returns portlet bundle name.
String	getCaption() Returns the portlet caption.
String	getCategory() Returns the portlet category name
Set<String>	getContentTypes() Returns supported content types by the portlet.
IPortletControllerInfo	getControllerInfo() Returns portlet controller info
DateFormat	getDateFormatForProperty(IContext context, String propertyName) Utility method that retrieves the date pattern needed to parse or format a portlet property that represents a Date or Calendar.
String	getDestroySP() Deprecated.
String	getHelpPage() Deprecated.
int	getPropertyCount(int propertyType) Returns total number of properties of the given type
IPortletPropertyGroupInfo	getPropertyGroupInfo(String name) Returns property group info object for the given group name
Iterator<IPortletPropertyGroupInfo>	getPropertyGroupInfos() Returns property group infos.
IPortletPropertyInfo	getPropertyInfo(String propertyName) Returns property information for the property with the given name
Iterator<IPortletPropertyInfo>	getPropertyInfos() Returns the portlet property infos as an iterator of IPortletPropertyInfo.
Iterator<IPortletPropertyInfo>	getPropertyInfos(int propertyType) Returns the portlet property infos as an iterator of IPortletPropertyInfo.
Iterator<IPortletPropertyInfo>	getPropertyInfos(IPortletPropertyListFilter filter) The same as getPropertyInfos(int) but allows to specify a custom filter for the properties.
String[]	getRequiredComponents()
Class<? extends ResourceBundle>	getResourceBundleClass() Returns portlet resource bundle
int	getStatus() Returns the portlet run-time status.
String	getThingFactoryClassName() Returns thing factory class name
String	getTitle() Returns the portlet title
String	getTitleBarClassName() Deprecated.
boolean	getTwoPassRenderingSupported() Deprecated.
IThingID	getTypeID() Returns the portlet type thing id.
String	getTypeName() Returns the portlet name.
String	getVersion() Returns the portlet version string.
IThingID	getXTypeID() Returns the portlet xtype id
IPortletXTypeInfo	getXTypeInfo() Returns XType information if portlet is a DBO.
boolean	hasBeanClass() Deprecated.
boolean	isAclFree() Returns true is the portlet is marked as ACL free
boolean	isJSR168()
boolean	isPublishableAsStandalone()
boolean	isPublishableInFBE() Deprecated.
boolean	isPublishableInVE() Deprecated.
boolean	isPublishRequired() Deprecated.
boolean	isResizable() Deprecated.
boolean	isSystemPortlet() Deprecated.
boolean	isTemplateOnlyPortlet() Deprecated.
boolean	isTwoPassModeSwitchDisabled() Deprecated.
void	setAttrValue(String name, String value) Sets a new value of the attribute.
void	setStatus(int status) Sets the portlet new run-time status.

Methods inherited from interface com.webmethods.portal.system.IComponentData

getComponent, getComponentClassName, getConfig, getConfigFile, getConfigStream, getEnabled, getProperties, getURI, setComponent, setComponentClassName, setConfig, setConfigFile, setConfigStream, setEnabled, setProperties

Methods inherited from interface com.webmethods.portal.service.view.IView

getProperties, getProperty, getPropertyNames, getURI

Field Detail

STATUS_ENABLED

static final int STATUS_ENABLED

Portlet status ENABLED

See Also:

Constant Field Values

STATUS_HIDDEN

static final int STATUS_HIDDEN

Portlet status HIDDEN

See Also:

Constant Field Values

STATUS_DISABLED

static final int STATUS_DISABLED

Portlet status DISABLED

See Also:

Constant Field Values

PCA_TYPE_NONE

static final int PCA_TYPE_NONE

See Also:

Constant Field Values

PCA_TYPE_SESSION

static final int PCA_TYPE_SESSION

See Also:

Constant Field Values

PCA_TYPE_RESTFUL

static final int PCA_TYPE_RESTFUL

See Also:

Constant Field Values

Method Detail

getTypeName

String getTypeName()

Returns the portlet name. Cannot be null or empty string.

Returns:

portlet name

getTypeID

IThingID getTypeID()

Returns the portlet type thing id.

Returns:

the portlet type thing id.

getXTypeID

IThingID getXTypeID()

Returns the portlet xtype id

Returns:

the portlet xtype id

getCaption

String getCaption()

Returns the portlet caption.

Returns:

the portlet caption.

getTitle

String getTitle()

Returns the portlet title

Returns:

the portlet title.

getCategory

String getCategory()

Returns the portlet category name

Returns:

the category name

getVersion

String getVersion()

Returns the portlet version string.

Returns:

the portlet version

getBeanClassName

String getBeanClassName()

Returns the portlet bean class name. The class must implement IPortletBean interface.

Returns:

portlet bean class name

hasBeanClass

@Deprecated
boolean hasBeanClass()

Deprecated.

getTitleBarClassName

@Deprecated
String getTitleBarClassName()

Deprecated.

getTwoPassRenderingSupported

@Deprecated
boolean getTwoPassRenderingSupported()

Deprecated.

isTwoPassModeSwitchDisabled

@Deprecated
boolean isTwoPassModeSwitchDisabled()

Deprecated.

getHelpPage

@Deprecated
String getHelpPage()

Deprecated.

isTemplateOnlyPortlet

@Deprecated
boolean isTemplateOnlyPortlet()

Deprecated.

isSystemPortlet

@Deprecated
boolean isSystemPortlet()

Deprecated.

isPublishableInVE

@Deprecated
boolean isPublishableInVE()

Deprecated.

isPublishableInFBE

@Deprecated
boolean isPublishableInFBE()

Deprecated.

isPublishableAsStandalone

boolean isPublishableAsStandalone()

isPublishRequired

@Deprecated
boolean isPublishRequired()

Deprecated.

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos()

Returns the portlet property infos as an iterator of IPortletPropertyInfo.

Returns:

iterator of IPortletPropertyInfo for all portlet properties

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos(int propertyType)

Returns the portlet property infos as an iterator of IPortletPropertyInfo. A mask can be specified with to filter properties by type.

Parameters:

propertyType - the mask with the propety types that you'd like to get back

Returns:

iterator of IPortletPropertyInfo for all portlet properties

getPropertyCount

int getPropertyCount(int propertyType)

Returns total number of properties of the given type

Parameters:

propertyType - the type of the properties

Returns:

count of the portlet properties of the given type

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos(IPortletPropertyListFilter filter)

The same as getPropertyInfos(int) but allows to specify a custom filter for the properties.

Parameters:

filter - the filter implementation

See Also:

getPropertyInfos(int)

getPropertyGroupInfos

Iterator<IPortletPropertyGroupInfo> getPropertyGroupInfos()

Returns property group infos.

See Also:

IPortletPropertyGroupInfo

getPropertyGroupInfo

IPortletPropertyGroupInfo getPropertyGroupInfo(String name)

Returns property group info object for the given group name

Parameters:

name - group name

getPropertyInfo

IPortletPropertyInfo getPropertyInfo(String propertyName)

Returns property information for the property with the given name

Parameters:

propertyName - the name of the property

Returns:

IPortletPropertyInfo about this property

getAttrValue

String getAttrValue(String name)

Returns value of the attribute with the given name. The value of the attribute is set in the portlet TLDX file.

Parameters:

name - the name of the attribute.

Returns:

value of the attribute

setAttrValue

void setAttrValue(String name,
                  String value)

Sets a new value of the attribute.

Parameters:

name - the name of the attribute to set the value

value - the new value

getStatus

int getStatus()

Returns the portlet run-time status.

Returns:

portlet status

See Also:

STATUS_ENABLED, STATUS_HIDDEN, STATUS_DISABLED

setStatus

void setStatus(int status)

Sets the portlet new run-time status.

Parameters:

status - new portlet status

See Also:

getStatus()

getContentTypes

Set<String> getContentTypes()

Returns supported content types by the portlet.

Returns:

Set with content type supported.

getBundleName

String getBundleName()

Returns portlet bundle name. This name is used to load all classes from the bundle via one instance of the class loader.

Returns:

portlet bundle name.

getControllerInfo

IPortletControllerInfo getControllerInfo()

Returns portlet controller info

Returns:

portlet controller info for this portlet, or null of not available

getBaseTypeName

String getBaseTypeName()

Returns base type name for the Portlet/DBO

Returns:

name of the base type

getThingFactoryClassName

String getThingFactoryClassName()

Returns thing factory class name

Returns:

class name of thing factory for this Portlet/DBO

getDestroySP

@Deprecated
String getDestroySP()

Deprecated.

getAlias

String getAlias()

Returns alias for this portlet type

Returns:

alias for this portlet type

isAclFree

boolean isAclFree()

Returns true is the portlet is marked as ACL free

Returns:

true if the portlet is marked as ACL free

isResizable

@Deprecated
boolean isResizable()

Deprecated.

getResourceBundleClass

Class<? extends ResourceBundle> getResourceBundleClass()

Returns portlet resource bundle

Returns:

getRequiredComponents

String[] getRequiredComponents()

isJSR168

boolean isJSR168()

getDateFormatForProperty

DateFormat getDateFormatForProperty(IContext context,
                                    String propertyName)
                             throws PortalException

Utility method that retrieves the date pattern needed to parse or format a portlet property that represents a Date or Calendar.

Parameters:

context - the current portal user context

propertyName - the property to retrieve the pattern for

Returns:

date format object needed to format or parse the requested portlet property see SimpleDateFormat

Throws:

PortalException

getXTypeInfo

IPortletXTypeInfo getXTypeInfo()

Returns XType information if portlet is a DBO. May return null if no xtype information exist

clear

void clear()

Called during shutdown to cleanup retained objects