oracle.bpel.services.workflow.task.model
Interface TaskType

All Known Subinterfaces:

Task

public interface TaskType

Method Summary

boolean	addAllAttachments(java.util.List types)
boolean	addAllDocuments(java.util.List types)
boolean	addAttachment(AttachmentType type)
boolean	addDocument(oracle.bpel.services.workflow.task.model.DocumentType type)
void	addUserComment(CommentType type)
java.lang.String	getApplicationContext()
java.util.List	getAttachment()
CallbackType	getCallback()
java.lang.String	getCategory()
java.lang.Object	getCollationKey(java.lang.String attrName, java.util.Locale locale) Gets collation keys for give attribute name
java.lang.String	getCorrelationId()
java.lang.String	getCreator()
java.lang.String	getCreatorDisplayName()
CustomAttributesType	getCustomAttributes()
java.util.List	getDocument()
java.lang.String	getDocumentPackageId()
java.util.Calendar	getDueDate()
EvidenceType	getEvidence()
java.lang.String	getIdentificationKey()
java.lang.String	getIdentityContext()
java.lang.String	getMdsLabel()
java.lang.String	getOwnerGroup()
java.lang.String	getOwnerGroupDisplayName()
java.lang.String	getOwnerRole()
java.lang.String	getOwnerRoleDisplayName()
java.lang.String	getOwnerUser()
java.lang.String	getOwnerUserDisplayName()
AnyType	getPayload() The AnyType object contains a list that represents each message attribute as an XML element This list in the AnyType object is unmodifiable.
org.w3c.dom.Element	getPayloadAsElement() Get the task payload as an XML element.
double	getPercentageComplete()
int	getPriority()
ProcessType	getProcessInfo()
ScaType	getSca()
java.lang.String	getServerDisplayName() Gets server display name according to client locale.
java.lang.String	getServerName() Gets server name
java.util.Calendar	getStartDate()
java.lang.String	getSubCategory()
SystemAttributesType	getSystemAttributes()
SystemMessageAttributesType	getSystemMessageAttributes()
java.lang.String	getTaskDefinitionId()
java.lang.String	getTaskDefinitionURI() Deprecated. As of release 11.*, replaced by getTaskDefinitionId()
java.lang.String	getTaskDisplayUrl()
java.util.List	getTaskErrors() Get the transient task errors.
java.lang.String	getTitle()
java.lang.String	getTitleResourceKey()
java.util.List	getUserComment()
boolean	hasAttachmentsChanged() Have attachments have changed
boolean	hasCommentsChanged() Has comments been added
boolean	hasDocumentsChanged() Have documents changed
boolean	isIsPublic()
boolean	removeAllAttachment()
void	removeAllUserComment()
boolean	removeAttachment(AttachmentType removeType)
AttachmentType	removeAttachment(int index)
boolean	removeAttachment(java.lang.String attName)
boolean	removeDocument(oracle.bpel.services.workflow.task.model.DocumentType removeType)
boolean	removeDocument(java.lang.String docName)
void	setApplicationContext(java.lang.String value)
void	setCallback(CallbackType value)
void	setCategory(java.lang.String value)
void	setCollationKey(java.lang.String attrName, java.util.Locale locale, java.lang.Object key) Sets collation key
void	setCorrelationId(java.lang.String value)
void	setCreator(java.lang.String value)
void	setCreatorDisplayName(java.lang.String value)
void	setCustomAttributes(CustomAttributesType value)
void	setDocumentPackageId(java.lang.String value)
void	setDueDate(java.util.Calendar value)
void	setEvidence(EvidenceType value)
void	setIdentificationKey(java.lang.String value)
void	setIdentityContext(java.lang.String value)
void	setIsPublic(boolean value)
void	setMdsLabel(java.lang.String label)
void	setOwnerGroup(java.lang.String value)
void	setOwnerGroupDisplayName(java.lang.String value)
void	setOwnerRole(java.lang.String value)
void	setOwnerRoleDisplayName(java.lang.String value)
void	setOwnerUser(java.lang.String value)
void	setOwnerUserDisplayName(java.lang.String value)
void	setPayload(AnyType value) The AnyType object contains a list that represents each message attribute as an XML element This list in the AnyType object is unmodifiable.
void	setPayloadAsElement(org.w3c.dom.Element payload) Task payload could contain multiple payload message attributes.
void	setPercentageComplete(double value)
void	setPriority(int value) Priority cannot be less than 1.
void	setProcessInfo(ProcessType value)
void	setSca(ScaType value)
void	setServerDisplayName(java.lang.String serverDisplayName) Sets server display name
void	setServerName(java.lang.String serverName) Sets server name
void	setStartDate(java.util.Calendar value)
void	setSubCategory(java.lang.String value)
void	setSystemAttributes(SystemAttributesType value)
void	setSystemMessageAttributes(SystemMessageAttributesType value)
void	setTaskDefinitionId(java.lang.String value)
void	setTaskDefinitionURI(java.lang.String value) Deprecated. As of release 11.*, replaced by setTaskDefinitionId(java.lang.String)
void	setTaskDisplayUrl(java.lang.String value)
void	setTitle(java.lang.String value)
void	setTitleResourceKey(java.lang.String value)
boolean	updateAttachment(AttachmentType type)
boolean	updateDocument(oracle.bpel.services.workflow.task.model.DocumentType type)

