|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DescriptionHandler
This interface provides methods to access portlet descriptions as well as the service description.
Method Summary | |
---|---|
PortletDescription |
getPortletDescription(java.lang.String portletHandle)
Returns a complete PortletDescription for the given PortletHandle. |
PortletDescription |
getPortletDescription(java.lang.String portletHandle,
RegistrationContext regContext,
UserContext userContext,
java.lang.String[] desiredLocales)
Returns an PortletDescription for the given PortletHandle based on the input arguments. |
PortletDescription[] |
getProducerOfferedPortletDescriptions(RegistrationContext regContext,
java.lang.String[] desiredLocales)
Returns an array containing all portlet descriptions, i.e. one portlet description per producer offered portlet. |
ServiceDescription |
getServiceDescription(RegistrationContext regContext,
java.lang.String[] desiredLocales)
Returns a ServiceDescription, based on the input arguments. |
boolean |
isRegistrationRequired()
Indicates whether registration is required (for this Producer) or not. |
Method Detail |
---|
ServiceDescription getServiceDescription(RegistrationContext regContext, java.lang.String[] desiredLocales) throws WSRPException
regContext
- contains data related to a particular registration
(e.g. the registration handle and state)desiredLocales
- array of requested locales, if null request all available locales
WSRPException
boolean isRegistrationRequired() throws WSRPException
WSRPException
PortletDescription[] getProducerOfferedPortletDescriptions(RegistrationContext regContext, java.lang.String[] desiredLocales) throws WSRPException
regContext
- contains data related to a particular registration
(e.g. the registration handle and state)desiredLocales
- array of requested locales, if null request all available locales
WSRPException
PortletDescription getPortletDescription(java.lang.String portletHandle, RegistrationContext regContext, UserContext userContext, java.lang.String[] desiredLocales) throws WSRPException
portletHandle
- the handle of a particular portletregContext
- contains data related to a particular registration
(e.g. the registration handle and state)userContext
- contains the user contextdesiredLocales
- array of requested locales, if null request all available locales
WSRPException
PortletDescription getPortletDescription(java.lang.String portletHandle) throws WSRPException
portletHandle
- the handle of a particular portlet
WSRPException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |