com.sap.tc.col.client.generic.api
Interface IAction

public interface IAction

realizes interface of an Action. an Action is an operation on Keys of Aspects other than the standard operations like insert, update, delete. Examples for actions are "printing", "booking of flights" ... An example using an Action could be:

   IAction action = aspect.createAction("BOOKING_CANCEL");
   IStructure inputParameter = action.getInputParameter();
   // setting input parameter
   inputParameter.setAttributeValue("BOOKING", "000001");
   ..
   action.execute();
   ..
 

Additionally Action implements ICMIGenericModelClass and ICMIModelClassExecutable.

This is necessary to use an Action from Web Dynpro. Web Dynpro framework only knows this interfaces and uses the implicit relations inputParameter for setting parameters.

Field Summary

static java.lang.String

INPUT_PARAMETER constant string for implicit inputParamter relation role

Method Summary

void	execute() executes this Action.
IAspectActionDescriptor	getDescriptor() returns the meta data of this Action typically meta data are the name of the Action and the aspect this action belongs to
IKeyList	getInputKeyList() returns the input KeyList of this Action
IStructure	getInputParameter() returns the input parameter structure of this Action or throws an UnsupportedOperationException, if this Action has no input parameter.
IStructure	getInputParameterStructure() returns the input parameter structure of this Action or throws an UnsupportedOperationException, if this Action has no input parameter.
void	setRelationTargetKey(IKey key) sets the Key of a related target AspectRow, where this Action must be a cross Aspect Action.

Field Detail

INPUT_PARAMETER

public static final java.lang.String INPUT_PARAMETER

constant string for implicit inputParamter relation role

Method Detail

execute

public void execute()

executes this Action. this doesn't mean, that the action is now executed synchrounously in backend but it is sent to a service queue.

before this is done all pending changes of the associated Aspect are sent to service queue, to avoid executing the Action, on old data. ( a implicit sendChanges() on Aspect level )

getInputParameterStructure

public IStructure getInputParameterStructure()

returns the input parameter structure of this Action or throws an UnsupportedOperationException, if this Action has no input parameter.

Returns:

IStructure the input parameter of this Action

Throws:

throws - an UnsupportedOperationException, if this Action has no input parameter.

getInputParameter

public IStructure getInputParameter()

returns the input parameter structure of this Action or throws an UnsupportedOperationException, if this Action has no input parameter.

Returns:

IStructure the input parameter of this Action

Throws:

throws - an UnsupportedOperationException, if this Action has no input parameter.

getInputKeyList

public IKeyList getInputKeyList()

returns the input KeyList of this Action

Returns:

the input KeyList of this Action

setRelationTargetKey

public void setRelationTargetKey(IKey key)

sets the Key of a related target AspectRow, where this Action must be a cross Aspect Action.

getDescriptor

public IAspectActionDescriptor getDescriptor()

returns the meta data of this Action typically meta data are the name of the Action and the aspect this action belongs to

Returns:

IAspectActionDescriptor the meta data of this Action.