PortletDefinition (Jetspeed-2 Core API 2.3.1 API)

All Superinterfaces:

org.apache.pluto.container.om.portlet.PortletDefinition, Serializable
```
public interface PortletDefinition
extends org.apache.pluto.container.om.portlet.PortletDefinition, Serializable
```
PortletDefinitionComposite

Version:

$Id: PortletDefinition.java 1074422 2011-02-25 07:45:03Z taylor $

Author:

Scott T. Weaver

Field Summary

Fields
Modifier and Type Field and Description

static String CLONE_PARENT_INIT_PARAM

Fields
Modifier and Type	Field and Description
`static String`	`CLONE_PARENT_INIT_PARAM`

Method Summary

Methods
Modifier and Type	Method and Description
`ContainerRuntimeOption`	`addContainerRuntimeOption(String name)`
`Description`	`addDescription(String lang)`
`Preference`	`addDescriptorPreference(String name)`
`DisplayName`	`addDisplayName(String lang)`
`InitParam`	`addInitParam(String paramName)`
`Language`	`addLanguage(Locale locale)`
`SecurityRoleRef`	`addSecurityRoleRef(String roleName)`
`EventDefinitionReference`	`addSupportedProcessingEvent(QName qname)`
`EventDefinitionReference`	`addSupportedProcessingEvent(String name)`
`EventDefinitionReference`	`addSupportedPublishingEvent(QName qname)`
`EventDefinitionReference`	`addSupportedPublishingEvent(String name)`
`Supports`	`addSupports(String mimeType)`
`PortletApplication`	`getApplication()`
`String`	`getCloneParent()` returns the parent portlet definition name from which this portlet clone was cloned from.
`ContainerRuntimeOption`	`getContainerRuntimeOption(String name)`
`List<ContainerRuntimeOption>`	`getContainerRuntimeOptions()`
`Description`	`getDescription(Locale locale)`
`List<Description>`	`getDescriptions()`
`String`	`getDescriptionText(Locale locale)` Returns localized text of this PortletDefinitions description.
`Preferences`	`getDescriptorPreferences()`
`DisplayName`	`getDisplayName(Locale locale)`
`List<DisplayName>`	`getDisplayNames()`
`String`	`getDisplayNameText(Locale locale)` Returns localized text of this PortletDefinitions display name.
`InitParam`	`getInitParam(String paramName)`
`List<InitParam>`	`getInitParams()`
`String`	`getJetspeedSecurityConstraint()` Get the Jetspeed Security Constraint reference for this portlet.
`Language`	`getLanguage(Locale locale)`
`List<Language>`	`getLanguages()`
`GenericMetadata`	`getMetadata()`
`PortletInfo`	`getPortletInfo()`
`Preferences`	`getPortletPreferences()`
`String`	`getPreferenceValidatorClassname()`
`SecurityRoleRef`	`getSecurityRoleRef(String roleName)`
`List<SecurityRoleRef>`	`getSecurityRoleRefs()`
`List<EventDefinitionReference>`	`getSupportedProcessingEvents()`
`List<EventDefinitionReference>`	`getSupportedPublishingEvents()`
`List<Supports>`	`getSupports()`
`Supports`	`getSupports(String mimeType)`
`String`	`getUniqueName()` A portlet's unique name is a string formed by the combination of a portlet's unique within it's parent application plus the parent application's unique name within the portlet container using ":" as a delimiter.
`boolean`	`isClone()` Determine if this portlet defintion is a clon
`boolean`	`isSameIdentity(PortletDefinition other)` Check if this instance its persistent identity has changed
`void`	`setJetspeedSecurityConstraint(String constraint)` Set the Jetspeed Security Constraint reference for this portlet.
`void`	`setPreferenceValidatorClassname(String classname)`
`void`	`storeChildren()` Persistence callback to allow a PortletDefinition instance to persist children objects (like portlet preferences) within the same transaction.

Methods inherited from interface org.apache.pluto.container.om.portlet.PortletDefinition
addSupportedLocale, addSupportedPublicRenderParameter, getCacheScope, getExpirationCache, getPortletClass, getPortletName, getResourceBundle, getSupportedLocales, getSupportedPublicRenderParameters, setCacheScope, setExpirationCache, setPortletClass, setResourceBundle

- Field Detail
  - CLONE_PARENT_INIT_PARAM
```
static final String CLONE_PARENT_INIT_PARAM
```
    See Also:
    Constant Field Values
- Method Detail
  - getApplication
```
PortletApplication getApplication()
```
    Specified by:
    
    getApplication in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getInitParam
```
InitParam getInitParam(String paramName)
```
    Specified by:
    
    getInitParam in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getInitParams
```
List<InitParam> getInitParams()
```
    Specified by:
    
    getInitParams in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addInitParam
```
InitParam addInitParam(String paramName)
```
    Specified by:
    
    addInitParam in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getPortletInfo
```
PortletInfo getPortletInfo()
```
    Specified by:
    
    getPortletInfo in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getPortletPreferences
```
Preferences getPortletPreferences()
```
    Specified by:
    
    getPortletPreferences in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getDescriptorPreferences
```
Preferences getDescriptorPreferences()
```
  - addDescriptorPreference
```
Preference addDescriptorPreference(String name)
```
  - getSupportedProcessingEvents
```
List<EventDefinitionReference> getSupportedProcessingEvents()
```
    Specified by:
    
    getSupportedProcessingEvents in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSupportedProcessingEvent
```
EventDefinitionReference addSupportedProcessingEvent(QName qname)
```
    Specified by:
    
    addSupportedProcessingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSupportedProcessingEvent
```
EventDefinitionReference addSupportedProcessingEvent(String name)
```
    Specified by:
    
    addSupportedProcessingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getSupportedPublishingEvents
```
List<EventDefinitionReference> getSupportedPublishingEvents()
```
    Specified by:
    
    getSupportedPublishingEvents in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSupportedPublishingEvent
```
EventDefinitionReference addSupportedPublishingEvent(QName qname)
```
    Specified by:
    
    addSupportedPublishingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSupportedPublishingEvent
```
EventDefinitionReference addSupportedPublishingEvent(String name)
```
    Specified by:
    
    addSupportedPublishingEvent in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getSecurityRoleRef
```
SecurityRoleRef getSecurityRoleRef(String roleName)
```
    Specified by:
    
    getSecurityRoleRef in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getSecurityRoleRefs
```
List<SecurityRoleRef> getSecurityRoleRefs()
```
    Specified by:
    
    getSecurityRoleRefs in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSecurityRoleRef
```
SecurityRoleRef addSecurityRoleRef(String roleName)
```
    Specified by:
    
    addSecurityRoleRef in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getSupports
```
Supports getSupports(String mimeType)
```
    Specified by:
    
    getSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getSupports
```
List<Supports> getSupports()
```
    Specified by:
    
    getSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addSupports
```
Supports addSupports(String mimeType)
```
    Specified by:
    
    addSupports in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getDescription
```
Description getDescription(Locale locale)
```
    Specified by:
    
    getDescription in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getDescriptions
```
List<Description> getDescriptions()
```
    Specified by:
    
    getDescriptions in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addDescription
```
Description addDescription(String lang)
```
    Specified by:
    
    addDescription in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getDisplayName
```
DisplayName getDisplayName(Locale locale)
```
    Specified by:
    
    getDisplayName in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getDisplayNames
```
List<DisplayName> getDisplayNames()
```
    Specified by:
    
    getDisplayNames in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addDisplayName
```
DisplayName addDisplayName(String lang)
```
    Specified by:
    
    addDisplayName in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getMetadata
```
GenericMetadata getMetadata()
```
  - getContainerRuntimeOption
```
ContainerRuntimeOption getContainerRuntimeOption(String name)
```
    Specified by:
    
    getContainerRuntimeOption in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getContainerRuntimeOptions
```
List<ContainerRuntimeOption> getContainerRuntimeOptions()
```
    Specified by:
    
    getContainerRuntimeOptions in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - addContainerRuntimeOption
```
ContainerRuntimeOption addContainerRuntimeOption(String name)
```
    Specified by:
    
    addContainerRuntimeOption in interface org.apache.pluto.container.om.portlet.PortletDefinition
  - getLanguage
```
Language getLanguage(Locale locale)
```
  - getLanguages
```
List<Language> getLanguages()
```
  - addLanguage
```
Language addLanguage(Locale locale)
```
  - getUniqueName
