Uses of Interface
org.kuali.rice.krad.document.Document

Packages that use Document

Package	Description
org.kuali.rice.krad.datadictionary
org.kuali.rice.krad.document
org.kuali.rice.krad.maintenance
org.kuali.rice.krad.rules
org.kuali.rice.krad.rules.rule
org.kuali.rice.krad.rules.rule.event
org.kuali.rice.krad.service
org.kuali.rice.krad.uif.view
org.kuali.rice.krad.util
org.kuali.rice.krad.util.documentserializer
org.kuali.rice.krad.web.controller
org.kuali.rice.krad.web.form
org.kuali.rice.krad.workflow

Uses of Document in org.kuali.rice.krad.datadictionary

Fields in org.kuali.rice.krad.datadictionary with type parameters of type Document

Modifier and Type	Field and Description
protected Class<? extends Document>	DocumentEntry.baseDocumentClass
protected Class<? extends Document>	DocumentEntry.documentClass

Methods in org.kuali.rice.krad.datadictionary that return types with arguments of type Document

Modifier and Type	Method and Description
Class<? extends Document>	DocumentEntry.getBaseDocumentClass()
Class<? extends Document>	DocumentEntry.getDocumentClass()
Class<? extends Document>	MaintenanceDocumentEntry.getStandardDocumentBaseClass()

Method parameters in org.kuali.rice.krad.datadictionary with type arguments of type Document

Modifier and Type	Method and Description
void	DocumentEntry.setBaseDocumentClass(Class<? extends Document> baseDocumentClass) The optional baseDocumentClass element is the name of the java base class associated with the document.
void	DocumentEntry.setDocumentClass(Class<? extends Document> documentClass) The documentClass element is the name of the java class associated with the document.

Uses of Document in org.kuali.rice.krad.document

Subinterfaces of Document in org.kuali.rice.krad.document

Modifier and Type	Interface and Description
interface	TransactionalDocument This is the TransactionalDocument interface.

Classes in org.kuali.rice.krad.document that implement Document

Modifier and Type	Class and Description
class	DocumentBase
class	TransactionalDocumentBase Controller that handles requests coming from a TransactionalDocumentView

Methods in org.kuali.rice.krad.document with parameters of type Document

