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.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() The optional Document superclass associated with the document
Class<? extends Document>	DocumentEntry.getDocumentClass() The Document subclass associated with the document
Class<? extends Document>	TransactionalDocumentEntry.getStandardDocumentBaseClass() Returns the default base class for a TransactionalDocument.
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) Setter for document 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 Interface for all documents that have transactional behavior.

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

Modifier and Type	Class and Description
class	DocumentBase
class	TransactionalDocumentBase Base class for transactional documents

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)
protected DocumentAuthorizationException	DocumentControllerServiceImpl.buildAuthorizationException(String action, Document document) Convenience method for building document authorization exceptions.
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)
protected boolean	DocumentPresentationControllerBase.canApproveOrDisapprove(Document document) Returns whether a super user approve or disapprove action can be taken on the document.
boolean	DocumentViewPresentationControllerBase.canBlanketApprove(Document document)
boolean	DocumentPresentationControllerBase.canBlanketApprove(Document document)
boolean	DocumentPresentationController.canBlanketApprove(Document document)
boolean	TransactionalDocumentAuthorizerBase.canBlanketApprove(Document document, Person user)
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	TransactionalDocumentAuthorizerBase.canCancel(Document document, Person user) Determines if the user has permission to cancel the document
boolean	DocumentViewAuthorizerBase.canCancel(Document document, Person user) Determines if the user has permission to cancel the document
boolean	DocumentAuthorizerBase.canCancel(Document document, Person user)
boolean	DocumentAuthorizer.canCancel(Document document, Person user) Determines if the user has permission to cancel the document
boolean	TransactionalDocumentPresentationControllerBase.canClose(Document document) A document should only show its close button if it is a transactional document, since closing releases its pessimistic locks.
boolean	DocumentViewPresentationControllerBase.canClose(Document document)
boolean	DocumentPresentationControllerBase.canClose(Document document)
boolean	DocumentPresentationController.canClose(Document document)
boolean	TransactionalDocumentAuthorizerBase.canClose(Document document, Person user)
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) Determines if the user has permission to copy the document
boolean	DocumentAuthorizerBase.canCopy(Document document, Person user)
boolean	DocumentAuthorizer.canCopy(Document document, Person user) Determines if the user has permission to copy the document
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) Determines if the document can be edited; if false is returned, then all fields are in a read only state
boolean	DocumentAuthorizerBase.canEdit(Document document, Person user)
boolean	DocumentAuthorizer.canEdit(Document document, Person user) Determines if the document can be edited; if false is returned, then all fields are in a read only state
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)
protected boolean	TransactionalDocumentAuthorizerBase.canEstablishPessimisticLock(Document document, Person user) Returns whether user can establish a pessimistic lock on the document.
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) Checks if a user has the permissions to open a document
boolean	DocumentAuthorizerBase.canOpen(Document document, Person user)
boolean	DocumentAuthorizer.canOpen(Document document, Person user) Checks if a user has the permissions to open a document
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	TransactionalDocumentAuthorizerBase.canRoute(Document document, Person user) Determines if the user has permission to route the document
boolean	DocumentViewAuthorizerBase.canRoute(Document document, Person user) Determines if the user has permission to route the document
boolean	DocumentAuthorizerBase.canRoute(Document document, Person user)
boolean	DocumentAuthorizer.canRoute(Document document, Person user) Determines if the user has permission to route the document
boolean	DocumentViewPresentationControllerBase.canSave(Document document)
boolean	DocumentPresentationControllerBase.canSave(Document document)
boolean	DocumentPresentationController.canSave(Document document)
boolean	TransactionalDocumentAuthorizerBase.canSave(Document document, Person user)
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	DocumentViewPresentationControllerBase.canSuperUserApprove(Document document) Determines if the document state should allow a super user approving the document.
boolean	DocumentPresentationControllerBase.canSuperUserApprove(Document document) Determines if the document state should allow a super user approving the document.
boolean	DocumentPresentationController.canSuperUserApprove(Document document) Determines if the document state should allow a super user approving the document.
boolean	DocumentViewAuthorizerBase.canSuperUserApprove(Document document, Person user) Determines if the user has permission to approve a document as a super user.
boolean	DocumentAuthorizerBase.canSuperUserApprove(Document document, Person user)
boolean	DocumentAuthorizer.canSuperUserApprove(Document document, Person user) Determines if the user has permission to approve a document as a super user.
boolean	DocumentViewPresentationControllerBase.canSuperUserDisapprove(Document document) Determines if the document state should allow a super user disapproving the document.
boolean	DocumentPresentationControllerBase.canSuperUserDisapprove(Document document) Determines if the document state should allow a super user disapproving the document.
boolean	DocumentPresentationController.canSuperUserDisapprove(Document document) Determines if the document state should allow a super user disapproving the document.
boolean	DocumentViewAuthorizerBase.canSuperUserDisapprove(Document document, Person user) Determines if the user has permission to disapprove a document as a super user.
boolean	DocumentAuthorizerBase.canSuperUserDisapprove(Document document, Person user)
boolean	DocumentAuthorizer.canSuperUserDisapprove(Document document, Person user) Determines if the user has permission to disapprove a document as a super user.
boolean	DocumentViewPresentationControllerBase.canSuperUserTakeAction(Document document) Determines if the document state should allow a super user taking an action.
boolean	DocumentPresentationControllerBase.canSuperUserTakeAction(Document document) Determines if the document state should allow a super user taking an action.
boolean	DocumentPresentationController.canSuperUserTakeAction(Document document) Determines if the document state should allow a super user taking an action.
boolean	DocumentViewAuthorizerBase.canSuperUserTakeAction(Document document, Person user) Determines if the user has permission to take a super user action.
boolean	DocumentAuthorizerBase.canSuperUserTakeAction(Document document, Person user)
boolean	DocumentAuthorizer.canSuperUserTakeAction(Document document, Person user) Determines if the user has permission to take a super user action.
protected boolean	DocumentPresentationControllerBase.canTakeAction(Document document) Returns whether a super user action can be taken on the document.
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, Person user)
boolean	DocumentAuthorizerBase.canViewNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	DocumentAuthorizer.canViewNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	DocumentViewAuthorizerBase.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user) Deprecated.
boolean	DocumentAuthorizerBase.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user) Deprecated.
boolean	DocumentAuthorizer.canViewNoteAttachment(Document document, String attachmentTypeCode, String authorUniversalIdentifier, Person user) Deprecated.
protected DocumentRequestAuthorizationCache	DocumentViewPresentationControllerBase.getDocumentRequestAuthorizationCache(Document document)
protected DocumentRequestAuthorizationCache	DocumentViewAuthorizerBase.getDocumentRequestAuthorizationCache(Document document)
protected DocumentRequestAuthorizationCache	DocumentPresentationControllerBase.getDocumentRequestAuthorizationCache(Document document)
protected DocumentRequestAuthorizationCache	DocumentAuthorizerBase.getDocumentRequestAuthorizationCache(Document document)
protected Attachment	DocumentControllerServiceImpl.getNewNoteAttachment(DocumentFormBase form, Document document, Note newNote) Builds an attachment for the file (if any) associated with the add note instance.
protected boolean	DocumentPresentationControllerBase.hasActionRequests(Document document) Returns whether the document has any APPROVE or COMPLETE action requests.
void	DocumentViewAuthorizerBase.initializeDocumentAuthorizerIfNecessary(Document document) If the document authorizer is null, gets the authorizer from the document dictionary service for the given document's class.
protected boolean	DocumentViewAuthorizerBase.isDocumentInitiator(Document document, Person user)
protected boolean	DocumentAuthorizerBase.isDocumentInitiator(Document document, Person user)
protected boolean	TransactionalDocumentAuthorizerBase.isUsingPessimisticLocking(Document document) Returns whether the document is using pessimistic locking.
protected void	DocumentControllerServiceImpl.saveNewNote(DocumentFormBase form, Document document, Note newNote) Saves a new note instance to the data store if the document state allows it.
protected void	DocumentControllerServiceImpl.setNewNoteProperties(DocumentFormBase form, Document document, Note newNote) Defaults properties (posted timestamp, object id, author) on the note instance that will be added.

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	DocumentEventBase.document

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

Modifier and Type	Method and Description
Document	DocumentEventBase.getDocument()
Document	DocumentEvent.getDocument()

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

Modifier and Type	Method and Description
protected static String	DocumentEventBase.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
AddCollectionLineEvent(Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName.
AddCollectionLineEvent(String errorPathPrefix, Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix.
AddCollectionLineEvent(String eventType, String errorPathPrefix, Document document, String collectionName, Object addLine) Constructs an event for a document adding a line to the collection with the name collectionName with a specific errorPathPrefix and eventType.
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.
DocumentEventBase(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 with type parameters of type Document

Modifier and Type	Method and Description
<T extends Document> T	LegacyDataAdapter.findByDocumentHeaderId(Class<T> documentClass, String id) Deprecated. Finds the Document for the specified class with the given id.
<T extends Document> List<T>	LegacyDataAdapter.findByDocumentHeaderIds(Class<T> documentClass, List<String> ids) Deprecated. Finds the Documents for the specified class with the given list of ids.

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 the document, optionally providing an annotation for the acknowledgement which will show up in the route log of the document, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.acknowledgeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.approveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) Save and then approve the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.approveDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.blanketApproveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) Blanket approve the document which will save the document, approve the document, and stand in for an approve for all typically generated approval actions requested for this document.
Document	DocumentService.blanketApproveDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.cancelDocument(Document document, String annotation) Cancel the document, without saving, optionally providing an annotation for the disapproval which will show up in the route log of the document for the action taken.
Document	DocumentService.clearDocumentFyi(Document document, List<AdHocRouteRecipient> adHocRecipients) Clear the fyi requests for the document, optionally providing a list of ad hoc recipients for the document, which should be restricted to action requested of fyi as all other actions requested will be discarded.
Document	DocumentService.clearDocumentFyi(Document document, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.completeDocument(Document document, String annotation, List adHocRecipients) Save and then complete the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document
Document	DocumentService.completeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.disapproveDocument(Document document, String annotation) Disapprove the document, without saving, optionally providing an annotation which will show up in the route log of the document for the 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 the document, optionally providing an annotation for the recall which will show up in the route log of the document for the action taken.
Document	DocumentService.routeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) Save and then route the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.routeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
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 DocumentEvent> kualiDocumentEventClass) Saves the passed-in document.
Document	DocumentService.saveDocument(Document document, DocumentEvent docEvent) This method saves the given document using the document event passed in.
Document	DocumentService.sendAdHocRequests(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) Send ad hoc requests for the given document, optionally providing an annotation which will show up in the route log of the document.
Document	DocumentService.sendAdHocRequests(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) Send ad hoc requests for the given document to the specified node name, optionally providing an annotation which will show up in the route log of the document.
Document	DocumentService.sendNoteRouteNotification(Document document, Note note, Person sender) Builds an workflow notification request for the note and sends it to note recipient.
Document	DocumentService.superUserApproveDocument(Document document, String annotation) Save and then approve the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserCancelDocument(Document document, String annotation) Save and then cancel the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserDisapproveDocument(Document document, String annotation) Save and then disapprove the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserDisapproveDocumentWithoutSaving(Document document, String annotation) Disapprove the document as super user, without saving, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.updateDocument(Document document) This method is to allow for documents to be updated.
Document	DocumentService.validateAndPersistDocument(Document document, DocumentEvent 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 the document, optionally providing an annotation for the acknowledgement which will show up in the route log of the document, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.acknowledgeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
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) Save and then approve the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.approveDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.blanketApproveDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) Blanket approve the document which will save the document, approve the document, and stand in for an approve for all typically generated approval actions requested for this document.
Document	DocumentService.blanketApproveDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.cancelDocument(Document document, String annotation) Cancel the document, without saving, optionally providing an annotation for the disapproval which will show up in the route log of the document for the action taken.
Document	DocumentService.clearDocumentFyi(Document document, List<AdHocRouteRecipient> adHocRecipients) Clear the fyi requests for the document, optionally providing a list of ad hoc recipients for the document, which should be restricted to action requested of fyi as all other actions requested will be discarded.
Document	DocumentService.clearDocumentFyi(Document document, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Document	DocumentService.completeDocument(Document document, String annotation, List adHocRecipients) Save and then complete the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document
Document	DocumentService.completeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
Note	DocumentService.createNoteFromDocument(Document document, String text) This method creates a note from the given document and note text.
Document	DocumentService.disapproveDocument(Document document, String annotation) Disapprove the document, without saving, optionally providing an annotation which will show up in the route log of the document for the action taken.
Map	PessimisticLockService.establishLocks(Document document, Map editMode, Person user) Deprecated. For KRAD, use @{code establishPessimisticLocks} to generate locks and calculatePessimisticLockEditModes to get the edit modes based on the current locks
boolean	PessimisticLockService.establishPessimisticLocks(Document document, Person user, boolean canEdit) Establishes pessimistic locks for user on the document based whether the user can edit the document.
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) Deprecated. KRAD has integrated this functionality into TransactionalDocumentAuthorizerBase
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 the document, optionally providing an annotation for the recall which will show up in the route log of the document for the action taken.
void	PessimisticLockService.releaseWorkflowPessimisticLocking(Document document)
Document	DocumentService.routeDocument(Document document, String annotation, List<AdHocRouteRecipient> adHocRoutingRecipients) Save and then route the document, optionally providing an annotation which will show up in the route log of the document for the action taken, and optionally providing a list of ad hoc recipients for the document.
Document	DocumentService.routeDocument(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRouteRecipients)
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 DocumentEvent> kualiDocumentEventClass) Saves the passed-in document.
Document	DocumentService.saveDocument(Document document, DocumentEvent docEvent) This method saves the given document using the document event passed in.
boolean	DocumentService.saveDocumentNotes(Document document) Saves the notes associated with the given document if they are in a state where they can be saved.
Document	DocumentService.sendAdHocRequests(Document document, String annotation, List<AdHocRouteRecipient> adHocRecipients) Send ad hoc requests for the given document, optionally providing an annotation which will show up in the route log of the document.
Document	DocumentService.sendAdHocRequests(Document document, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) Send ad hoc requests for the given document to the specified node name, optionally providing an annotation which will show up in the route log of the document.
Document	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) Save and then approve the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserCancelDocument(Document document, String annotation) Save and then cancel the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserDisapproveDocument(Document document, String annotation) Save and then disapprove the document as a super user, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.superUserDisapproveDocumentWithoutSaving(Document document, String annotation) Disapprove the document as super user, without saving, optionally providing an annotation which will show up in the route log of the document for the action taken.
Document	DocumentService.updateDocument(Document document) This method is to allow for documents to be updated.
Document	DocumentService.validateAndPersistDocument(Document document, DocumentEvent 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() Gets the document class

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) Sets the document class

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 PropertySerializabilityEvaluator.isPropertySerializable(SerializationState, 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.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)