|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Deprecated public interface LegacyPortletTargetAccessorController
Interface providing write accessor methods for legacy (4.x) portlets which allow
for including a portlet action into the state holder. It extends the functionality
provided by the PortletTargetAccessorController
which in turn is also
suitable for standard portlets.
In particular, this controller allows to set an action reference to identify the action
to be executed as well as the requested portlet mode and window state.
Field Summary | |
---|---|
static java.lang.String |
SIMPLE_ACTION_NAMESPACE
Deprecated. prefix for action references that point to simple actions |
Method Summary | |
---|---|
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Deprecated. Returns an unmodifiable and potentially empty map of target parameters as there is no concept of target parameters for IBM portlet API portlets (aka legacy portlets). |
void |
setActionReference(java.lang.String actionReference)
Deprecated. Sets the action reference given by the portlet. |
void |
setRequestedMode(javax.portlet.PortletMode mode)
Deprecated. Sets the portlet mode which was requested by the portlet action. |
void |
setRequestedState(javax.portlet.WindowState state)
Deprecated. Sets the window state which was requested by the portlet action. |
void |
setResourceID(java.lang.String resourceID)
Deprecated. This method is only applicable for JSR 286 portlets. |
void |
setTarget(com.ibm.portal.state.accessors.portlet.TargetType targetType,
ObjectID id)
Deprecated. Declares the target with the given ObjectID as the target of the link(s) that
encode the state document this accessor operates on. |
void |
setTarget(com.ibm.portal.state.accessors.portlet.TargetType targetType,
java.lang.String uniqueName)
Deprecated. Declares the target with the given unique name as the target of the link(s) that encode the state document this accessor operates on. |
Methods inherited from interface com.ibm.portal.state.accessors.portlet.PortletTargetAccessorController |
---|
setActionTarget, setActionTarget, setActionTarget, setActionTarget, setActionTarget, setActionTarget, setRenderTarget, setRenderTarget, setResourceCacheability |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Field Detail |
---|
static final java.lang.String SIMPLE_ACTION_NAMESPACE
Method Detail |
---|
void setActionReference(java.lang.String actionReference)
Sets the action reference given by the portlet. The action reference
identifies the action that should be executed. If the action
reference references a simple action, then the actionReference needs
to start with the SIMPLE_ACTION_NAMESPACE
prefix. If the action
reference references a portlet action, then the caller must make sure
to properly initialize the portlet session.
actionReference
- A portlet action reference
(must not be null
).void setRequestedMode(javax.portlet.PortletMode mode)
mode
- The requested mode (must not be null
).void setRequestedState(javax.portlet.WindowState state)
state
- The requested window state (must not be
null
).void setTarget(com.ibm.portal.state.accessors.portlet.TargetType targetType, ObjectID id)
ObjectID
as the target of the link(s) that
encode the state document this accessor operates on. The resulting link will be a link
matching the given TargetTarget
.
setTarget
in interface com.ibm.portal.state.accessors.portlet.PortletTargetAccessorController
targetType
- The type of the target. Must not be null
.
Only the following target types are supported for legacy portlets:
TargetType.PORTLET_ACTION
TargetType.PORTLET_RENDER
id
- The ObjectID
of the target.PortletTargetAccessorController.setTarget(TargetType, ObjectID)
void setTarget(com.ibm.portal.state.accessors.portlet.TargetType targetType, java.lang.String uniqueName) throws com.ibm.portal.state.accessors.exceptions.MissingUniqueNameException, com.ibm.portal.state.accessors.exceptions.UnknownUniqueNameException
TargetTarget
.
setTarget
in interface com.ibm.portal.state.accessors.portlet.PortletTargetAccessorController
targetType
- The type of the target. Must not be null
.
Only the following target types are supported for legacy portlets:
TargetType.PORTLET_ACTION
TargetType.PORTLET_RENDER
uniqueName
- String
representing the unique name of the target. Must not
be null
.
com.ibm.portal.state.accessors.exceptions.MissingUniqueNameException
com.ibm.portal.state.accessors.exceptions.UnknownUniqueNameException
PortletTargetAccessorController.setTarget(TargetType, String)
void setResourceID(java.lang.String resourceID) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
setResourceID
in interface com.ibm.portal.state.accessors.portlet.PortletTargetAccessorController
java.lang.UnsupportedOperationException
- Every time this method is called.java.util.Map<java.lang.String,java.lang.String[]> getParameters()
getParameters
in interface com.ibm.portal.state.accessors.portlet.PortletTargetAccessorController
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |