Skip navigation links

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

All Known Subinterfaces:

Task

public interface TaskType

Method Summary

boolean	addAllAttachments(java.util.List types)
boolean	addAttachment(AttachmentType type)
void	addUserComment(CommentType type)
java.util.List	getAttachment()
CallbackType	getCallback()
java.lang.String	getCreator()
java.lang.String	getIdentificationKey()
java.lang.String	getIdentityContext()
java.lang.String	getOwnerGroup()
java.lang.String	getOwnerUser()
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.
int	getPriority()
ProcessType	getProcessInfo()
SystemAttributesType	getSystemAttributes()
SystemMessageAttributesType	getSystemMessageAttributes()
java.lang.String	getTaskDefinitionURI()
java.lang.String	getTitle()
java.lang.String	getTitleResourceKey()
java.util.List	getUserComment()
boolean	removeAllAttachment()
void	removeAllUserComment()
boolean	removeAttachment(AttachmentType removeType)
AttachmentType	removeAttachment(int index)
boolean	removeAttachment(java.lang.String attName)
void	setCallback(CallbackType value)
void	setCreator(java.lang.String value)
void	setIdentificationKey(java.lang.String value)
void	setIdentityContext(java.lang.String value)
void	setOwnerGroup(java.lang.String value)
void	setOwnerUser(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	setPriority(int value)
void	setProcessInfo(ProcessType value)
void	setSystemAttributes(SystemAttributesType value)
void	setSystemMessageAttributes(SystemMessageAttributesType value)
void	setTaskDefinitionURI(java.lang.String value)
void	setTitle(java.lang.String value)
void	setTitleResourceKey(java.lang.String value)
boolean	updateAttachment(AttachmentType type)

Method Detail

setTitle

public void setTitle(java.lang.String value)

getTitle

public java.lang.String getTitle()

setPayload

public 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.

Returns:

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

See Also:

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

getPayload

public 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

public void setTaskDefinitionURI(java.lang.String value)

getTaskDefinitionURI

public java.lang.String getTaskDefinitionURI()

setCreator

public void setCreator(java.lang.String value)

getCreator

public java.lang.String getCreator()

setOwnerUser

public void setOwnerUser(java.lang.String value)

getOwnerUser

public java.lang.String getOwnerUser()

setOwnerGroup

public void setOwnerGroup(java.lang.String value)

getOwnerGroup

public java.lang.String getOwnerGroup()

setPriority

public void setPriority(int value)

getPriority

public int getPriority()

setIdentityContext

public void setIdentityContext(java.lang.String value)

getIdentityContext

public java.lang.String getIdentityContext()

getUserComment

public java.util.List getUserComment()

getAttachment

public java.util.List getAttachment()

setProcessInfo

public void setProcessInfo(ProcessType value)

getProcessInfo

public ProcessType getProcessInfo()

setSystemAttributes

public void setSystemAttributes(SystemAttributesType value)

getSystemAttributes

public SystemAttributesType getSystemAttributes()

setSystemMessageAttributes

public void setSystemMessageAttributes(SystemMessageAttributesType value)

getSystemMessageAttributes

public SystemMessageAttributesType getSystemMessageAttributes()

setTitleResourceKey

public void setTitleResourceKey(java.lang.String value)

getTitleResourceKey

public java.lang.String getTitleResourceKey()

setCallback

public void setCallback(CallbackType value)

getCallback

public CallbackType getCallback()

setIdentificationKey

public void setIdentificationKey(java.lang.String value)

getIdentificationKey

public java.lang.String getIdentificationKey()

removeAttachment

public boolean removeAttachment(AttachmentType removeType)

removeAttachment

public boolean removeAttachment(java.lang.String attName)

removeAttachment

public AttachmentType removeAttachment(int index)

removeAllAttachment

public boolean removeAllAttachment()

addAllAttachments

public boolean addAllAttachments(java.util.List types)

addAttachment

public boolean addAttachment(AttachmentType type)

updateAttachment

public boolean updateAttachment(AttachmentType type)

addUserComment

public void addUserComment(CommentType type)

removeAllUserComment

public void removeAllUserComment()

getPayloadAsElement

public 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

public 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

Skip navigation links