com.sap.caf.eu.gp.process.rt.api

Interface IGPActionCompletionData

public interface IGPActionCompletionData

Field Summary

static int	ACTIVITY_TYPE_BACKGROUND Indicates that the activity is a background activity
static int	ACTIVITY_TYPE_USER Indicates that the activity is processed by a user.
static int	RESULT_STATE_COMPLETED_DONE_ONLY Indicates that the implementation of the callable object has invoked the completeProcessing() method to indicate that it is now done with the processing.
static int	RESULT_STATE_COMPLETED_PROCESS_EXCEPTION Indicates that the implementation of the callable object has thrown a process exception.
static int	RESULT_STATE_COMPLETED_RESULTSTATE Indicates that the implementation of the callable object has set a result state.
static int	RESULT_STATE_COMPLETED_TECHNICAL_EXCEPTION Indicates that the implementation of the callable object has thrown a technical exception to indicate that processing cannot continue.

Method Summary

String	getActionInstanceID() Returns the action instance ID that will be completed
IGPStructure	getOutputStructure() Returns an object for setting output data that is used for action completion
String	getProcessException() Returns the process exception name that is used for action completion
String	getProcessInstanceID() Returns the process instance ID for the process where will be action completion
Vector	getResultStates() Returns a list with technical names for result states that are used for action completion
int	getState() Returns the result state for action completion
int	getType() Returns the type for action completion
void	setProcessException(String processExceptionName) Sets process exception that will be used for action completion
void	setResultStates(Vector resultStates) Sets an array with technical names for result states that will be used for action completion
void	setState(int state) Sets the state that is used for action completion
void	setTechnicalException(GPTechnicalCallableObjectException exception) Sets technical exception that will be used for action completion
void	setType(int type) Sets the state that is used for action completion

Field Detail

RESULT_STATE_COMPLETED_DONE_ONLY

public static final int RESULT_STATE_COMPLETED_DONE_ONLY

Indicates that the implementation of the callable object has invoked the completeProcessing() method to indicate that it is now done with the processing.

See Also:

Constant Field Values

RESULT_STATE_COMPLETED_RESULTSTATE

public static final int RESULT_STATE_COMPLETED_RESULTSTATE

Indicates that the implementation of the callable object has set a result state.

See Also:

Constant Field Values

RESULT_STATE_COMPLETED_PROCESS_EXCEPTION

public static final int RESULT_STATE_COMPLETED_PROCESS_EXCEPTION

Indicates that the implementation of the callable object has thrown a process exception.

See Also:

Constant Field Values

RESULT_STATE_COMPLETED_TECHNICAL_EXCEPTION

public static final int RESULT_STATE_COMPLETED_TECHNICAL_EXCEPTION

Indicates that the implementation of the callable object has thrown a technical exception to indicate that processing cannot continue.

See Also:

Constant Field Values

ACTIVITY_TYPE_BACKGROUND

public static final int ACTIVITY_TYPE_BACKGROUND

Indicates that the activity is a background activity

See Also:

Constant Field Values

ACTIVITY_TYPE_USER

public static final int ACTIVITY_TYPE_USER

Indicates that the activity is processed by a user.

See Also:

Constant Field Values

Method Detail

setProcessException

public void setProcessException(String processExceptionName)
                         throws GPInvocationException

Sets process exception that will be used for action completion

Parameters:

processExceptionName - the name fpr the process exception. The name must be from available process exceptions for this action

Throws:

GPInvocationException

getProcessException

public String getProcessException()

Returns the process exception name that is used for action completion

Returns:

the process exception name

setTechnicalException

public void setTechnicalException(GPTechnicalCallableObjectException exception)

Sets technical exception that will be used for action completion

Parameters:

exception - An object that represents the technical exception

See Also:

com.sap.caf.eu.gp.model.co.tech.TechnicalCallableObjectException

setResultStates

public void setResultStates(Vector resultStates)
                     throws GPInvocationException

Sets an array with technical names for result states that will be used for action completion

Parameters:

resultStates - java.util.Vector object that contains a list with the technical names

Throws:

GPInvocationException

getResultStates

public Vector getResultStates()

Returns a list with technical names for result states that are used for action completion

Returns:

java.util.Vector list with technical names

getOutputStructure

public IGPStructure getOutputStructure()

Returns an object for setting output data that is used for action completion

Returns:

com.sap.caf.eu.gp.structure.api.IGPStructure

getProcessInstanceID

public String getProcessInstanceID()

Returns the process instance ID for the process where will be action completion

Returns:

process instance ID

getActionInstanceID

public String getActionInstanceID()

Returns the action instance ID that will be completed

Returns:

action instance ID

setState

public void setState(int state)

Sets the state that is used for action completion

Parameters:

state -

See Also:

RESULT_STATE_COMPLETED_DONE_ONLY, RESULT_STATE_COMPLETED_RESULTSTATE, RESULT_STATE_COMPLETED_PROCESS_EXCEPTION, RESULT_STATE_COMPLETED_TECHNICAL_EXCEPTION

getState

public int getState()

Returns the result state for action completion

setType

public void setType(int type)

Sets the state that is used for action completion

Parameters:

type -

See Also:

ACTIVITY_TYPE_BACKGROUND, ACTIVITY_TYPE_USER

getType

public int getType()

Returns the type for action completion