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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.document.DocumentUpdate

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete

public final class DocumentUpdate
extends AbstractDataTransferObject

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.

Method Summary

String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
String	getTitle()
Map<String,String>	getVariables()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

getTitle

public String getTitle()

getApplicationDocumentId

public String getApplicationDocumentId()

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

getVariables

public Map<String,String> getVariables()