Method Detail

setTitle

void setTitle(java.lang.String value)

getTitle

java.lang.String getTitle()

setPayload

void setPayload(AnyType value)

The AnyType object contains a list that represents each message attribute as an XML element This list in the AnyType object is unmodifiable. Please use the setPayloadAsElement method to set the payload.

See Also:

setPayloadAsElement(org.w3c.dom.Element payload), getPayloadAsElement()

getPayload

AnyType getPayload()

The AnyType object contains a list that represents each message attribute as an XML element This list in the AnyType object is unmodifiable. Please use the setPayloadAsElement method to set the payload.

Returns:

an oracle.bpel.services.workflow.task.model.AnyType value

See Also:

setPayloadAsElement(org.w3c.dom.Element payload), getPayloadAsElement()

setTaskDefinitionURI

void setTaskDefinitionURI(java.lang.String value)

Deprecated. As of release 11.*, replaced by setTaskDefinitionId(java.lang.String)

getTaskDefinitionURI

java.lang.String getTaskDefinitionURI()

Deprecated. As of release 11.*, replaced by getTaskDefinitionId()

setCreator

void setCreator(java.lang.String value)

getCreator

java.lang.String getCreator()

setTaskDisplayUrl

void setTaskDisplayUrl(java.lang.String value)

getTaskDisplayUrl

java.lang.String getTaskDisplayUrl()

setDocumentPackageId

void setDocumentPackageId(java.lang.String value)

getDocumentPackageId

java.lang.String getDocumentPackageId()

setOwnerUser

void setOwnerUser(java.lang.String value)

getOwnerUser

java.lang.String getOwnerUser()

setOwnerGroup

void setOwnerGroup(java.lang.String value)

getOwnerGroup

java.lang.String getOwnerGroup()

setOwnerRole

void setOwnerRole(java.lang.String value)

getOwnerRole

java.lang.String getOwnerRole()

setPriority

void setPriority(int value)

Priority cannot be less than 1. If it is less than 1 then it will be defaulted to 1

getPriority

int getPriority()

setIdentityContext

void setIdentityContext(java.lang.String value)

getIdentityContext

java.lang.String getIdentityContext()

getUserComment

java.util.List getUserComment()

getAttachment

java.util.List getAttachment()

getDocument

java.util.List getDocument()

setProcessInfo

void setProcessInfo(ProcessType value)

getProcessInfo

ProcessType getProcessInfo()

setSystemAttributes

void setSystemAttributes(SystemAttributesType value)

getSystemAttributes

SystemAttributesType getSystemAttributes()

setSystemMessageAttributes

void setSystemMessageAttributes(SystemMessageAttributesType value)

getSystemMessageAttributes

SystemMessageAttributesType getSystemMessageAttributes()

setTitleResourceKey

void setTitleResourceKey(java.lang.String value)

getTitleResourceKey

java.lang.String getTitleResourceKey()

setCallback

void setCallback(CallbackType value)

getCallback

CallbackType getCallback()

setIdentificationKey

void setIdentificationKey(java.lang.String value)

getIdentificationKey

java.lang.String getIdentificationKey()

setCategory

void setCategory(java.lang.String value)

getCategory

java.lang.String getCategory()

setStartDate

void setStartDate(java.util.Calendar value)

getStartDate

java.util.Calendar getStartDate()

setDueDate

void setDueDate(java.util.Calendar value)

getDueDate

java.util.Calendar getDueDate()

setIsPublic

void setIsPublic(boolean value)

isIsPublic

boolean isIsPublic()

setPercentageComplete

void setPercentageComplete(double value)

getPercentageComplete

double getPercentageComplete()

setSca

void setSca(ScaType value)

getSca

ScaType getSca()

setApplicationContext

void setApplicationContext(java.lang.String value)

getApplicationContext

java.lang.String getApplicationContext()

setEvidence

void setEvidence(EvidenceType value)

getEvidence

EvidenceType getEvidence()

setTaskDefinitionId

void setTaskDefinitionId(java.lang.String value)

getTaskDefinitionId

java.lang.String getTaskDefinitionId()

setSubCategory

void setSubCategory(java.lang.String value)

getSubCategory

java.lang.String getSubCategory()

setCorrelationId

void setCorrelationId(java.lang.String value)

getCorrelationId

java.lang.String getCorrelationId()

setMdsLabel

void setMdsLabel(java.lang.String label)

getMdsLabel

