Class DocumentUpdate

  extended by
      extended by 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.

Kuali Rice Team (
See Also:
WorkflowDocumentFactory, WorkflowDocumentImpl, WorkflowDocumentImpl.ModifiableDocument, WorkflowDocumentActionsServiceImpl, 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
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


public String getTitle()


public String getApplicationDocumentId()


public String getApplicationDocumentStatus()


public Map<String,String> getVariables()

Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.