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

Interface IGPActivityInstance

All Known Subinterfaces:

IGPActionInstance, IGPBlockInstance, IGPProcessInstance

public interface IGPActivityInstance

Method Summary

long	getActualDuration() Returns the Actual Duration of this activiy instance.
Date	getActualEndDate() Returns the date when this activity Instance actually has been completed.
Date	getActualStartDate() Returns the date when this activity Instance actually was started.
String	getID() Returns the ID.
IGPStructure	getInputContext() Returns input context for this activity instance The result will always contain the structure of the instance's context.
IGPStructure	getOutputContext() Returns output context for this activity instance The result will always contain the structure of the instance's context.
IGPBlockInstance	getParentBlock() Returns the parent block of this activity.
IGPProcessInstance	getParentProcess() Returns the parent process of this activity.
IGPActivity	getTemplate() Returns the corresponding template object.
boolean	isAction() Return true if it is an action.
boolean	isBlock() Return true if it is a block.

Method Detail

getID

String getID()

Returns the ID.

Returns:

String

isAction

boolean isAction()

Return true if it is an action.

Returns:

boolean

isBlock

boolean isBlock()

Return true if it is a block.

Returns:

boolean

getTemplate

IGPActivity getTemplate()
                        throws GPEngineException

Returns the corresponding template object.

Returns:

IGPActivity NOT NULL

Throws:

GPEngineException

getParentBlock

IGPBlockInstance getParentBlock()

Returns the parent block of this activity.

Returns:

IGPBlockInstance may be NULL

getParentProcess

IGPProcessInstance getParentProcess()

Returns the parent process of this activity.

Returns:

IGPProcessInstance may be NULL

getActualEndDate

Date getActualEndDate()
                      throws GPEngineException

Returns the date when this activity Instance actually has been completed.

Returns:

Date MAY BE NULL

Throws:

GPEngineException

getActualDuration

long getActualDuration()
                       throws GPEngineException

Returns the Actual Duration of this activiy instance. Returns 0 when start and end date are null. When the end date is null but the startdate is not null returns subtraction of start date in milis from current date in milis.

Returns:

long - the ActualDuration in milliseconds.

Throws:

GPEngineException

getActualStartDate

Date getActualStartDate()
                        throws GPEngineException

Returns the date when this activity Instance actually was started.

Returns:

Date MAY BE NULL

Throws:

GPEngineException

getInputContext

IGPStructure getInputContext()
                             throws GPEngineException

Returns input context for this activity instance The result will always contain the structure of the instance's context. If a parameter in the instance's context is NULL, the value of its attribute is empty

Returns:

IGPStructure

Throws:

GPEngineException

getOutputContext

IGPStructure getOutputContext()
                              throws GPEngineException

Returns output context for this activity instance The result will always contain the structure of the instance's context. If a parameter in the instance's context is NULL, the value of its attribute is empty

Returns:

Throws:

GPEngineException