java.lang.String getMdsLabel()

removeAttachment

boolean removeAttachment(AttachmentType removeType)

removeDocument

boolean removeDocument(oracle.bpel.services.workflow.task.model.DocumentType removeType)

removeAttachment

boolean removeAttachment(java.lang.String attName)

removeDocument

boolean removeDocument(java.lang.String docName)

removeAttachment

AttachmentType removeAttachment(int index)

removeAllAttachment

boolean removeAllAttachment()

addAllAttachments

boolean addAllAttachments(java.util.List types)

addAllDocuments

boolean addAllDocuments(java.util.List types)

addAttachment

boolean addAttachment(AttachmentType type)

addDocument

boolean addDocument(oracle.bpel.services.workflow.task.model.DocumentType type)

updateAttachment

boolean updateAttachment(AttachmentType type)

updateDocument

boolean updateDocument(oracle.bpel.services.workflow.task.model.DocumentType type)

addUserComment

void addUserComment(CommentType type)

removeAllUserComment

void removeAllUserComment()

setCreatorDisplayName

void setCreatorDisplayName(java.lang.String value)

getCreatorDisplayName

java.lang.String getCreatorDisplayName()

setOwnerUserDisplayName

void setOwnerUserDisplayName(java.lang.String value)

getOwnerUserDisplayName

java.lang.String getOwnerUserDisplayName()

setOwnerGroupDisplayName

void setOwnerGroupDisplayName(java.lang.String value)

getOwnerGroupDisplayName

java.lang.String getOwnerGroupDisplayName()

setOwnerRoleDisplayName

void setOwnerRoleDisplayName(java.lang.String value)

getOwnerRoleDisplayName

java.lang.String getOwnerRoleDisplayName()

setCustomAttributes

void setCustomAttributes(CustomAttributesType value)

getCustomAttributes

CustomAttributesType getCustomAttributes()

getPayloadAsElement

org.w3c.dom.Element getPayloadAsElement()

Get the task payload as an XML element. The returned element will have its root element with name "payload" in the namespace "http://xmlns.oracle.com/bpel/workflow/task". The payload XML element will in turn contain all the other XML elements in it. Each XML element defines a message attributes.

Returns:

an org.w3c.dom.Element value

setPayloadAsElement

void setPayloadAsElement(org.w3c.dom.Element payload)

Task payload could contain multiple payload message attributes. Since the payload is not well defined until the task definition, the Java object model for the task does not contain a strong type objects for the client payload. Task payload can be set from an XMLElement as shown below. Please note that the root element is of name "payload" in the namespace "http://xmlns.oracle.com/bpel/workflow/task". The payload XML element will in turn contain all the other XML elements in it. Each XML element defines a message attributes.

import oracle.bpel.services.workflow.task.model.AnyType;
import oracle.bpel.services.workflow.task.model.ObjectFactory;
import oracle.bpel.services.workflow.task.model.Task;
....

Document document = //createXMLDocument
Element payloadElem = document.createElementNS("http://xmlns.oracle.com/bpel/workflow/task", "payload");
Element orderElem = document.createElementNS("http://xmlns.oracle.com/pcbpel/test/order", "order");
Element child = document.createElementNS("http://xmlns.oracle.com/pcbpel/test/order", "id");
child.appendChild(document.createTextNode("1234567"));
orderElem.appendChild(child);
payloadElem.appendChild(orderElem);
document.appendChild(payloadElem);

task.setPayloadAsElement(payloadElem);

Parameters:

payload - an org.w3c.dom.Element value

hasAttachmentsChanged

boolean hasAttachmentsChanged()

Have attachments have changed

Returns:

a boolean value

hasDocumentsChanged

boolean hasDocumentsChanged()

Have documents changed

Returns:

a boolean value

hasCommentsChanged

boolean hasCommentsChanged()

Has comments been added

Returns:

a boolean value

getTaskErrors

java.util.List getTaskErrors()

Get the transient task errors. This is used internally by the workflow service. This method will return empty list if used by clients

Returns:

a List value

getServerName

java.lang.String getServerName()

Gets server name

Returns:

server name

setServerName

void setServerName(java.lang.String serverName)

Sets server name

Parameters:

serverName -

getServerDisplayName

java.lang.String getServerDisplayName()

Gets server display name according to client locale.

Returns:

server display name

setServerDisplayName

void setServerDisplayName(java.lang.String serverDisplayName)

Sets server display name

Parameters:

serverDisplayName -

getCollationKey

java.lang.Object getCollationKey(java.lang.String attrName,
                                 java.util.Locale locale)

Gets collation keys for give attribute name

Parameters:

attrName - an attribute name

locale - a Locale

Returns:

CollatinKey for given attrName

setCollationKey

void setCollationKey(java.lang.String attrName,
                     java.util.Locale locale,
                     java.lang.Object key)

Sets collation key

Parameters:

attrName - an attribute name

locale - a Locale