|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletTargetAccessorFactory
Factory providing methods to obtain write accessors that allow for including
portlet target information into the state holder. These accessors should be
used to declare a portlet as the target of an action or render link by
writing the necessary information into the state holder.
Note that only one portlet may be the target of a link, i.e. the state holder
only stores portlet target information for at most one portlet. Requesting
multiple accessors operating on the same state document or using the same
accessor instance a multiple times implies that the target information will
be overridden each time one of these accessors is called.
NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme.
The API can not be invoked directly by a custom servlet.
Method Summary | |
---|---|
LegacyPortletTargetAccessorController |
getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req)
Returns a controller which allows for declaring a legacy portlet as the target of an action link in the request-specific state document. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req,
Node root,
DocumentController model)
Returns a controller which allows for declaring a legacy portlet as the target of an action link. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req,
StateHolderController state)
Returns a controller which allows for declaring a legacy portlet as the target of an action link in the given state document. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetAccessorController(Node root,
DocumentController model)
Returns a controller which allows for declaring a legacy portlet as the target of an action link. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetAccessorController(StateHolderController state)
Returns a controller which allows for declaring a legacy portlet as the target of an action link in the given state document. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req)
Deprecated. since 6.0, use method getLegacyPortletTargetAccessorController(HttpServletRequest) instead |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req,
Node root,
DocumentController model)
Deprecated. since 6.0, use method getLegacyPortletTargetAccessorController(HttpServletRequest, Node, DocumentController) instead |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req,
StateHolderController state)
Deprecated. since 6.0, use method getLegacyPortletTargetAccessorController(HttpServletRequest, StateHolderController) instead |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetController(Node root,
DocumentController model)
Deprecated. Use the method getLegacyPortletTargetAccessorController(Node, DocumentController) instead.
Returns a controller which allows for declaring a legacy portlet as the
target of an action link. The returned controller operates on the given
node representing the root of portlet target information. |
LegacyPortletTargetAccessorController |
getLegacyPortletTargetController(StateHolderController state)
Deprecated. since 6.0, use method getLegacyPortletTargetAccessorController(StateHolderController) instead |
PortletTargetAccessorController |
getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req)
Returns a controller which allows for declaring a portlet as the target of an action or render link in the request-specific state. |
PortletTargetAccessorController |
getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req,
Node root,
DocumentController model)
Returns a controller which allows for declaring a portlet as the target of an action or render link. |
PortletTargetAccessorController |
getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req,
StateHolderController state)
Returns a controller which allows for declaring a portlet as the target of an action or render link in the given state document. |
PortletTargetAccessorController |
getPortletTargetAccessorController(Node root,
DocumentController model)
Returns a controller which allows for declaring a portlet as the target of an action or render link. |
PortletTargetAccessorController |
getPortletTargetAccessorController(StateHolderController state)
Returns a controller which allows for declaring a portlet as the target of an action or render link in the given state document. |
PortletTargetAccessorController |
getPortletTargetController(javax.servlet.http.HttpServletRequest req)
Deprecated. since 6.0, use method getPortletTargetAccessorController(HttpServletRequest) instead. |
PortletTargetAccessorController |
getPortletTargetController(javax.servlet.http.HttpServletRequest req,
Node root,
DocumentController model)
Deprecated. since 6.0, use method getPortletTargetAccessorController(HttpServletRequest) instead |
PortletTargetAccessorController |
getPortletTargetController(javax.servlet.http.HttpServletRequest req,
StateHolderController state)
Deprecated. since 6.0, use method getPortletTargetAccessorController(HttpServletRequest, StateHolderController) instead |
PortletTargetAccessorController |
getPortletTargetController(Node root,
DocumentController model)
Deprecated. since 6.0, use method getPortletTargetAccessorController(Node, DocumentController) instead |
PortletTargetAccessorController |
getPortletTargetController(StateHolderController state)
Deprecated. since 6.0, use method getPortletTargetAccessorController(StateHolderController) instead |
boolean |
removePortletTarget(javax.servlet.http.HttpServletRequest req)
Removes the target information from the request-specific state. |
boolean |
removePortletTarget(StateHolderController state)
Removes the target information from the given state. |
Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory |
---|
compact |
Method Detail |
---|
PortletTargetAccessorController getPortletTargetAccessorController(StateHolderController state)
state
- Read-write interface to state. Must not be null
.
PortletTargetAccessorController getPortletTargetAccessorController(Node root, DocumentController model)
root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
LegacyPortletTargetAccessorController getLegacyPortletTargetAccessorController(StateHolderController state)
state
- Read-write interface to state. Must not be null
.
LegacyPortletTargetAccessorController getLegacyPortletTargetAccessorController(Node root, DocumentController model)
root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.PortletTargetAccessorController getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req) throws StateNotWriteableException, StateNotInRequestException
request
- The current servlet request. Must not be null
.
null
.
StateNotWriteableException
- if a state holder could be associated with a request but the
state is read-only
StateNotInRequestException
- if no state could be associated with the requestPortletTargetAccessorController getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req, StateHolderController state)
request
- The current servlet request. Must not be null
.state
- Read-write interface to state. Must not be null
.
null
.PortletTargetAccessorController getPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req, Node root, DocumentController model)
request
- The current servlet request. Must not be null
.root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.LegacyPortletTargetAccessorController getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req, StateHolderController state)
request
- The current servlet request. Must not be null
.state
- Read-write interface to state. Must not be null
.
null
.LegacyPortletTargetAccessorController getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req) throws StateNotWriteableException, StateNotInRequestException
request
- The current servlet request. Must not be null
.
null
.
StateNotWriteableException
- If a state holder could be associated with a request but the
state is read-only.
StateNotInRequestException
- If no state could be associated with the request.LegacyPortletTargetAccessorController getLegacyPortletTargetAccessorController(javax.servlet.http.HttpServletRequest req, Node root, DocumentController model)
request
- The current servlet request. Must not be null
.root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.PortletTargetAccessorController getPortletTargetController(StateHolderController state)
getPortletTargetAccessorController(StateHolderController)
instead
state
- Read-write interface to state. Must not be null
.
PortletTargetAccessorController getPortletTargetController(Node root, DocumentController model)
getPortletTargetAccessorController(Node, DocumentController)
instead
root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
LegacyPortletTargetAccessorController getLegacyPortletTargetController(StateHolderController state)
getLegacyPortletTargetAccessorController(StateHolderController)
instead
state
- Read-write interface to state. Must not be null
.
LegacyPortletTargetAccessorController getLegacyPortletTargetController(Node root, DocumentController model)
getLegacyPortletTargetAccessorController(Node, DocumentController)
instead.
Returns a controller which allows for declaring a legacy portlet as the
target of an action link. The returned controller operates on the given
node representing the root of portlet target information.
root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.PortletTargetAccessorController getPortletTargetController(javax.servlet.http.HttpServletRequest req) throws StateNotWriteableException, StateNotInRequestException
getPortletTargetAccessorController(HttpServletRequest)
instead.
request
- The current servlet request. Must not be null
.
null
.
StateNotWriteableException
- if a state holder could be associated with a request but the
state is read-only
StateNotInRequestException
- if no state could be associated with the requestPortletTargetAccessorController getPortletTargetController(javax.servlet.http.HttpServletRequest req, StateHolderController state)
getPortletTargetAccessorController(HttpServletRequest, StateHolderController)
instead
request
- The current servlet request. Must not be null
.state
- Read-write interface to state. Must not be null
.
null
.PortletTargetAccessorController getPortletTargetController(javax.servlet.http.HttpServletRequest req, Node root, DocumentController model)
getPortletTargetAccessorController(HttpServletRequest)
instead
request
- The current servlet request. Must not be null
.root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.LegacyPortletTargetAccessorController getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req, StateHolderController state)
getLegacyPortletTargetAccessorController(HttpServletRequest, StateHolderController)
instead
request
- The current servlet request. Must not be null
.state
- Read-write interface to state. Must not be null
.
null
.LegacyPortletTargetAccessorController getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req) throws StateNotWriteableException, StateNotInRequestException
getLegacyPortletTargetAccessorController(HttpServletRequest)
instead
request
- The current servlet request. Must not be null
.
null
.
StateNotWriteableException
- If a state holder could be associated with a request but the
state is read-only.
StateNotInRequestException
- If no state could be associated with the request.LegacyPortletTargetAccessorController getLegacyPortletTargetController(javax.servlet.http.HttpServletRequest req, Node root, DocumentController model)
getLegacyPortletTargetAccessorController(HttpServletRequest, Node, DocumentController)
instead
request
- The current servlet request. Must not be null
.root
- Root node for portlet target information. Must not be
null
.model
- Read-write state document model. Must contain the node
root
. Must not be null
.
null
.boolean removePortletTarget(StateHolderController state)
state
- Read-write interface to state. Must not be null
.
true
if removed, false
if not
found.boolean removePortletTarget(javax.servlet.http.HttpServletRequest req) throws StateNotWriteableException, StateNotInRequestException
req
- The current servlet request. Must not be null
.
true
if removed, false
if not
found.
StateNotWriteableException
- if a state holder could be associated
with a request but the state is read-only
StateNotInRequestException
- if no state could be associated with
the request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |