Uses of Interface
org.kuali.rice.krad.maintenance.MaintenanceDocument

Packages that use MaintenanceDocument

Package	Description
org.kuali.rice.krad.maintenance
org.kuali.rice.krad.rules
org.kuali.rice.krad.service
org.kuali.rice.krad.web.form

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

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

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 MaintenanceDocument

Modifier and Type	Method and Description
boolean	MaintenanceViewAuthorizerBase.canCreateOrMaintain(MaintenanceDocument maintenanceDocument, Person user)
boolean	MaintenanceDocumentAuthorizerBase.canCreateOrMaintain(MaintenanceDocument maintenanceDocument, Person user)
boolean	MaintenanceDocumentAuthorizer.canCreateOrMaintain(MaintenanceDocument maintenanceDocument, Person user)
static void	MaintenanceUtils.checkForLockingDocument(MaintenanceDocument document, boolean throwExceptionIfLocked) Determines if there is another maintenance document that has a lock on the same key as the given document, and therefore will block the maintenance document from being submitted
String	MaintainableImpl.getDocumentTitle(MaintenanceDocument document)
String	Maintainable.getDocumentTitle(MaintenanceDocument document) Invoked when setting the title for the document instance in workflow (doc search results) to customize the title
void	MaintainableImpl.processAfterCopy(MaintenanceDocument document, Map<String,String[]> requestParameters)
void	Maintainable.processAfterCopy(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after the maintenance object has been setup for a copy action
void	MaintainableImpl.processAfterEdit(MaintenanceDocument document, Map<String,String[]> requestParameters)
void	Maintainable.processAfterEdit(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after the maintenance object has been setup for a edit action
void	MaintainableImpl.processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters)
void	Maintainable.processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after the maintenance object has been setup for a new action
void	MaintainableImpl.processAfterPost(MaintenanceDocument document, Map<String,String[]> requestParameters)
void	Maintainable.processAfterPost(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after each posting of the maintenance document (for various actions like add line, refresh)
Object	MaintainableImpl.retrieveObjectForEditOrCopy(MaintenanceDocument document, Map<String,String> dataObjectKeys)
Object	Maintainable.retrieveObjectForEditOrCopy(MaintenanceDocument document, Map<String,String> dataObjectKeys) Called during setupMaintenanceObject to retrieve the original dataObject that is being edited or copied.
void	MaintainableImpl.setupNewFromExisting(MaintenanceDocument document, Map<String,String[]> parameters)
void	Maintainable.setupNewFromExisting(MaintenanceDocument document, Map<String,String[]> parameters) Performs the setting of some attributes that might be necessary if we're creating a new business object using on an existing business object.

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

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

Modifier and Type	Method and Description
protected boolean	MaintenanceDocumentRuleBase.dataDictionaryValidate(MaintenanceDocument document) Executes the DataDictionary Validation against the document.
protected boolean	MaintenanceDocumentRuleBase.isCorrectMaintenanceClass(MaintenanceDocument document, Class clazz) This method tests to make sure the MaintenanceDocument passed in is based on the class you are expecting.
protected boolean	MaintenanceDocumentRuleBase.isDocumentInactivatingBusinessObject(MaintenanceDocument maintenanceDocument) Determines whether a document is inactivating the record being maintained
protected boolean	MaintenanceDocumentRuleBase.isDocumentValidForSave(MaintenanceDocument maintenanceDocument) This method checks to see if the document is in a state that it can be saved without causing exceptions.
protected boolean	MaintenanceDocumentRuleBase.primaryKeyCheck(MaintenanceDocument document) This method checks the two major cases that may violate primary key integrity.
boolean	MaintenanceDocumentRuleBase.processCustomAddCollectionLineBusinessRules(MaintenanceDocument document, String collectionName, PersistableBusinessObject line)
protected boolean	MaintenanceDocumentRuleBase.processCustomApproveDocumentBusinessRules(MaintenanceDocument document) This method should be overridden to provide custom rules for processing document approval.
protected boolean	MaintenanceDocumentRuleBase.processCustomRouteDocumentBusinessRules(MaintenanceDocument document) This method should be overridden to provide custom rules for processing document routing
protected boolean	MaintenanceDocumentRuleBase.processCustomSaveDocumentBusinessRules(MaintenanceDocument document) This method should be overridden to provide custom rules for processing document saving
protected boolean	MaintenanceDocumentRuleBase.processGlobalApproveDocumentBusinessRules(MaintenanceDocument document) This method enforces all business rules that are common to all maintenance documents which must be tested before doing an approval.
protected boolean	MaintenanceDocumentRuleBase.processGlobalRouteDocumentBusinessRules(MaintenanceDocument document) This method enforces all business rules that are common to all maintenance documents which must be tested before doing a route.
protected boolean	MaintenanceDocumentRuleBase.processGlobalSaveDocumentBusinessRules(MaintenanceDocument document) This method enforces all business rules that are common to all maintenance documents which must be tested before doing a save.
protected boolean	MaintenanceDocumentRuleBase.processInactivationBlockChecking(MaintenanceDocument maintenanceDocument) Determines whether this document has been inactivation blocked
protected boolean	MaintenanceDocumentRuleBase.processInactivationBlockChecking(MaintenanceDocument maintenanceDocument, InactivationBlockingMetadata inactivationBlockingMetadata) Given a InactivationBlockingMetadata, which represents a relationship that may block inactivation of a BO, it determines whether there is a record that violates the blocking definition
protected void	MaintenanceDocumentRuleBase.putInactivationBlockingErrorOnPage(MaintenanceDocument document, InactivationBlockingMetadata inactivationBlockingMetadata) If there is a violation of an InactivationBlockingMetadata, it prints out an appropriate error into the error map
void	MaintenanceDocumentRuleBase.setupBaseConvenienceObjects(MaintenanceDocument document)
void	MaintenanceDocumentRule.setupBaseConvenienceObjects(MaintenanceDocument document) Sets the convenience objects like newAccount and oldAccount, so you have short and easy handles to the new and old objects contained in the maintenance document.
protected boolean	MaintenanceDocumentRuleBase.validateGlobalBusinessObjectPersistable(MaintenanceDocument document) This method checks whether this maint doc contains Global Business Objects, and if so, whether the GBOs are in a persistable state.
protected boolean	MaintenanceDocumentRuleBase.validateMaintenanceDocument(MaintenanceDocument maintenanceDocument) This method checks to make sure the document is a valid maintenanceDocument, and has the necessary values populated such that it will not cause exceptions in later routing or business rules testing.

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

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

Modifier and Type	Method and Description
MaintenanceDocument	MaintenanceDocumentService.setupNewMaintenanceDocument(String objectClassName, String docTypeName, String maintenanceAction) Prepares the MaintenanceDocument on initial request

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

Modifier and Type	Method and Description
Boolean	DocumentDictionaryService.getAllowsRecordDeletion(MaintenanceDocument document) Indicates whether the given maintenance document is configured to allow record deletions
String	MaintenanceDocumentService.getLockingDocumentId(MaintenanceDocument document) Attempts to find any other active documents that are pending on the same maintenance record.
void	MaintenanceDocumentService.setupMaintenanceObject(MaintenanceDocument document, String maintenanceAction, Map<String,String[]> requestParameters) Called to setup the object being maintained

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

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

Modifier and Type	Method and Description
MaintenanceDocument	MaintenanceForm.getDocument()

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

Modifier and Type	Method and Description
void	MaintenanceForm.setDocument(MaintenanceDocument document)