|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ActionController
ActionController
encapsulates setter methods used when initializing instances of
Action
.
This interface has no dependencies on
specific runtime environments such as WebSphere Portal.
In the WebSphere Portal environment, ActionController
objects may be programmatically created using PropertyBrokerService
, followed
by invoking the setter methods of this interface, or may be implicitly created by the runtime
when equivalent information is declared in a WSDL file.
The corresponding getter methods in Action
have detailed descriptions
of what the attribute is used for.
PropertyBrokerService
,
Parameter
,
ParameterController
,
Action
Method Summary | |
---|---|
void |
setActionInvocationMetaData(java.lang.String invocationMetadata)
Sets additional metadata which may be used to invoke targets. |
void |
setActionNameParameter(java.lang.String value)
Sets the parameter that should be used as a key to determine the action name. |
void |
setConstantParameters(java.util.Map params)
Sets additional constant parameters associated with the Action, by way of name, value entries in a Map. |
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets a localized description for this action. |
void |
setInitiallyActive(boolean initiallyActive)
Sets if the action is initially active when the owning object (such as a portlet) is active or if it needs to be programmatically activated for each session. |
void |
setInvokeIfMultipleActionsActive(boolean invokeIfMultipleActive)
Sets if this action should be invoked when other actions on the portlet are simultaneously active due to multiple wires being simultaneously triggered. |
void |
setName(java.lang.String name)
Sets the name of the action. |
void |
setParameters(Parameter[] parameters)
Sets the Parameter array associated with this action. |
void |
setTitle(java.lang.String title,
java.util.Locale locale)
Sets a localized title for this action. |
void |
setType(ActionType value)
Sets the type of the action. |
Methods inherited from interface com.ibm.portal.propertybroker.property.Action |
---|
getActionInvocationMetaData, getActionNameParameter, getConstantParameters, getDescription, getId, getInvokeIfMultipleActionsActive, getName, getOwningDefinitionId, getParameters, getSupportedLocales, getTitle, getType, isInitiallyActive |
Method Detail |
---|
void setName(java.lang.String name)
IllegalArgumentException
will be thrown.
name
- the nameAction.getName()
void setConstantParameters(java.util.Map params)
params
- a Map
of constant objects.Action.getConstantParameters()
void setTitle(java.lang.String title, java.util.Locale locale)
title
- a short description for this action for the provided localelocale
- the current localeAction.getTitle(Locale)
void setDescription(java.lang.String description, java.util.Locale locale)
description
- a text description for this action for the provided localelocale
- the current localeAction.getDescription(Locale)
void setParameters(Parameter[] parameters)
Parameter
array associated with this action.
parameters
- the array of parameter objects associated with this action - at most
one input parameter, zero or more output parameters. The array must contain
at least one Parameter
, otherwise IllegalArgumentException
will be thrown.Parameter
,
Action.getParameters()
void setType(ActionType value)
ActionType
for a
description of action types. The value must not be null,
otherwise IllegalArgumentException
will be thrown.
value
- the type of the action.ActionType
,
Action.getType()
void setActionInvocationMetaData(java.lang.String invocationMetadata)
invocationMetadata
- a string of additional metadataAction.getActionInvocationMetaData()
void setInitiallyActive(boolean initiallyActive)
initiallyActive
- boolean value which should be false to make this action initially inactiveAction.isInitiallyActive()
void setInvokeIfMultipleActionsActive(boolean invokeIfMultipleActive)
invokeIfMultipleActive
- Action.getInvokeIfMultipleActionsActive()
void setActionNameParameter(java.lang.String value)
the
- action name parameterAction.getActionNameParameter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |