|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletDefinitionComposite
PortletDefinitionComposite
Method Summary | |
---|---|
void |
addContentType(org.apache.pluto.om.portlet.ContentType cType)
|
void |
addContentType(java.lang.String contentType,
java.util.Collection modes)
|
void |
addDescription(java.util.Locale locale,
java.lang.String description)
|
void |
addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
addDisplayName |
void |
addDisplayName(java.util.Locale locale,
java.lang.String displayName)
|
ParameterComposite |
addInitParameter(java.lang.String name,
java.lang.String value)
Convenience method for directly adding init parameters to this PortletDefinition. . |
ParameterComposite |
addInitParameter(java.lang.String name,
java.lang.String value,
org.apache.pluto.om.common.DescriptionSet description)
Same as setInitParameter(name, title) plus allows a
description to inlcuded. |
ParameterComposite |
addInitParameter(java.lang.String name,
java.lang.String value,
java.lang.String description,
java.util.Locale locale)
Same as setInitParameter(name, title) plus allows you
to define one initial localized desription. |
void |
addLanguage(org.apache.pluto.om.common.Language lang)
|
void |
addLanguage(java.lang.String title,
java.lang.String shortTitle,
java.lang.String keywords,
java.util.Locale locale)
|
void |
addPreference(org.apache.pluto.om.common.Preference preference)
|
PreferenceComposite |
addPreference(java.lang.String name,
java.lang.String[] values)
|
void |
addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
addSecurityRoleRef |
org.apache.pluto.om.common.SecurityRoleRef |
addSecurityRoleRef(java.lang.String roleName,
java.lang.String roleLink)
|
org.apache.pluto.om.common.DescriptionSet |
getDescriptionSet()
|
java.lang.String |
getDescriptionText(java.util.Locale locale)
Returns localized text of this PortletDefinitions description. |
org.apache.pluto.om.common.DisplayNameSet |
getDisplayNameSet()
|
java.lang.String |
getDisplayNameText(java.util.Locale locale)
Returns localized text of this PortletDefinitions display name. |
java.lang.String |
getJetspeedSecurityConstraint()
Get the Jetspeed Security Constraint reference for this portlet. |
GenericMetadata |
getMetadata()
|
java.lang.String |
getPortletIdentifier()
|
java.lang.String |
getPreferenceValidatorClassname()
|
java.lang.String |
getResourceBundle()
|
java.util.Collection |
getSupportedLocales()
|
java.lang.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. |
void |
setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
|
void |
setExpirationCache(java.lang.String cache)
Setter for setting expiration cache time for this portlet |
void |
setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
|
void |
setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
|
void |
setJetspeedSecurityConstraint(java.lang.String constraint)
Set the Jetspeed Security Constraint reference for this portlet. |
void |
setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
|
void |
setMetadata(GenericMetadata metadata)
|
void |
setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
|
void |
setPortletIdentifier(java.lang.String portletIndentifier)
|
void |
setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
The PreferenceSet is a collection user-defineable preferences that this portlet can use to process its logic. |
void |
setPreferenceValidatorClassname(java.lang.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.om.portlet.PortletDefinition |
---|
getClassName, getContentTypeSet, getDescription, getDisplayName, getExpirationCache, getId, getInitParameterSet, getInitSecurityRoleRefSet, getLanguageSet, getName, getPortletApplicationDefinition, getPortletClassLoader, getPreferenceSet, getServletDefinition |
Methods inherited from interface org.apache.pluto.om.portlet.PortletDefinitionCtrl |
---|
setClassName, setDescriptions, setDisplayNames, setId, setName, setPortletClassLoader, store |
Method Detail |
---|
GenericMetadata getMetadata()
void setMetadata(GenericMetadata metadata)
void addLanguage(org.apache.pluto.om.common.Language lang)
void addLanguage(java.lang.String title, java.lang.String shortTitle, java.lang.String keywords, java.util.Locale locale)
void addContentType(org.apache.pluto.om.portlet.ContentType cType)
void addContentType(java.lang.String contentType, java.util.Collection modes)
void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
java.lang.String getResourceBundle()
java.util.Collection getSupportedLocales()
void setPreferenceSet(org.apache.pluto.om.common.PreferenceSet preferences)
preferences
- void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)
void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)
void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)
ParameterComposite addInitParameter(java.lang.String name, java.lang.String value)
PortletDefinition.
. This has the
same affect as
((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()
name
- Name of parameter to setvalue
- new value of said parameter
ParameterComposite addInitParameter(java.lang.String name, java.lang.String value, org.apache.pluto.om.common.DescriptionSet description)
setInitParameter(name, title) plus allows a
description to inlcuded.
- Parameters:
name
- Name of parameter to setvalue
- new value of the parameterDescriptionSet
- containing locale-specific descriptions of the parameter
- Returns:
- ParameterComposite newly created parameter
- See Also:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)
ParameterComposite addInitParameter(java.lang.String name, java.lang.String value, java.lang.String description, java.util.Locale locale)
setInitParameter(name, title) plus allows you
to define one initial localized desription.
- Parameters:
name
- Name of parameter to setvalue
- new value of the parameterdescription
- A description for this parameterlocale
- The locale the description
- Returns:
- ParameterComposite newly created parameter
- See Also:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)
void setExpirationCache(java.lang.String cache)
void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
PreferenceComposite addPreference(java.lang.String name, java.lang.String[] values)
void addPreference(org.apache.pluto.om.common.Preference preference)
void setPortletIdentifier(java.lang.String portletIndentifier)
java.lang.String getPortletIdentifier()
java.lang.String getUniqueName()
null
or this portlet has not
yet been assigned to an portlet application, null
is returned.java.lang.String getDisplayNameText(java.util.Locale locale)
locale
- Locale to get the display name for
null
if no DisplayName exists for this localejava.lang.String getDescriptionText(java.util.Locale locale)
locale
- Locale to get the description for
null
if no Description exists for this localevoid addDescription(java.util.Locale locale, java.lang.String description)
org.apache.pluto.om.common.DescriptionSet getDescriptionSet()
void addDisplayName(java.util.Locale locale, java.lang.String displayName)
void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
addDisplayName
displayName
- org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()
java.lang.String getPreferenceValidatorClassname()
void setPreferenceValidatorClassname(java.lang.String classname)
void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
addSecurityRoleRef
Adds thesecurityRef
to the existing
set of SecurityRoleRefs of this PortletDefinition
securityRef
- SecurityRoleRef to add.org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(java.lang.String roleName, java.lang.String roleLink)
java.lang.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.
void setJetspeedSecurityConstraint(java.lang.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.
constraint
- The name of the Security Definition defined in
the Jetspeed Security Constraintsvoid 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |