| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Action
For use by portlets written to the IBM portlet API only.
Action
encapsulates the information used by the Property Broker to deliver property
values provided by source portlets to target portlets. The target portlet may implement the action
either as a portlet action (via the ActionListener interface), or as a
Struts action.
Action objects will be implicitly created and registered with the Property Broker if
defined in a WSDL file. Otherwise, they may be explicitly created and registered
programmatically. May be programmatically created using PropertyFactory, followed
by invoking the setters.
This interface is for use by portlets using the IBM portlet API.
Field Summary | |
---|---|
static int | DEFAULT_PORTLET_ACTION
Deprecated. Specifies delivery using DefaultPortletAction. |
static int | SIMPLE_PORTLET_ACTION
Deprecated. Specifies delivery using a simple action string |
static int | STRUTS_ACTION
Deprecated. Specifies delivery using Struts |
Method Summary | |
---|---|
boolean | getActiveOnStartup()
Deprecated. |
java.util.Map | getConstantParameters()
Deprecated. Returns a Map containing name, value entries.
|
java.lang.String | getDescription()
Deprecated. |
java.lang.String | getDescription(java.util.Locale locale)
Deprecated. Returns a string containing a description of the action which can be used as a visual aid. |
boolean | getInvokeOnMultipleMatch()
Deprecated. |
java.lang.String | getName()
Deprecated. Returns the name of the action. |
java.lang.Object | getOwnerId()
Deprecated. Returns an id representing the portlet which registered this action. |
Parameter[] | getParameters()
Deprecated. Returns the parameters associated with the action. |
java.lang.String | getTitle()
Deprecated. |
java.lang.String | getTitle(java.util.Locale locale)
Deprecated. Returns a short string about the action suitable for displaying in a menu. |
int | getType()
Deprecated. Returns the type of the action. |
boolean | isActiveOnStartup()
Deprecated. Returns true if this action is active on portlet startup. |
boolean | isImplementedBy(PortletSettings caller)
Deprecated. Returns true if the action was registered by the calling portlet. |
boolean | isInvocableOnMultipleMatch()
Deprecated. Returns a boolean indicating whether the action should be processed if it is simultaneously triggered with other actions on the same portlet (due to multiple wires being activated, or multiple actions being triggered through a Click-to-Action menu, for example). |
void | setActiveOnStartup(boolean activeOnStartup)
Deprecated. Sets the activeOnStartup parameter for this action. |
void | setConstantParameters(java.util.Map params)
Deprecated. Sets constant parameters associated with the Action, by way of name, value entries in a Map .
|
void | setDescription(java.lang.String descriptionKey)
Deprecated. |
void | setDescriptionKey(java.lang.String descriptionKey)
Deprecated. Sets the key for the description. |
void | setInvocableOnMultipleMatch(boolean invokeOnMultipleMatch)
Deprecated. Sets the parameter used to specify whether the action can be invoked in the event multiple matching actions are available for invocation on the portlet. |
void | setInvokeOnMultipleMatch(boolean invokeOnMultipleMatch)
Deprecated. |
void | setLocalizationInfo(java.lang.String nlsFileName,
PortletContext context,
java.util.Locale[] locales)
Deprecated. This data is used to retrieve internationalized versions of the title and description. |
void | setName(java.lang.String name)
Deprecated. Sets the name of the action. |
void | setParameters(Parameter[] params)
Deprecated. Sets the action parameters. |
void | setTitle(java.lang.String titleKey)
Deprecated. |
void | setTitleKey(java.lang.String titleKey)
Deprecated. Sets the key for the title. |
void | setType(int type)
Deprecated. Sets the type of this action. |
Field Detail |
---|
static final int DEFAULT_PORTLET_ACTION
static final int SIMPLE_PORTLET_ACTION
static final int STRUTS_ACTION
Method Detail |
---|
java.lang.String getName()
String
containing the action namejava.util.Map getConstantParameters()
Map
containing name, value entries. These entries will be passed to the action when it is
invoked through the property broker. How the entries are passed to the action is dependent on the action type. For actions implemented
by portlets, the values are passed as request parameters. The values
for the entries are restricted to String
.
Map
of constant objects associated with this action. If no constant
parameters were set, an empty Map
is returned.Parameter[] getParameters()
java.lang.String getTitle()
String
containing the titlejava.lang.String getDescription()
String
containing the descriptionjava.lang.String getTitle(java.util.Locale locale)
java.lang.String getDescription(java.util.Locale locale)
boolean isInvocableOnMultipleMatch()
boolean getInvokeOnMultipleMatch()
isInvocableOnMultipleMatch
instead.
int getType()
DEFAULT_PORTLET_ACTION
et. al.
See the constants in this interface for allowed values.java.lang.Object getOwnerId()
Object
representing the id of the portlet which registered this action.
May be used in comparisons.boolean isImplementedBy(PortletSettings caller)
boolean isActiveOnStartup()
activateActions
in the PropertyBrokerService interface.boolean getActiveOnStartup()
isActiveOnStartup
instead.
void setName(java.lang.String name)
void setConstantParameters(java.util.Map params)
Map
. The values are restricted to String
. If this method is called multiple times,
the values in the Map
passed to the last call override previous values.
If null or an empty Map
is passed, any
constant parameters set earlier are cleared.
Map
of constant String
values.
String
.
void setParameters(Parameter[] params) throws InvalidPropertyException
void setTitle(java.lang.String titleKey)
setTitleKey
instead.
void setTitleKey(java.lang.String titleKey)
setLocalizationInfo
method to retrieve the translated title for
supported locales.
void setDescription(java.lang.String descriptionKey)
setDescriptionKey
instead.
void setDescriptionKey(java.lang.String descriptionKey)
setLocalizationInfo
method to retrieve the translated description for
supported locales.
void setLocalizationInfo(java.lang.String nlsFileName, PortletContext context, java.util.Locale[] locales)
void setInvocableOnMultipleMatch(boolean invokeOnMultipleMatch)
isInvocableOnMultipleMatch
method description for a description of
the semantics of this parameter.
void setInvokeOnMultipleMatch(boolean invokeOnMultipleMatch)
setInvocableOnMultipleMatch
instead.
void setType(int type) throws InvalidPropertyException
DEFAULT_PORTLET_ACTION
is the default if not set.
void setActiveOnStartup(boolean activeOnStartup)
getActiveOnStartup
method description for a description of
this parameter.
| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |