org.kuali.rice.kew.api.document
Class DocumentUpdate

java.lang.Object
  org.kuali.rice.kew.api.document.DocumentUpdate

All Implemented Interfaces:

Serializable

public final class DocumentUpdate
extends Object
implements Serializable

Defines an update to document content on a particular workflow document. Contains general application content as well as a list of attribute definitions and searchable definitions. When passed to the appropriate workflow services to perform an update on document content, if any of the internal content or definitions on this object have not been set then they will not be updated. This allows for this data structure to be used to only update the portion of the document content that is desired to be updated.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

static class	DocumentUpdate.Builder A builder which can be used to construct DocumentUpdate instances.
(package private) static class	DocumentUpdate.Constants Defines some internal constants used on this class.
(package private) static class	DocumentUpdate.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Field Summary

private Collection<Element>	_futureElements
private String	applicationDocumentId
private String	applicationDocumentStatus
private static long	serialVersionUID
private String	title
private Map<String,String>	variables

Constructor Summary

private	DocumentUpdate()
private	DocumentUpdate(DocumentUpdate.Builder builder)

Method Summary

boolean	equals(Object object)
String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
String	getTitle()
Map<String,String>	getVariables()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

title

private final String title

applicationDocumentId

private final String applicationDocumentId

applicationDocumentStatus

private final String applicationDocumentStatus

variables

private final Map<String,String> variables

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

DocumentUpdate

private DocumentUpdate()

DocumentUpdate

private DocumentUpdate(DocumentUpdate.Builder builder)

Method Detail

getTitle

public String getTitle()

getApplicationDocumentId

public String getApplicationDocumentId()

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

getVariables

public Map<String,String> getVariables()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object