Modifier and Type	Method and Description
protected void	DocumentViewAuthorizerBase.addStandardAttributes(Document document, Map<String,String> attributes)
protected void	DocumentAuthorizerBase.addStandardAttributes(Document document, Map<String,String> attributes)
boolean	DocumentViewPresentationControllerBase.canAcknowledge(Document document)
boolean	DocumentPresentationControllerBase.canAcknowledge(Document document)
boolean	DocumentPresentationController.canAcknowledge(Document document)
boolean	DocumentViewAuthorizerBase.canAcknowledge(Document document, Person user)
boolean	DocumentAuthorizerBase.canAcknowledge(Document document, Person user)
boolean	DocumentAuthorizer.canAcknowledge(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canAddAdhocRequests(Document document)
boolean	DocumentPresentationControllerBase.canAddAdhocRequests(Document document)
boolean	DocumentPresentationController.canAddAdhocRequests(Document document)
boolean	DocumentViewAuthorizerBase.canAddNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	DocumentAuthorizerBase.canAddNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	DocumentAuthorizer.canAddNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	DocumentViewPresentationControllerBase.canAnnotate(Document document)
boolean	DocumentPresentationControllerBase.canAnnotate(Document document)
boolean	DocumentPresentationController.canAnnotate(Document document)
boolean	DocumentViewAuthorizerBase.canAnnotate(Document document, Person user)
boolean	DocumentAuthorizerBase.canAnnotate(Document document, Person user)
boolean	DocumentAuthorizer.canAnnotate(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canApprove(Document document)
boolean	DocumentPresentationControllerBase.canApprove(Document document)
boolean	DocumentPresentationController.canApprove(Document document)
boolean	DocumentViewAuthorizerBase.canApprove(Document document, Person user)
boolean	DocumentAuthorizerBase.canApprove(Document document, Person user)
boolean	DocumentAuthorizer.canApprove(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canBlanketApprove(Document document)
boolean	DocumentPresentationControllerBase.canBlanketApprove(Document document)
boolean	DocumentPresentationController.canBlanketApprove(Document document)
boolean	DocumentViewAuthorizerBase.canBlanketApprove(Document document, Person user)
boolean	DocumentAuthorizerBase.canBlanketApprove(Document document, Person user)
boolean	DocumentAuthorizer.canBlanketApprove(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canCancel(Document document)
boolean	DocumentPresentationControllerBase.canCancel(Document document)
boolean	DocumentPresentationController.canCancel(Document document)
boolean	DocumentViewAuthorizerBase.canCancel(Document document, Person user)
boolean	DocumentAuthorizerBase.canCancel(Document document, Person user)
boolean	DocumentAuthorizer.canCancel(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canClose(Document document)
boolean	DocumentPresentationControllerBase.canClose(Document document)
boolean	DocumentPresentationController.canClose(Document document)
boolean	DocumentViewAuthorizerBase.canClose(Document document, Person user)
boolean	DocumentAuthorizerBase.canClose(Document document, Person user)
boolean	DocumentAuthorizer.canClose(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canComplete(Document document)
boolean	DocumentPresentationControllerBase.canComplete(Document document)
boolean	DocumentPresentationController.canComplete(Document document)
boolean	DocumentViewPresentationControllerBase.canCopy(Document document)
boolean	DocumentPresentationControllerBase.canCopy(Document document)
boolean	DocumentPresentationController.canCopy(Document document)
boolean	DocumentViewAuthorizerBase.canCopy(Document document, Person user)
boolean	DocumentAuthorizerBase.canCopy(Document document, Person user)
boolean	DocumentAuthorizer.canCopy(Document document, Person user)
boolean	DocumentViewAuthorizerBase.canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	DocumentAuthorizerBase.canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	DocumentAuthorizer.canDeleteNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	DocumentViewPresentationControllerBase.canDisapprove(Document document)
boolean	DocumentPresentationControllerBase.canDisapprove(Document document)
boolean	DocumentPresentationController.canDisapprove(Document document)
boolean	DocumentViewAuthorizerBase.canDisapprove(Document document, Person user)
boolean	DocumentAuthorizerBase.canDisapprove(Document document, Person user)
boolean	DocumentAuthorizer.canDisapprove(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canEdit(Document document)
boolean	DocumentPresentationControllerBase.canEdit(Document document)
boolean	DocumentPresentationController.canEdit(Document document)
boolean	DocumentViewAuthorizerBase.canEdit(Document document, Person user)
boolean	DocumentAuthorizerBase.canEdit(Document document, Person user)
boolean	DocumentAuthorizer.canEdit(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canEditDocumentOverview(Document document)
boolean	DocumentPresentationControllerBase.canEditDocumentOverview(Document document)
boolean	DocumentPresentationController.canEditDocumentOverview(Document document)
boolean	DocumentViewAuthorizerBase.canEditDocumentOverview(Document document, Person user)
boolean	DocumentAuthorizerBase.canEditDocumentOverview(Document document, Person user)
boolean	DocumentAuthorizer.canEditDocumentOverview(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canFyi(Document document)
boolean	DocumentPresentationControllerBase.canFyi(Document document)
boolean	DocumentPresentationController.canFyi(Document document)
boolean	DocumentViewAuthorizerBase.canFyi(Document document, Person user)
boolean	DocumentAuthorizerBase.canFyi(Document document, Person user)
boolean	DocumentAuthorizer.canFyi(Document document, Person user)
boolean	DocumentViewAuthorizerBase.canOpen(Document document, Person user)
boolean	DocumentAuthorizerBase.canOpen(Document document, Person user)
boolean	DocumentAuthorizer.canOpen(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canPerformRouteReport(Document document)
boolean	DocumentPresentationControllerBase.canPerformRouteReport(Document document)
boolean	DocumentPresentationController.canPerformRouteReport(Document document)
boolean	DocumentViewAuthorizerBase.canPerformRouteReport(Document document, Person user)
boolean	DocumentAuthorizerBase.canPerformRouteReport(Document document, Person user)
boolean	DocumentAuthorizer.canPerformRouteReport(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canRecall(Document document)
boolean	DocumentPresentationControllerBase.canRecall(Document document)
boolean	DocumentPresentationController.canRecall(Document document)
boolean	DocumentViewAuthorizerBase.canRecall(Document document, Person user)
boolean	DocumentAuthorizerBase.canRecall(Document document, Person user)
boolean	DocumentAuthorizer.canRecall(Document document, Person user)
boolean	DocumentViewAuthorizerBase.canReceiveAdHoc(Document document, Person user, String actionRequestCode)
boolean	DocumentAuthorizerBase.canReceiveAdHoc(Document document, Person user, String actionRequestCode)
boolean	DocumentAuthorizer.canReceiveAdHoc(Document document, Person user, String actionRequestCode)
boolean	DocumentViewPresentationControllerBase.canReload(Document document)
boolean	DocumentPresentationControllerBase.canReload(Document document)
boolean	DocumentPresentationController.canReload(Document document)
boolean	DocumentViewAuthorizerBase.canReload(Document document, Person user)
boolean	DocumentAuthorizerBase.canReload(Document document, Person user)
boolean	DocumentAuthorizer.canReload(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canRoute(Document document)
boolean	DocumentPresentationControllerBase.canRoute(Document document)
boolean	DocumentPresentationController.canRoute(Document document)
boolean	DocumentViewAuthorizerBase.canRoute(Document document, Person user)
boolean	DocumentAuthorizerBase.canRoute(Document document, Person user)
boolean	DocumentAuthorizer.canRoute(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canSave(Document document)
boolean	DocumentPresentationControllerBase.canSave(Document document)
boolean	DocumentPresentationController.canSave(Document document)
boolean	DocumentViewAuthorizerBase.canSave(Document document, Person user)
boolean	DocumentAuthorizerBase.canSave(Document document, Person user)
boolean	DocumentAuthorizer.canSave(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canSendAdhocRequests(Document document)
boolean	DocumentPresentationControllerBase.canSendAdhocRequests(Document document)
boolean	DocumentPresentationController.canSendAdhocRequests(Document document)
boolean	DocumentViewAuthorizerBase.canSendAdHocRequests(Document document, String actionRequestCd, Person user)
boolean	DocumentAuthorizerBase.canSendAdHocRequests(Document document, String actionRequestCd, Person user)
boolean	DocumentAuthorizer.canSendAdHocRequests(Document document, String actionRequestCd, Person user)
boolean	DocumentViewAuthorizerBase.canSendAnyTypeAdHocRequests(Document document, Person user)
boolean	DocumentAuthorizerBase.canSendAnyTypeAdHocRequests(Document document, Person user)
boolean	DocumentAuthorizer.canSendAnyTypeAdHocRequests(Document document, Person user)
boolean	DocumentViewPresentationControllerBase.canSendNoteFyi(Document document)
boolean	DocumentPresentationControllerBase.canSendNoteFyi(Document document)
boolean	DocumentPresentationController.canSendNoteFyi(Document document)
boolean	DocumentViewAuthorizerBase.canSendNoteFyi(Document document, Person user)
boolean	DocumentAuthorizerBase.canSendNoteFyi(Document document, Person user)
boolean	DocumentAuthorizer.canSendNoteFyi(Document document, Person user)
boolean	DocumentViewAuthorizerBase.canTakeRequestedAction(Document document, String actionRequestCode, Person user)
boolean	DocumentAuthorizerBase.canTakeRequestedAction(Document document, String actionRequestCode, Person user)
boolean	DocumentAuthorizer.canTakeRequestedAction(Document document, String actionRequestCode, Person user)
boolean	DocumentViewAuthorizerBase.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	DocumentAuthorizerBase.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
boolean	DocumentAuthorizer.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user)
protected boolean	DocumentViewAuthorizerBase.isDocumentInitiator(Document document, Person user)
protected boolean	DocumentAuthorizerBase.isDocumentInitiator(Document document, Person user)

Uses of Document in org.kuali.rice.krad.maintenance

Subinterfaces of Document in org.kuali.rice.krad.maintenance

Modifier and Type	Interface and Description
interface	MaintenanceDocument Common interface for all maintenance documents.

Classes in org.kuali.rice.krad.maintenance that implement Document

Modifier and Type	Class and Description
class	MaintenanceDocumentBase Document class for all maintenance documents which wraps the maintenance object in a Maintainable that is also used for various callbacks

Methods in org.kuali.rice.krad.maintenance with parameters of type Document

Modifier and Type	Method and Description
boolean	MaintenanceViewPresentationControllerBase.canBlanketApprove(Document document)
boolean	MaintenanceViewPresentationControllerBase.canSave(Document document)

Uses of Document in org.kuali.rice.krad.rules

Methods in org.kuali.rice.krad.rules with parameters of type Document

Modifier and Type	Method and Description
protected boolean	DocumentRuleBase.hasAdHocRouteCompletion(Document document, AdHocRouteRecipient adHocRouteRecipient) KULRICE-8760: check whether there is any other complete adhoc request on the given document
boolean	DocumentRuleBase.isAddHocRoutePersonValid(Document document, AdHocRoutePerson person) Verifies that the adHocRoutePerson's fields are valid - it does required and format checks.
boolean	DocumentRuleBase.isAddHocRouteWorkgroupValid(Document document, AdHocRouteWorkgroup workgroup) Verifies that the adHocRouteWorkgroup's fields are valid - it does required and format checks.
protected boolean	DocumentRuleBase.isAdHocRouteCompletionToInitiator(Document document, Person person, String actionRequestCode) KULRICE-7419: Adhoc route completion validation rule (should not route to initiator for completion) determine whether the document initiator is the same as the adhoc recipient for completion
protected boolean	DocumentRuleBase.isAdHocRouteRecipientsValid(Document document) Checks the adhoc route recipient list to ensure there are recipients or else throws an error that at least one recipient is required.
boolean	DocumentRuleBase.isDocumentAttributesValid(Document document, boolean validateRequired) Validates the document attributes against the data dictionary.
boolean	DocumentRuleBase.isDocumentOverviewValid(Document document) Verifies that the document's overview fields are valid - it does required and format checks.
boolean	DocumentRuleBase.processAddAdHocRoutePerson(Document document, AdHocRoutePerson adHocRoutePerson)
boolean	DocumentRuleBase.processAddAdHocRouteWorkgroup(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup)
boolean	DocumentRuleBase.processAddNote(Document document, Note note) Runs all business rules needed prior to adding a document note.
boolean	DocumentRuleBase.processCompleteDocument(Document document) Business rules check will include all save action rules and any custom rules required by the document specific rule implementation
protected boolean	DocumentRuleBase.processCustomAddAdHocRoutePersonBusinessRules(Document document, AdHocRoutePerson person) This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route person" event.
protected boolean	DocumentRuleBase.processCustomAddAdHocRouteWorkgroupBusinessRules(Document document, AdHocRouteWorkgroup workgroup) This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add ad hoc route workgroup" event.
protected boolean	DocumentRuleBase.processCustomAddNoteBusinessRules(Document document, Note note) This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "add document note" event.
protected boolean	DocumentRuleBase.processCustomCompleteDocumentBusinessRules(Document document) Hook method for deriving business rule classes to provide custom validations required during completion action
protected boolean	DocumentRuleBase.processCustomRouteDocumentBusinessRules(Document document) This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "route document" event.
protected boolean	DocumentRuleBase.processCustomSaveDocumentBusinessRules(Document document) This method should be overridden by children rule classes as a hook to implement document specific business rule checks for the "save document" event.
protected boolean	DocumentRuleBase.processCustomSendAdHocRequests(Document document)
boolean	MaintenanceDocumentRuleBase.processRouteDocument(Document document)
boolean	MaintenanceDocumentRule.processRouteDocument(Document document) Runs all business rules needed prior to routing.
boolean	DocumentRuleBase.processRouteDocument(Document document) Runs all business rules needed prior to routing.
boolean	MaintenanceDocumentRuleBase.processSaveDocument(Document document)
boolean	MaintenanceDocumentRule.processSaveDocument(Document document) Runs all business rules needed prior to saving.
boolean	DocumentRuleBase.processSaveDocument(Document document) Runs all business rules needed prior to saving.
boolean	DocumentRuleBase.processSendAdHocRequests(Document document)
protected boolean	MaintenanceDocumentRuleBase.validateDocumentStructure(Document document) This method makes sure the document itself is valid, and has the necessary fields populated to be routable.

Uses of Document in org.kuali.rice.krad.rules.rule

Methods in org.kuali.rice.krad.rules.rule with parameters of type Document

Modifier and Type	Method and Description
boolean	AddAdHocRoutePersonRule.processAddAdHocRoutePerson(Document document, AdHocRoutePerson adHocRoutePerson) This method is responsible for housing business rules that need to be checked before a document adHocRoutePerson is added to a document.
boolean	AddAdHocRouteWorkgroupRule.processAddAdHocRouteWorkgroup(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup) This method is responsible for housing business rules that need to be checked before a document adHocRouteWorkgroup is added to a document.
boolean	AddNoteRule.processAddNote(Document document, Note note) This method is responsible for housing business rules that need to be checked before a note is added to a document.
boolean	CompleteDocumentRule.processCompleteDocument(Document document)
boolean	RouteDocumentRule.processRouteDocument(Document document)
boolean	DocumentAuditRule.processRunAuditBusinessRules(Document document)
boolean	SaveDocumentRule.processSaveDocument(Document document)
boolean	SendAdHocRequestsRule.processSendAdHocRequests(Document document)

Uses of Document in org.kuali.rice.krad.rules.rule.event

Fields in org.kuali.rice.krad.rules.rule.event declared as Document

Modifier and Type	Field and Description
protected Document	KualiDocumentEventBase.document

Methods in org.kuali.rice.krad.rules.rule.event that return Document

Modifier and Type	Method and Description
Document	KualiDocumentEventBase.getDocument()
Document	KualiDocumentEvent.getDocument()

Methods in org.kuali.rice.krad.rules.rule.event with parameters of type Document

Modifier and Type	Method and Description
protected static String	KualiDocumentEventBase.getDocumentId(Document document) Provides null-safe access to the documentNumber of the given document.

Constructors in org.kuali.rice.krad.rules.rule.event with parameters of type Document

Constructor and Description
AddAdHocRoutePersonEvent(Document document, AdHocRoutePerson adHocRoutePerson) Constructs an AddAdHocRoutePersonEvent with the given document
AddAdHocRoutePersonEvent(String errorPathPrefix, Document document, AdHocRoutePerson adHocRoutePerson) Constructs an AddAdHocRoutePersonEvent with the specified errorPathPrefix, document, and adHocRoutePerson
AddAdHocRouteWorkgroupEvent(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup) Constructs an AddAdHocRouteWorkgroupEvent with the given document
AddAdHocRouteWorkgroupEvent(String errorPathPrefix, Document document, AdHocRouteWorkgroup adHocRouteWorkgroup) Constructs an AddAdHocRouteWorkgroupEvent with the specified errorPathPrefix, document, and adHocRouteWorkgroup
AddNoteEvent(Document document, Note note) Constructs an AddNoteEvent with the given document
AddNoteEvent(String errorPathPrefix, Document document, Note note) Constructs an AddNoteEvent with the specified errorPathPrefix and document
ApproveDocumentEvent(Document document) Constructs an ApproveDocumentEvent with the given document
ApproveDocumentEvent(String errorPathPrefix, Document document) Constructs an ApproveDocumentEvent with the specified errorPathPrefix and document
ApproveDocumentEvent(String eventType, String errorPathPrefix, Document document) Constructs a ApproveDocumentEvent, allowing the eventType to be passed in so that subclasses can specify a more accurate message.
BlanketApproveDocumentEvent(Document document) Constructs a BlanketApproveDocumentEvent with the given document
BlanketApproveDocumentEvent(String errorPathPrefix, Document document) Constructs an BlanketApproveDocumentEvent with the specified errorPathPrefix and document
CompleteDocumentEvent(Document document) Constructs a RouteDocumentEvent with the given document
CompleteDocumentEvent(String errorPathPrefix, Document document) Constructs a RouteDocumentEvent with the specified errorPathPrefix and document
DocumentAuditEvent(Document document) Constructs a RunAuditEvent with the given document.
DocumentAuditEvent(String errorPathPrefix, Document document) Constructs a RunAuditEvent with the given errorPathPrefix and document.
KualiDocumentEventBase(String description, String errorPathPrefix, Document document) Constructs a KualiEvent with the given description and errorPathPrefix for the given document.
RouteDocumentEvent(Document document) Constructs a RouteDocumentEvent with the given document
RouteDocumentEvent(String errorPathPrefix, Document document) Constructs a RouteDocumentEvent with the specified errorPathPrefix and document
SaveDocumentEvent(Document document) Constructs a SaveDocumentEvent with the given document
SaveDocumentEvent(String errorPathPrefix, Document document) Constructs a SaveDocumentEvent with the specified errorPathPrefix and document
SaveDocumentEvent(String description, String errorPathPrefix, Document document)
SaveOnlyDocumentEvent(Document document) Constructs a SaveDocumentEvent with the given document
SaveOnlyDocumentEvent(String errorPathPrefix, Document document) Constructs a SaveOnlyDocumentEvent with the specified errorPathPrefix and document
SaveOnlyDocumentEvent(String description, String errorPathPrefix, Document document)
SendAdHocRequestsEvent(Document document) Constructs a SaveDocumentEvent with the given document
SendAdHocRequestsEvent(String errorPathPrefix, Document document)
SendAdHocRequestsEvent(String description, String errorPathPrefix, Document document)

Uses of Document in org.kuali.rice.krad.service

Methods in org.kuali.rice.krad.service that return Document

Modifier and Type	Method and Description
Document	DocumentService.acknowledgeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) acknowledge this document, optionally providing an annotation for the acknowledgement which will show up in the route log for the document for this acknowledgement, additionally optionally provide a list of ad hoc recipients that should recieve this document.
Document	DocumentService.approveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) approve this document, optionally providing an annotation which will show up in the route log for this document for this action taken, and optionally providing a list of ad hoc recipients for the document
Document	DocumentService.blanketApproveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) blanket approve this document which will approve the document and stand in for an approve for all typically generated approval actions requested for this document.
Document	DocumentService.cancelDocument(Document document, String annotation) cancel this document, optionally providing an annotation for the disapproval which will show up in the route log for the document for this action taken
Document	DocumentService.clearDocumentFyi(Document document, List<AdHocRouteRecipient> adHocRecipients) clear the fyi request for this document, optionally providing a list of ad hoc recipients for this document, which should be restricted to action requested of fyi as all other actions requested will be discarded
Document	DocumentService.completeDocument(Document document, String annotation, List adHocRecipients) Complete action for a document
Document	DocumentService.disapproveDocument(Document document, String annotation) disapprove this document, optionally providing an annotation for the disapproval which will show up in the route log for the document for this action taken
Document	DocumentService.getByDocumentHeaderId(String documentHeaderId) get a document based on the document header id which is the primary key for all document types
Document	DocumentService.getByDocumentHeaderIdSessionless(String documentHeaderId) get a document based on the document header id which is the primary key for all document types.
Document	DocumentService.getNewDocument(Class<? extends Document> documentClass) get a new blank document instance having the given Document class
Document	DocumentService.getNewDocument(String documentTypeName) get a new blank document instance based on the document type name
Document	DocumentService.getNewDocument(String documentTypeName, String initiatorPrincipalNm) get a new blank document instance based on the document type name.
Document	DocumentService.recallDocument(Document document, String annotation, boolean cancel) recall this document, optionally providing an annotation for the recall which will show up in the route log for the document for this action taken
Document	DocumentService.routeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) start the route the document for approval, optionally providing a list of ad hoc recipients, and additionally provideing a annotation to show up in the route log for the document
Document	DocumentService.saveDocument(Document document) This is a helper method that performs the same as the DocumentService.saveDocument(Document, Class) method.
Document	DocumentService.saveDocument(Document document, Class<? extends KualiDocumentEvent> kualiDocumentEventClass) Saves the passed-in document.
Document	DocumentService.superUserApproveDocument(Document document, String annotation) approve this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserCancelDocument(Document document, String annotation) cancel this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserDisapproveDocument(Document document, String annotation) disapprove this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserDisapproveDocumentWithoutSaving(Document document, String annotation) disapprove this document as super user, without saving, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.updateDocument(Document document) This method is to allow for documents to be updated which is currently used to update the document status as well as to allow for locked docs to be unlocked
Document	DocumentService.validateAndPersistDocument(Document document, KualiDocumentEvent event) Helper method used to save and validate a document

Methods in org.kuali.rice.krad.service that return types with arguments of type Document

Modifier and Type	Method and Description
Class<? extends Document>	DataDictionaryService.getDocumentClassByTypeName(String documentTypeName) Returns the document class declared in the dd for the given document type name.
List<Document>	DocumentService.getDocumentsByListOfDocumentHeaderIds(Class<? extends Document> documentClass, List<String> documentHeaderIds) This method retrieves a list of fully-populated documents given a list of document header id values.
Class<? extends Document>	DataDictionaryService.getValidDocumentClassByTypeName(String documentTypeName) Returns the document class declared in the dd for the given document type name.

Methods in org.kuali.rice.krad.service with parameters of type Document

Modifier and Type	Method and Description
Document	DocumentService.acknowledgeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) acknowledge this document, optionally providing an annotation for the acknowledgement which will show up in the route log for the document for this acknowledgement, additionally optionally provide a list of ad hoc recipients that should recieve this document.
void	DocumentAdHocService.addAdHocs(Document doc) This method populates the given Document with the AdHocRoutePersons and AdHocRouteWorkgroups that are associated with it.
Document	DocumentService.approveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) approve this document, optionally providing an annotation which will show up in the route log for this document for this action taken, and optionally providing a list of ad hoc recipients for the document
Document	DocumentService.blanketApproveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) blanket approve this document which will approve the document and stand in for an approve for all typically generated approval actions requested for this document.
Document	DocumentService.cancelDocument(Document document, String annotation) cancel this document, optionally providing an annotation for the disapproval which will show up in the route log for the document for this action taken
Document	DocumentService.clearDocumentFyi(Document document, List<AdHocRouteRecipient> adHocRecipients) clear the fyi request for this document, optionally providing a list of ad hoc recipients for this document, which should be restricted to action requested of fyi as all other actions requested will be discarded
Document	DocumentService.completeDocument(Document document, String annotation, List adHocRecipients) Complete action for a document
Note	DocumentService.createNoteFromDocument(Document document, String text) This method creates a note from a given document and note text.
Document	DocumentService.disapproveDocument(Document document, String annotation) disapprove this document, optionally providing an annotation for the disapproval which will show up in the route log for the document for this action taken
Map	PessimisticLockService.establishLocks(Document document, Map editMode, Person user)
void	PessimisticLockService.establishWorkflowPessimisticLocking(Document document)
List<AddAdHocRoutePersonEvent>	KualiRuleService.generateAdHocRoutePersonEvents(Document document) Builds a list containing ad hoc route person events appropriate for the context.
List<AddAdHocRouteWorkgroupEvent>	KualiRuleService.generateAdHocRouteWorkgroupEvents(Document document) Builds a list containing ad hoc route workgroup events appropriate for the context.
Boolean	DocumentDictionaryService.getAllowsCopy(Document document) Returns whether or not this document's data dictionary file has flagged it to allow document copies
Class<? extends BusinessRule>	DocumentDictionaryService.getBusinessRulesClass(Document document) Retrieves the configured business rule class configured for the document entry that is associated with the document type of the given document instance
BusinessRule	KualiRuleService.getBusinessRulesInstance(Document document, Class<? extends BusinessRule> ruleInterface) Allows code in actions or business objects to directly access rule methods in the class.
Collection	DocumentDictionaryService.getDefaultExistenceChecks(Document document) Retrieves the collection of ReferenceDefinition objects defined as DefaultExistenceChecks for the document instance
Set	PessimisticLockService.getDocumentActions(Document document, Person user, Set<String> documentActions)
DocumentAuthorizer	DocumentDictionaryService.getDocumentAuthorizer(Document document) Retrieves the DocumentAuthorizer configured on the document entry for the document type associated with the document instance
DocumentPresentationController	DocumentDictionaryService.getDocumentPresentationController(Document document) Retrieves the DocumentPresentationController configured on the document entry for the document type associated with the document instance
void	DocumentService.prepareWorkflowDocument(Document document) Sets the title and app document id in the workflow document
Document	DocumentService.recallDocument(Document document, String annotation, boolean cancel) recall this document, optionally providing an annotation for the recall which will show up in the route log for the document for this action taken
void	PessimisticLockService.releaseWorkflowPessimisticLocking(Document document)
Document	DocumentService.routeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) start the route the document for approval, optionally providing a list of ad hoc recipients, and additionally provideing a annotation to show up in the route log for the document
Document	DocumentService.saveDocument(Document document) This is a helper method that performs the same as the DocumentService.saveDocument(Document, Class) method.
Document	DocumentService.saveDocument(Document document, Class<? extends KualiDocumentEvent> kualiDocumentEventClass) Saves the passed-in document.
boolean	DocumentService.saveDocumentNotes(Document document) Saves the notes associated with the given document if they are in a state where they can be saved.
void	DocumentService.sendAdHocRequests(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	DocumentService.sendNoteRouteNotification(Document document, Note note, Person sender) Builds an workflow notification request for the note and sends it to note recipient.
String	DocumentSerializerService.serializeDocumentToXmlForRouting(Document document) Serializes a document into XML for the workflow engine
Document	DocumentService.superUserApproveDocument(Document document, String annotation) approve this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserCancelDocument(Document document, String annotation) cancel this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserDisapproveDocument(Document document, String annotation) disapprove this document as super user, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.superUserDisapproveDocumentWithoutSaving(Document document, String annotation) disapprove this document as super user, without saving, optionally providing an annotation which will show up in the route log for this document for this action taken
Document	DocumentService.updateDocument(Document document) This method is to allow for documents to be updated which is currently used to update the document status as well as to allow for locked docs to be unlocked
Document	DocumentService.validateAndPersistDocument(Document document, KualiDocumentEvent event) Helper method used to save and validate a document
void	DictionaryValidationService.validateDocument(Document document) Validates the contents of a document (i.e.
void	DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired) Validates the contents of a document and recursively validates any of its updatable references
void	DictionaryValidationService.validateDocumentAndUpdatableReferencesRecursively(Document document, int maxDepth, boolean validateRequired, boolean chompLastLetterSFromCollectionName) Validates the contents of a document and recursively validates any of its updatable references
void	DictionaryValidationService.validateDocumentAttribute(Document document, String attributeName, String errorPrefix) Validates the specified attribute of the given document against the data dictionary.

Method parameters in org.kuali.rice.krad.service with type arguments of type Document

Modifier and Type	Method and Description
DocumentEntry	DocumentDictionaryService.getDocumentEntryByClass(Class<? extends Document> documentClass) Retrieves the document entry that is associated with the given document class
List<Document>	DocumentService.getDocumentsByListOfDocumentHeaderIds(Class<? extends Document> documentClass, List<String> documentHeaderIds) This method retrieves a list of fully-populated documents given a list of document header id values.
String	DocumentDictionaryService.getDocumentTypeByClass(Class<? extends Document> documentClass) Retrieves the document type configured on the document entry associated with the given document class
Document	DocumentService.getNewDocument(Class<? extends Document> documentClass) get a new blank document instance having the given Document class

Uses of Document in org.kuali.rice.krad.uif.view

Methods in org.kuali.rice.krad.uif.view that return types with arguments of type Document

Modifier and Type	Method and Description
Class<? extends Document>	DocumentView.getDocumentClass()

Method parameters in org.kuali.rice.krad.uif.view with type arguments of type Document

Modifier and Type	Method and Description
void	DocumentView.setDocumentClass(Class<? extends Document> documentClass)

Uses of Document in org.kuali.rice.krad.util

Methods in org.kuali.rice.krad.util with parameters of type Document

Modifier and Type	Method and Description
static boolean	RouteToCompletionUtil.checkIfAtleastOneAdHocCompleteRequestExist(Document document) Checks if there is atleast one Ad-Hoc Completion request for the document and based on that returns a boolean value.

Uses of Document in org.kuali.rice.krad.util.documentserializer

Methods in org.kuali.rice.krad.util.documentserializer with parameters of type Document

Modifier and Type	Method and Description
void	PropertySerializabilityEvaluatorBase.initializeEvaluatorForDocument(Document document)
void	PropertySerializabilityEvaluator.initializeEvaluatorForDocument(Document document) Initializes the evaluator so that calls to #isPropertySerializable(DocumentSerializationState, Object, String, Object) and PropertySerializabilityEvaluator.determinePropertyType(Object) will function properly
void	BusinessObjectPropertySerializibilityEvaluator.initializeEvaluatorForDocument(Document document) Reads the data dictionary to determine which properties of the document should be serialized.
void	AlwaysTruePropertySerializibilityEvaluator.initializeEvaluatorForDocument(Document document) Does nothing, since we know everything's serializable
void	AlwaysFalsePropertySerializabilityEvaluator.initializeEvaluatorForDocument(Document document)

Uses of Document in org.kuali.rice.krad.web.controller

Methods in org.kuali.rice.krad.web.controller with parameters of type Document

Modifier and Type	Method and Description
protected DocumentAuthorizationException	DocumentControllerBase.buildAuthorizationException(String action, Document document) Convenience method for building authorization exceptions

Uses of Document in org.kuali.rice.krad.web.form

Fields in org.kuali.rice.krad.web.form declared as Document

Modifier and Type	Field and Description
protected Document	DocumentFormBase.document

Methods in org.kuali.rice.krad.web.form that return Document

Modifier and Type	Method and Description
Document	DocumentFormBase.getDocument()

Methods in org.kuali.rice.krad.web.form with parameters of type Document

Modifier and Type	Method and Description
void	DocumentFormBase.setDocument(Document document)

Uses of Document in org.kuali.rice.krad.workflow

Methods in org.kuali.rice.krad.workflow that return Document

Modifier and Type	Method and Description
Document	KualiDocumentXmlMaterializer.getDocument()

Methods in org.kuali.rice.krad.workflow with parameters of type Document

Modifier and Type	Method and Description
void	KualiDocumentXmlMaterializer.setDocument(Document document)