com.sap.bpm.tm.api

Interface TaskAbstract

All Known Subinterfaces:

TaskDetail

public interface TaskAbstract

A basic representation of a task instance suitable to populate a task list.
Texts are resolved in the language of the authenticated user if available, otherwise in the default language.

NOTE: As this interface can be extended, this interface can be freely used, but must not be implemented.

SAP API Classification:

This interface is intended to be used only and may not be implemented by client code.

Method Summary

boolean	completeByTimeExists()
Date	getActivationTime() Activation time (UTC)
int	getAttachmentCount() Returns the number of attachments for the task instance.
Date	getCompleteByTime() Completion deadline (UTC)
Date	getCompletedTime() Returns the time when the task was completed.
Date	getCreatedTime() Creation time (UTC)
Map<String,Object>	getCustomAttributeValues() Gets the task custom attribute values
URI	getDefinitionId() The task definition id of this TaskAbstract instance.
URI	getDefintionId() Deprecated. Use getDefinitionId() to get the task definition id of this TaskAbstract instance.
String	getDescription()
Date	getExpirationTime() Expiration time (UTC)
URI	getId() The task instance id
URI	getModelId() The task model id of this TaskAbstract instance.
String	getName()
String	getPresentationName() Deprecated. This method has been replaced by getSubject().
String	getPresentationSubject() Deprecated. This method has been replaced by getDescription().
Priority	getPriority()
Date	getStartByTime() Start deadline (UTC)
Status	getStatus()
String	getSubject()
IUser	getTaskInitiator()
String	getTaskType()
boolean	isEscalated()
boolean	startByTimeExists()

Method Detail

getId

URI getId()

The task instance id

Returns:

id, must be set

getDefintionId

@Deprecated
URI getDefintionId()

Deprecated. Use getDefinitionId() to get the task definition id of this TaskAbstract instance.

The task definition id.

Returns:

id, must be set

getDefinitionId

URI getDefinitionId()

The task definition id of this TaskAbstract instance.

Returns:

id, the definition id of this TaskAbstract instance

getModelId

URI getModelId()

The task model id of this TaskAbstract instance.

Returns:

id, the model id of this TaskAbstract instance

getTaskType

String getTaskType()

Returns:

task type, must be set

getName

String getName()

Returns:

name, must be set

getSubject

String getSubject()

Returns:

subject, may return null

getDescription

String getDescription()

Returns:

description, may return null

getStatus

Status getStatus()

Returns:

status, must be set

getPriority

Priority getPriority()

Returns:

priority

getCreatedTime

Date getCreatedTime()

Creation time (UTC)

Returns:

creation time, must be set

getActivationTime

Date getActivationTime()

Activation time (UTC)

Returns:

activation time, may return null

getExpirationTime

Date getExpirationTime()

Expiration time (UTC)

Returns:

expiration time, may return null

getCompletedTime

Date getCompletedTime()

Returns the time when the task was completed.

Returns:

Completed time if the task is completed
Null if the task is not completed.

getCompleteByTime

Date getCompleteByTime()

Completion deadline (UTC)

Returns:

complete by time, may return null

getStartByTime

Date getStartByTime()

Start deadline (UTC)

Returns:

start by time, may return null

startByTimeExists

boolean startByTimeExists()

Returns:

start by time exists

completeByTimeExists

boolean completeByTimeExists()

Returns:

complete by time exists

getPresentationName

@Deprecated
String getPresentationName()

Deprecated. This method has been replaced by getSubject().

Returns:

presentation name

getPresentationSubject

@Deprecated
String getPresentationSubject()

Deprecated. This method has been replaced by getDescription().

Returns:

presentation subject

isEscalated

boolean isEscalated()

Returns:

is escalated

getCustomAttributeValues

Map<String,Object> getCustomAttributeValues()

Gets the task custom attribute values

Returns:

the map of task custom attributes with key(s) as the name of the attribute defined.

getTaskInitiator

IUser getTaskInitiator()

Returns:

task initiator as IUser

getAttachmentCount

int getAttachmentCount()

Returns the number of attachments for the task instance.

Returns:

Returns the number of attachments for the task instance

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] BPEM-FACADE	[sap.com] tc/bpem/facade/ear	-	BC-BMT-BPM-DSK
[sap.com] BPEM-FACADE	[sap.com] tc/bpem/facade/ear	api	BC-BMT-BPM-DSK