Document

Name Document
Usage WorkflowDocumentActionsService DocumentSecurityHandlerService PeopleFlowTypeService
create delete getDocument resolveRoleQualifiers
DocumentActionResult DocumentDetail DocumentSearchResult DocumentSecurityDirective
Type Complex

Description

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
documentId Document Id String Retrieve the document id Required   One No  
status Status DocumentStatus Retrieve the document status Required   One No  
dateCreated Date Created DateTime Retrieve the document creation date Required   One No  
dateLastModified Date Last Modified DateTime Retrieve the document last-modified date Required   One No  
dateApproved Date Approved DateTime Retrieve the document approval date     One No  
dateFinalized Date Finalized DateTime Retrieve the document finalization date     One No  
title Title String Retrieve the document title     One No  
applicationDocumentId Application Document Id String Retrieve the application document id. The Application Document Id is used to record an application-relevant
id for the workflow document.		     One No  
initiatorPrincipalId Initiator Principal Id String Retrieve the initiator principal id Required   One No  
routedByPrincipalId Routed By Principal Id String Retrieve the router principal id     One No  
documentTypeName Document Type Name String Retrieve the name of the type of this document Required   One No  
documentTypeId Document Type Id String Retrieve the id of the type of this document Required   One No  
documentHandlerUrl Document Handler Url String Retrieve the document handler url     One No  
applicationDocumentStatus Application Document Status String Retrieve the application document status. The Application Document Status is used
to track document/applicaiton specific statuses		     One No  
applicationDocumentStatusDate Application Document Status Date DateTime Retrieve the last application document status transition date. The Application Document Status date is
the date the application document status last transitioned.		     One No  
variables Variables Map Retrieve the currently defined internal workflow engine variables for the document
NOTE: use of workflow engine variables is an advanced technique requiring specific crafting of the
workflow document routing; these variables will not be useful for the majority of workflow use cases		     One No