```
String getUniqueName()
```
    A portlet's unique name is a string formed by the combination of a portlet's unique within it's parent application plus the parent application's unique name within the portlet container using ":" as a delimiter.
    FORMAT: application name:portlet name
    EXAMPLE: com.myapp.portletApp1:weather-portlet
    
    Returns:
    Name that uniquely indetifies this portlet within the container. If either the name of the portlet is null or this portlet has not yet been assigned to an portlet application, null is returned.
  - getDisplayNameText
```
String getDisplayNameText(Locale locale)
```
    Returns localized text of this PortletDefinitions display name.
    
    Parameters:
    locale - Locale to get the display name for
    
    Returns:
    Localized text string of the display name or null if no DisplayName exists for this locale
  - getDescriptionText
```
String getDescriptionText(Locale locale)
```
    Returns localized text of this PortletDefinitions description.
    
    Parameters:
    locale - Locale to get the description for
    
    Returns:
    Localized text string of the display name or null if no Description exists for this locale
  - getPreferenceValidatorClassname
```
String getPreferenceValidatorClassname()
```
  - setPreferenceValidatorClassname
```
void setPreferenceValidatorClassname(String classname)
```
  - getJetspeedSecurityConstraint
```
String getJetspeedSecurityConstraint()
```
    Get the Jetspeed Security Constraint reference for this portlet. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If a Jetspeed Security Constraint is not defined for a portlet, the constraint applied will then fallback to the constraint defined for the portlet application. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.
    
    Returns:
    The name of the Security Definition applied to this portlet, defined in the Jetspeed Security Constraints
  - setJetspeedSecurityConstraint
```
void setJetspeedSecurityConstraint(String constraint)
```
    Set the Jetspeed Security Constraint reference for this portlet. This security constraint name references a Jetspeed-specific Security Constraint. Security Constraints are not Java Security Permissions, but a Jetspeed specific way of securing portlets, also known as PSML constraints. See the page.security file for examples of defining security constraint definitions. If the portlet application does not define a constraint, then no security constraints will be applied to this portlet. Security constraints for a portlet are normally checking during the render process of a portlet.
    
    Parameters:
    constraint - The name of the Security Definition defined in the Jetspeed Security Constraints
  - storeChildren
```
void storeChildren()
```
    Persistence callback to allow a PortletDefinition instance to persist children objects (like portlet preferences) within the same transaction.
    
    This method must be called always from the #store() method. Using a callback from the persistence manager might not be reliable when the PortletDefinition itself isn't changed but children might.
    
    Notably condition when this might happen is the Pluto 1.0.1 preferences handling calling the portletDefinition store() method
  - isSameIdentity
```
boolean isSameIdentity(PortletDefinition other)
```
    Check if this instance its persistent identity has changed
    
    Parameters:
    other -
    
    Returns:
    true only if the internal identities are the same
  - isClone
```
boolean isClone()
```
    Determine if this portlet defintion is a clon
  - getCloneParent
```
String getCloneParent()
```
    returns the parent portlet definition name from which this portlet clone was cloned from. If not defined, returns null
    
    Returns:
    the parent application name or null if not a clone

Interface PortletDefinition

Field Summary

Method Summary

Methods inherited from interface org.apache.pluto.container.om.portlet.PortletDefinition

Field Detail

CLONE_PARENT_INIT_PARAM

Method Detail

getApplication

getInitParam

getInitParams

addInitParam

getPortletInfo

getPortletPreferences

getDescriptorPreferences

addDescriptorPreference

getSupportedProcessingEvents

addSupportedProcessingEvent

addSupportedProcessingEvent

getSupportedPublishingEvents

addSupportedPublishingEvent

addSupportedPublishingEvent

getSecurityRoleRef

getSecurityRoleRefs

addSecurityRoleRef

getSupports

getSupports

addSupports

getDescription

getDescriptions

addDescription

getDisplayName

getDisplayNames

addDisplayName

getMetadata

getContainerRuntimeOption

getContainerRuntimeOptions

addContainerRuntimeOption

getLanguage

getLanguages

addLanguage

getUniqueName

getDisplayNameText

getDescriptionText

getPreferenceValidatorClassname

setPreferenceValidatorClassname

getJetspeedSecurityConstraint

setJetspeedSecurityConstraint

storeChildren

isSameIdentity

isClone

getCloneParent