|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Action
Action
encapsulates the information used by the Property Broker to deliver property
values provided by sources to targets. This interface does not have any dependencies
on a WebSphere Portal environment as it is designed for reuse within general
component environments where brokered communication may be provided. Multiple types
of actions may be supported in the same environment or different environments.
Action types which are natively supported in the WebSphere Portal environment
are defined in the ActionType
class.
In the WebSphere Portal runtime environment, Action
objects may be programmatically created using PropertyBrokerService
, followed
by invoking the setter methods found in ActionController
, or
may be created by the runtime by declaring equivalent information in a WSDL file.
Implementations of this interface must be Serializable.
PropertyBrokerService
,
Parameter
,
ActionController
,
ActionType
Method Summary | |
---|---|
java.lang.String |
getActionInvocationMetaData()
Returns additional metadata which may be useful for dispatchers of the action. |
java.lang.String |
getActionNameParameter()
Returns the name of a parameter that should be used as a key for retrieving the action name when the action name cannot be directly passed. |
java.util.Map |
getConstantParameters()
Returns an unmodifiable Map containing name, value entries. |
java.lang.String |
getDescription(java.util.Locale locale)
Returns string containing a description of the action which can be used as a visual aid when displayed by tools or as help text. |
java.lang.Object |
getId()
Returns a globally unique id identifying the property. |
boolean |
getInvokeIfMultipleActionsActive()
Returns a boolean value indicating if this action should be invoked even if multiple actions on the owning component are simultaneously triggered for invocation. |
java.lang.String |
getName()
Returns the name of the action. |
java.lang.Object |
getOwningDefinitionId()
Returns the component owner definition id associated with this action. |
Parameter[] |
getParameters()
Returns the Parameter array associated with this action. |
java.util.Locale[] |
getSupportedLocales()
Returns the locales that are supported for the displayable text, such as the title and description, associated with the current action. |
java.lang.String |
getTitle(java.util.Locale locale)
Returns a short string about the action suitable for displaying in a menu, in tools, or as help text. |
ActionType |
getType()
Returns the type of the action. |
boolean |
isInitiallyActive()
Returns a boolean value indicating if the action is active when the owning component is initialized and active, or whether the owning component will programmatically activate and deactivate the action. |
Method Detail |
---|
java.lang.String getName()
ActionController
for setter methods.
String
containing the action nameActionController
java.lang.Object getId()
ActionController
but
will be set by the runtime once the property has been created and
registered. If the Action
object has been created but
not registered, null will be returned. Once the action is registered
with the portal, the id will not be null.
Object
which serves as the globally unique
identifier for the property.java.util.Map getConstantParameters()
Map
containing name, value entries. These entries will be passed to the action when it is
invoked. How the entries are passed to the action is dependent on the action type and the
runtime environment. For example, in the WebSphere Portal runtime environment, for an
action type of ActionType.STANDARD_PORTLET_ACTION
, the entries will be bound as request parameters. The values
for the entries are restricted to strings.
The keys and values in the Map
are of type String
.
Map
of constant objects associated with this actionjava.lang.String getTitle(java.util.Locale locale)
locale
- the client locale
java.lang.String getDescription(java.util.Locale locale)
locale
- the client locale
java.lang.Object getOwningDefinitionId()
Parameter[] getParameters()
Parameter
array associated with this action.
The length of the array will be at least one, as registered actions must
have at least an input or an output parameter. The returned array must not
be modified.
Parameter
objects associated with this action.ActionType getType()
ActionType
boolean isInitiallyActive()
java.lang.String getActionInvocationMetaData()
String
which may be set at the time of action creation and is not
modified by the runtime.
boolean getInvokeIfMultipleActionsActive()
java.util.Locale[] getSupportedLocales()
java.lang.String getActionNameParameter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |