org.apache.jetspeed.om.common.portlet
Interface PortletDefinitionComposite

All Superinterfaces:
org.apache.pluto.om.Controller, org.apache.pluto.om.Model, org.apache.pluto.om.portlet.PortletDefinition, org.apache.pluto.om.portlet.PortletDefinitionCtrl, Serializable

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

PortletDefinitionComposite

Version:
$Id: PortletDefinitionComposite.java 187749 2004-10-15 18:44:18Z jford $
Author:
Scott T. Weaver

Field Summary
static String PORTLETS_PREFS_ROOT
           
 
Method Summary
 void addContentType(org.apache.pluto.om.portlet.ContentType cType)
           
 void addContentType(String contentType, Collection modes)
           
 void addDescription(Locale locale, String description)
           
 void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)
           addDisplayName
 void addDisplayName(Locale locale, String displayName)
           
 ParameterComposite addInitParameter(String name, String value)
          Convenience method for directly adding init parameters to this PortletDefinition..
 ParameterComposite addInitParameter(String name, String value, org.apache.pluto.om.common.DescriptionSet description)
          Same as setInitParameter(name, title) plus allows a description to inlcuded.
 ParameterComposite addInitParameter(String name, String value, String description, 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(String title, String shortTitle, String keywords, Locale locale)
           
 void addPreference(org.apache.pluto.om.common.Preference preference)
           
 PreferenceComposite addPreference(String name, String[] values)
           
 void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)
           addSecurityRoleRef
 org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(String roleName, String roleLink)
           
 org.apache.pluto.om.common.DescriptionSet getDescriptionSet()
           
 String getDescriptionText(Locale locale)
          Returns localized text of this PortletDefinitions description.
 org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()
           
 String getDisplayNameText(Locale locale)
          Returns localized text of this PortletDefinitions display name.
 GenericMetadata getMetadata()
           
 String getPortletIdentifier()
           
 String getPreferenceValidatorClassname()
           
 String getResourceBundle()
           
 Collection getSupportedLocales()
           
 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(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 setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)
           
 void setMetadata(GenericMetadata metadata)
           
 void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)
           
 void setPortletIdentifier(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(String classname)
           
 
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
 

Field Detail

PORTLETS_PREFS_ROOT

public static final String PORTLETS_PREFS_ROOT
See Also:
Constant Field Values
Method Detail

getMetadata

public GenericMetadata getMetadata()

setMetadata

public void setMetadata(GenericMetadata metadata)

addLanguage

public void addLanguage(org.apache.pluto.om.common.Language lang)

addLanguage

public void addLanguage(String title,
                        String shortTitle,
                        String keywords,
                        Locale locale)

addContentType

public void addContentType(org.apache.pluto.om.portlet.ContentType cType)

addContentType

public void addContentType(String contentType,
                           Collection modes)

setLanguageSet

public void setLanguageSet(org.apache.pluto.om.common.LanguageSet languages)

getResourceBundle

public String getResourceBundle()

getSupportedLocales

public Collection getSupportedLocales()

setPreferenceSet

public 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.

Parameters:
preferences -

setInitParameterSet

public void setInitParameterSet(org.apache.pluto.om.common.ParameterSet parameters)

setContentTypeSet

public void setContentTypeSet(org.apache.pluto.om.portlet.ContentTypeSet contentTypes)

setInitSecurityRoleRefSet

public void setInitSecurityRoleRefSet(org.apache.pluto.om.common.SecurityRoleRefSet securityRefs)

addInitParameter

public ParameterComposite addInitParameter(String name,
                                           String value)
Convenience method for directly adding init parameters to this PortletDefinition.. This has the same affect as ((ParameterSetCtrl)PortletDefinition.getInitParamaterSet()).add()

Parameters:
name - Name of parameter to set
value - new value of said parameter
Returns:
ParameterComposite newly created parameter

addInitParameter

public ParameterComposite addInitParameter(String name,
                                           String value,
                                           org.apache.pluto.om.common.DescriptionSet description)
Same as setInitParameter(name, title) plus allows a description to inlcuded.

Parameters:
name - Name of parameter to set
value - new value of the parameter
Returns:
ParameterComposite newly created parameter
See Also:
org.apache.jetspeed.om.common.portlet.PortletApplicationComposite#addInitParameter(java.lang.String, java.lang.String)

addInitParameter

public ParameterComposite addInitParameter(String name,
                                           String value,
                                           String description,
                                           Locale locale)
Same as setInitParameter(name, title) plus allows you to define one initial localized desription.

Parameters:
name - Name of parameter to set
value - new value of the parameter
description - A description for this parameter
locale - 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)

setExpirationCache

public void setExpirationCache(String cache)
Setter for setting expiration cache time for this portlet


setPortletApplicationDefinition

public void setPortletApplicationDefinition(org.apache.pluto.om.portlet.PortletApplicationDefinition pad)

addPreference

public PreferenceComposite addPreference(String name,
                                         String[] values)

addPreference

public void addPreference(org.apache.pluto.om.common.Preference preference)

setPortletIdentifier

public void setPortletIdentifier(String portletIndentifier)

getPortletIdentifier

public String getPortletIdentifier()

getUniqueName

public 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

public 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

public 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

addDescription

public void addDescription(Locale locale,
                           String description)

getDescriptionSet

public org.apache.pluto.om.common.DescriptionSet getDescriptionSet()

addDisplayName

public void addDisplayName(Locale locale,
                           String displayName)

addDisplayName

public void addDisplayName(org.apache.pluto.om.common.DisplayName displayName)

addDisplayName

Parameters:
displayName -

getDisplayNameSet

public org.apache.pluto.om.common.DisplayNameSet getDisplayNameSet()

getPreferenceValidatorClassname

public String getPreferenceValidatorClassname()

setPreferenceValidatorClassname

public void setPreferenceValidatorClassname(String classname)

addSecurityRoleRef

public void addSecurityRoleRef(org.apache.pluto.om.common.SecurityRoleRef securityRef)

addSecurityRoleRef

Adds the securityRef to the existing set of SecurityRoleRefs of this PortletDefinition

Parameters:
securityRef - SecurityRoleRef to add.

addSecurityRoleRef

public org.apache.pluto.om.common.SecurityRoleRef addSecurityRoleRef(String roleName,
                                                                     String roleLink)


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.