This is the Document interface. All entities that are regarded as "eDocs" in the system, including Maintenance documents and
Transaction Processing documents should implement this interface as it defines methods that are necessary to interact with the
underlying frameworks and components (i.e. attachments, workflow, etc).
populateDocumentForRouting() This is the method to integrate with workflow, where we will actually populate the workflow defined data structure(s) so that
workflow can routed based on this data.
processAfterRetrieve() This method provides a hook that will be called after a document is retrieved, but before it is returned from the
DocumentService.
serializeDocumentToXml() This is a method where we can get the xml of a document that the workflow system will use to base it's routing and search
attributes on.
getter method to get the list of ad hoc route persons associated with a document at a point in time, this list is only valid
for a given users version of a document as this state is only persisted in workflow itself when someone takes an action on a
document
getter method to get the list of ad hoc route workgroups associated with a document at a point in time, this list is only
valid for a given users version of a document as this state is only persisted in workflow itself when someone takes an action
on a document
This is a helper to return BO for use by notes, it allows both maintenance and transactional to have consistent
notes paths without the tag or action knowing what kind of document they are
"this" unless overriden
This retrieves the standard DocumentHeader object, which contains standard meta-data about a document.
document header since all docs will have a document header
All documents have a document header id. This is the quick accessor to that unique identifier and should return the same
value as documentHeader.getDocumentHeaderId().
doc header id
This method is used to get the xml that should be used in a Route Report. In it's default implementation this will call the
methods prepareForSave() and populateDocumentForRouting().
This is the method to integrate with workflow, where we will actually populate the workflow defined data structure(s) so that
workflow can routed based on this data. This method is responsible for passing over the proper Kuali (client system) data
that will be used by workflow to determine how the document is actually routed.
This method provides a hook that will be called before the document is saved. This method is useful for applying document
level data to children. For example, if someone changes data at the document level, and that data needs to be propagated to
child objects or child lists of objects, you can use this method to update the child object or iterate through the list of
child objects and apply the document level data to them. Any document that follows this paradigm will need to make use of
this method to apply all of those changes.
This is a method where we can get the xml of a document that the workflow system will use to base it's routing and search
attributes on.
the document serialized to an xml string
setAdHocRoutePersons
public void setAdHocRoutePersons(List adHocRoutePersons)(Code)
setter method to set the list of ad hoc route persons associated with a document at a point in time, this list is only valid
for a given users version of a document as this state is only persisted in workflow itself when someone takes an action on a
document
Parameters: adHocRoutePersons -
setAdHocRouteWorkgroups
public void setAdHocRouteWorkgroups(List adHocRouteWorkgroups)(Code)
setter method to set the list of ad hoc route workgroups associated with a document at a point in time, this list is only
valid for a given users version of a document as this state is only persisted in workflow itself when someone takes an action
on a document
Parameters: adHocRouteWorkgroups -
Sends document off to the rules engine to verify business rules.
Parameters: document - - document to validate Parameters: event - - indicates which document event was requested throws: ValidationException - - containing the MessageMap from the validation session.