|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletDefinition
Interface that represents administrator settings for a portlet. A portlet
definition provides localized titles and descriptions and an administrative
level of preferences for portlets. The administrative preferences are used as
a fallback for preferences that are not set or overridden by user preferences
in a PortletEntity
. In CONFIG mode, portlets read and write directly
to and from the administrative preferences.
As a result of cloning the portlet, multiple portlet definitions may exist for the same portlet; each of these definitions parametrizes the deployed portlet with different titles and administrative preferences.
Note for IBM Portlets: the
PortletPreferencesProvider.getPortletPreferencesLayer()
method returns
the portlet settings for IBM portlets.
Method Summary | |
---|---|
CommunicationEndpointProvider |
getEndpointProvider()
Returns the CommunicationEndpointProvider which may be used to
load the CommunicationEndpoint s this portlet offers. |
java.lang.String |
getKeywords(java.util.Locale locale)
returns the keywords for the portlet definition for the given locale. |
ListModel<? extends javax.portlet.PortletMode> |
getPortletModes()
Returns a ListModel object of PortletMode
objects that are contained in the portlet's list of supported portlet
modes. |
ListModel<? extends javax.portlet.PortletMode> |
getPortletModes(java.lang.String markup)
Returns a ListModel object of PortletMode
objects that are contained in the portlet's list of supported portlet
modes for a specific markup |
boolean |
supportsPortletMode(javax.portlet.PortletMode mode)
Checks if a given portlet mode is in the list of supported portlet modes. |
boolean |
supportsPortletMode(javax.portlet.PortletMode mode,
java.lang.String markup)
Checks if a given portlet mode is in the list of supported portlet modes for the given markup. |
Methods inherited from interface com.ibm.portal.Identifiable |
---|
getObjectID |
Methods inherited from interface com.ibm.portal.admin.MarkupCapable |
---|
getMarkups, supportsMarkup, supportsMarkup |
Methods inherited from interface com.ibm.portal.portletmodel.PortletPreferencesProvider |
---|
getMetaData, getPortletPreferencesLayer |
Methods inherited from interface com.ibm.portal.portletmodel.PublicRenderParameterProvider |
---|
getPublicRenderParameters |
Methods inherited from interface com.ibm.portal.Localized |
---|
getDescription, getLocales, getTitle |
Methods inherited from interface com.ibm.portal.TimeStamped |
---|
getCreated, getLastModified |
Methods inherited from interface com.ibm.portal.ActiveFlag |
---|
isActive |
Method Detail |
---|
CommunicationEndpointProvider getEndpointProvider()
CommunicationEndpointProvider
which may be used to
load the CommunicationEndpoint
s this portlet offers.
CommunicationEndpointProvider
ListModel<? extends javax.portlet.PortletMode> getPortletModes() throws ModelException
ListModel
object of PortletMode
objects that are contained in the portlet's list of supported portlet
modes.
PortletMode
objects, never
null
ModelException
- in case the portlet modes cannot be obtainedListModel<? extends javax.portlet.PortletMode> getPortletModes(java.lang.String markup) throws ModelException
ListModel
object of PortletMode
objects that are contained in the portlet's list of supported portlet
modes for a specific markup
markup
- The markup for which the supported modes are requested.
PortletMode
objects, never
null
ModelException
- in case the portlet modes cannot be obtainedboolean supportsPortletMode(javax.portlet.PortletMode mode) throws ModelException
mode
- The portlet mode that is to be checked.
true
if the mode is in the list of supported modes
for any supported markup, false
if not.
ModelException
- in case the portlet modes cannot be obtainedboolean supportsPortletMode(javax.portlet.PortletMode mode, java.lang.String markup) throws ModelException
mode
- The portlet mode that is to be checked.markup
- The markup for which the mode is to be checked.
true
if the markup is in the list of supported
markups and the mode is in the list of supported modes for that
markup, false
if not.
ModelException
- in case the portlet modes cannot be obtainedjava.lang.String getKeywords(java.util.Locale locale)
null
, if the
keywords not defined
The
- locale, must not be null
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |