Package org.kuali.rice.krad.maintenance

Class MaintenanceDocumentAuthorizerBase

java.lang.Object

org.kuali.rice.krad.bo.DataObjectAuthorizerBase

org.kuali.rice.krad.document.DocumentAuthorizerBase

org.kuali.rice.krad.maintenance.MaintenanceDocumentAuthorizerBase

All Implemented Interfaces:

Serializable, DataObjectAuthorizer, DocumentAuthorizer, MaintenanceDocumentAuthorizer

public class MaintenanceDocumentAuthorizerBase
extends DocumentAuthorizerBase
implements MaintenanceDocumentAuthorizer

Default implementation for MaintenanceDocumentAuthorizer that perform KIM permission checks to authorize the actions

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

• MaintenanceDocumentAuthorizer
• Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.document.DocumentAuthorizerBase

PRE_ROUTING_ROUTE_NAME

Constructor Summary

Constructors

Constructor	Description
MaintenanceDocumentAuthorizerBase()

Method Summary

Modifier and Type	Method	Description
protected void	addPermissionDetails(Object dataObject, Map<String,String> attributes)	Adds the namespace, component and maintenance actions to the permission details attributes
protected void	addRoleQualification(Object dataObject, Map<String,String> attributes)	Adds the namespace and component to the role qualification attributes
boolean	canCreate(Class boClass, Person user)	Determines whether the user has the permission to create a new MaintenanceDocument
boolean	canCreateOrMaintain(MaintenanceDocument maintenanceDocument, Person user)	Determines whether the user has the permission to create or maintain a MaintenanceDocument
boolean	canMaintain(Object dataObject, Person user)	Determines whether the user has the permission to maintain a MaintenanceDocument
protected DocumentDictionaryService	getDocumentDictionaryService()
void	setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)

Methods inherited from class org.kuali.rice.krad.document.DocumentAuthorizerBase

addStandardAttributes, canAcknowledge, canAddNoteAttachment, canAnnotate, canApprove, canBlanketApprove, canCancel, canClose, canCopy, canDeleteNoteAttachment, canDisapprove, canEdit, canEditDocumentOverview, canFyi, canInitiate, canOpen, canPerformRouteReport, canRecall, canReceiveAdHoc, canReload, canRoute, canSave, canSendAdHocRequests, canSendAnyTypeAdHocRequests, canSendNoteFyi, canSuperUserApprove, canSuperUserDisapprove, canSuperUserTakeAction, canTakeRequestedAction, canViewNoteAttachment, canViewNoteAttachment, getDocumentRequestAuthorizationCache, isDocumentInitiator, setDocumentRequestAuthorizationCache

Methods inherited from class org.kuali.rice.krad.bo.DataObjectAuthorizerBase

getPermissionDetailValues, getPermissionService, getPersonService, getRoleQualification, isAuthorized, isAuthorized, isAuthorizedByTemplate, isAuthorizedByTemplate, permissionExistsByTemplate, permissionExistsByTemplate, permissionExistsByTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.bo.DataObjectAuthorizer

isAuthorized, isAuthorized, isAuthorizedByTemplate, isAuthorizedByTemplate

Methods inherited from interface org.kuali.rice.krad.document.DocumentAuthorizer

canAcknowledge, canAddNoteAttachment, canAnnotate, canApprove, canBlanketApprove, canCancel, canClose, canCopy, canDeleteNoteAttachment, canDisapprove, canEdit, canEditDocumentOverview, canFyi, canInitiate, canOpen, canPerformRouteReport, canRecall, canReceiveAdHoc, canReload, canRoute, canSave, canSendAdHocRequests, canSendAnyTypeAdHocRequests, canSendNoteFyi, canSuperUserApprove, canSuperUserDisapprove, canSuperUserTakeAction, canTakeRequestedAction, canViewNoteAttachment, canViewNoteAttachment, setDocumentRequestAuthorizationCache

Constructor Details

MaintenanceDocumentAuthorizerBase

public MaintenanceDocumentAuthorizerBase()

Method Details

canCreate

public boolean canCreate(Class boClass,
 Person user)

Description copied from interface: MaintenanceDocumentAuthorizer

Determines whether the user has the permission to create a new MaintenanceDocument

Specified by:

canCreate in interface MaintenanceDocumentAuthorizer

Parameters:

boClass - Class of the MaintenanceDocument

user - Person instance of the current user

Returns:

true if the user is allowed to create a new MaintenanceDocument for the boClass, false otherwise

See Also:

• MaintenanceDocumentAuthorizer.canCreate(Class, org.kuali.rice.kim.api.identity.Person)

canMaintain

public boolean canMaintain(Object dataObject,
 Person user)

Description copied from interface: MaintenanceDocumentAuthorizer

Determines whether the user has the permission to maintain a MaintenanceDocument

Specified by:

canMaintain in interface MaintenanceDocumentAuthorizer

Parameters:

dataObject - Object of the MaintenanceDocument

user - Person instance of the current user

Returns:

true if the user is allowed to maintain the dataObject, false otherwise

See Also:

• MaintenanceDocumentAuthorizer.canMaintain(Object, org.kuali.rice.kim.api.identity.Person)

canCreateOrMaintain

public boolean canCreateOrMaintain(MaintenanceDocument maintenanceDocument,
 Person user)

Description copied from interface: MaintenanceDocumentAuthorizer

Determines whether the user has the permission to create or maintain a MaintenanceDocument

Specified by:

canCreateOrMaintain in interface MaintenanceDocumentAuthorizer

Parameters:

maintenanceDocument - the MaintenanceDocument

user - Person instance of the current user

Returns:

true if the user is allowed to create or maintain the MaintenanceDocument, false otherwise

See Also:

• MaintenanceDocumentAuthorizer.canCreateOrMaintain(MaintenanceDocument, org.kuali.rice.kim.api.identity.Person)

addRoleQualification

protected void addRoleQualification(Object dataObject,
 Map<String,String> attributes)

Adds the namespace and component to the role qualification attributes

Overrides:

addRoleQualification in class DocumentAuthorizerBase

Parameters:

dataObject - - the primary data object (i.e. the main object instance behind the lookup result row or inquiry) or the document

attributes - - role qualifiers will be added to this map

See Also:

• DocumentAuthorizerBase.addRoleQualification(Object, java.util.Map)

addPermissionDetails

protected void addPermissionDetails(Object dataObject,
 Map<String,String> attributes)

Adds the namespace, component and maintenance actions to the permission details attributes

Overrides:

addPermissionDetails in class DocumentAuthorizerBase

Parameters:

dataObject - - the primary data object (i.e. the main object instance behind the lookup result row or inquiry) or the document

attributes - - permission details will be added to this map

See Also:

• DocumentAuthorizerBase.addPermissionDetails(Object, java.util.Map)

getDocumentDictionaryService

protected DocumentDictionaryService getDocumentDictionaryService()

setDocumentDictionaryService

public void setDocumentDictionaryService(DocumentDictionaryService documentDictionaryService)