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

Interface IGPActionInstance

All Superinterfaces:

IGPActivityInstance

public interface IGPActionInstance
extends IGPActivityInstance

Field Summary

static int	TYPE_BACKGROUND Type of an action
static int	TYPE_INVALID Type of an action
static int	TYPE_UI Type of an action

Method Summary

String	generateBusinessParametersForSingleTaskUI() Returns the portal navigation business parameters for single task UI.
String	generateNavigationTargetForSingleTaskUI() Returns the portal navigation target for single task UI.
String	generateStandaloneURLForSingleTaskUI() Returns the single task UI application URL for use outside portal.
int	getActionType() Returns the action type.
long	getDueDate() Deprecated. use getDueDateAsLong instead Returns the foreseen due date as long. Returns -1 if there is no defined due date.
long	getDueDateAsLong() Returns the foreseen due date as long.
IGPNotificationInstance	getDueDateNotification() Returns the foreseen due date.
Enumeration	getNotificationInstances() Returns the notifications belonging to this Action instance.
IUser	getProcessor() Returns the processor (user uniqueId) of the given action depending on the status of the action; if the action is in status active, the method will return null, as no processor is assigned; If the action type is background(getActionType()==IGPActionInstance.TYPE_BACKGROUND) this method will return null.
String	getProcessorRoleTechname() Returns the unique technical name from the process role for this action
GPActionInstanceStatus	getStatus() Returns the status as an GPActionInstanceStatus object.
boolean	isSingleTaskUI() Returns true, if the action is suitable for displaying in single task UI (depending on its status and type), otherwise false

Methods inherited from interface com.sap.caf.eu.gp.process.api.IGPActivityInstance

getActualDuration, getActualEndDate, getActualStartDate, getID, getInputContext, getOutputContext, getParentBlock, getParentProcess, getTemplate, isAction, isBlock

Field Detail

TYPE_INVALID

static final int TYPE_INVALID

Type of an action

TYPE_BACKGROUND

static final int TYPE_BACKGROUND

Type of an action

TYPE_UI

static final int TYPE_UI

Type of an action

Method Detail

getActionType

int getActionType()

Returns the action type. Also IActionTypesInformation class can be used for more action type information.

Returns:

int

getProcessor

IUser getProcessor()

Returns the processor (user uniqueId) of the given action depending on the status of the action; if the action is in status active, the method will return null, as no processor is assigned; If the action type is background(getActionType()==IGPActionInstance.TYPE_BACKGROUND) this method will return null. if the action is in status in process, someone has chosen to process the action and a user will be returned by the method; if the action is in status completed or error a user will be returned. 1) depending on action type getProcessor() | getActionType() ......................................... NULL IGPActionInstance.TYPE_BACKGROUND NULL IGPActionInstance.TYPE_INVALID DEPENDS ON STATUS IGPActionInstance.TYPE_UI 2) depending on action status getProcessor() | getStatus() ......................................... NULL IGPActivityInstance.STATUS_INVALID NULL IGPActivityInstance.STATUS_ACTIVE NULL IGPActivityInstance.STATUS_RUNNING MAY BE NULL IGPActivityInstance.STATUS_CANCELLED NOT NULL IGPActivityInstance.STATUS_COMPLETED NOT NULL IGPActivityInstance.STATUS_ERROR NOT NULL IGPActionInstance.STATUS_IN_PROCESS) NULL IGPActivityInstance.STATUS_FUTURE NULL IGPActivityInstance.STATUS_SKIPPED

Returns:

IUser may be null;

getDueDate

long getDueDate()

Deprecated. use getDueDateAsLong instead Returns the foreseen due date as long. Returns -1 if there is no defined due date.

Returns:

long

getDueDateAsLong

long getDueDateAsLong()
                      throws GPEngineException

Returns the foreseen due date as long. Returns -1 if there is no defined due date.

Returns:

long

Throws:

GPEngineException

getDueDateNotification

IGPNotificationInstance getDueDateNotification()
                                               throws GPEngineException

Returns the foreseen due date. Returns null if there is no defined due date.

Returns:

long

Throws:

GPEngineException

getNotificationInstances

Enumeration getNotificationInstances()
                                     throws GPEngineException

Returns the notifications belonging to this Action instance.

Returns:

long

Throws:

GPEngineException

getProcessorRoleTechname

String getProcessorRoleTechname()

Returns the unique technical name from the process role for this action

Returns:

processRole identifier - can be null, if no ProcessRole is assigned to the action

isSingleTaskUI

boolean isSingleTaskUI()
                       throws GPEngineException

Returns true, if the action is suitable for displaying in single task UI (depending on its status and type), otherwise false

Throws:

GPEngineException

generateNavigationTargetForSingleTaskUI

String generateNavigationTargetForSingleTaskUI()
                                               throws GPEngineException

Returns the portal navigation target for single task UI.

Throws:

GPEngineException

generateBusinessParametersForSingleTaskUI

String generateBusinessParametersForSingleTaskUI()
                                                 throws GPEngineException

Returns the portal navigation business parameters for single task UI.

Throws:

GPEngineException

generateStandaloneURLForSingleTaskUI

String generateStandaloneURLForSingleTaskUI()
                                            throws GPEngineException

Returns the single task UI application URL for use outside portal.

Throws:

GPEngineException

getStatus

GPActionInstanceStatus getStatus()

Returns the status as an GPActionInstanceStatus object.

Returns:

GPActionInstanceStatus