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 meta-data on a particular workflow document, including title, application document id, application document status, and routing branch variables. This structure is used to convey changes to the document meta-data on document actions, and to retrieve their state afterwards. Document titles will be truncated to to KewApiConstants.TITLE_MAX_LENGTH length.

Author:

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

See Also:

WorkflowDocumentFactory, WorkflowDocumentImpl, WorkflowDocumentImpl.ModifiableDocument, WorkflowDocumentActionsServiceImpl, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentUpdate.Builder A builder which can be used to construct DocumentUpdate instances.

Method Summary

Modifier and Type	Method and Description
String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
List<String>	getDirtyFields()
String	getTitle()
Map<String,String>	getVariables()

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

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, 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()

getDirtyFields

public List<String> getDirtyFields()