|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WcmPageContextService
This interface provides a convenience service to get the current WCM context of a portal page. The service can be obtained via one of the home interfaces listed below.
PortalWcmPageContextServiceHome
,
PortletWcmPageContextServiceProvider
,
CorWcmPageContextServiceHome
Method Summary | |
---|---|
void |
dispose()
Releases the resources of the service. |
DocumentId<? extends ContentComponentContainer> |
getWcmDefaultContent(DocumentId<? extends ContentComponentContainer> context)
Gets the corresponding default content item, if the WCM context is a SiteArea of PortalPage. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext()
Gets the WCM context of the currently selected page. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(DocumentId<? extends ContentComponentContainer> defaultContext)
Gets the WCM context of the currently selected page. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state)
Gets the WCM context of the page that is currently selected in the given state. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state,
DocumentId<? extends ContentComponentContainer> defaultContext)
Gets the WCM context of the page that is currently selected in the given state. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state,
ObjectID page)
Gets the WCM context of the given page. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state,
ObjectID page,
DocumentId<? extends ContentComponentContainer> defaultContext)
Gets the WCM context of the given page. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state,
ObjectID page,
ObjectID window)
Gets the WCM context of the given portlet window. |
DocumentId<? extends ContentComponentContainer> |
getWcmPageContext(com.ibm.portal.state.StateHolder state,
ObjectID page,
ObjectID window,
DocumentId<? extends ContentComponentContainer> defaultContext)
Gets the WCM context of the given portlet window. |
Method Detail |
---|
void dispose()
dispose
in interface Disposable
DocumentId<? extends ContentComponentContainer> getWcmDefaultContent(DocumentId<? extends ContentComponentContainer> context) throws WCMException
context
- WCM context of the page
WCMException
DocumentId<? extends ContentComponentContainer> getWcmPageContext() throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(DocumentId<? extends ContentComponentContainer> defaultContext) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
defaultContext
- context to be returned if the state does not contain any WCM context information.
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder with the state to be used
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state, DocumentId<? extends ContentComponentContainer> defaultContext) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder with the state to be useddefaultContext
- context to be returned if the state does not contain any WCM context information.
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state, ObjectID page) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder of the state to be usedpage
- ObjectID of the page
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state, ObjectID page, DocumentId<? extends ContentComponentContainer> defaultContext) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder of the state to be usedpage
- ObjectID of the pagedefaultContext
- context to be returned if the state does not contain any WCM context information.
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state, ObjectID page, ObjectID window) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder of the state to be usedpage
- ObjectID of the page the portlet window is locatedwindow
- ObjectID of the portlet window
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
DocumentId<? extends ContentComponentContainer> getWcmPageContext(com.ibm.portal.state.StateHolder state, ObjectID page, ObjectID window, DocumentId<? extends ContentComponentContainer> defaultContext) throws com.ibm.portal.state.exceptions.StateException, WCMException, com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
state
- StateHolder of the state to be usedpage
- ObjectID of the page the portlet window is locatedwindow
- ObjectID of the portlet windowdefaultContext
- context to be returned if the state does not contain any WCM context information.
com.ibm.portal.state.exceptions.StateException
WCMException
com.ibm.portal.services.contentmapping.exceptions.ContentMappingException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |