org.kuali.kra.award.document.authorization

Class AwardDocumentAuthorizer

java.lang.Object

org.kuali.rice.krad.bo.DataObjectAuthorizerBase

org.kuali.rice.kns.bo.authorization.BusinessObjectAuthorizerBase

org.kuali.kra.authorization.KcTransactionalDocumentAuthorizerBase

org.kuali.kra.award.document.authorization.AwardDocumentAuthorizer

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.authorization.BusinessObjectAuthorizer, org.kuali.rice.kns.document.authorization.TransactionalDocumentAuthorizer, org.kuali.rice.krad.bo.DataObjectAuthorizer, org.kuali.rice.krad.document.DocumentAuthorizer

public class AwardDocumentAuthorizer
extends KcTransactionalDocumentAuthorizerBase

This class is the Award Document Authorizer. It determines the edit modes and document actions for all award documents.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.authorization.KcTransactionalDocumentAuthorizerBase

EDIT_MODE_DEFAULT_TRUE_VALUE, PRE_ROUTING_ROUTE_NAME, USER_SESSION_METHOD_TO_CALL_COMPLETE_OBJECT_KEY, USER_SESSION_METHOD_TO_CALL_OBJECT_KEY

Constructor Summary

Constructors

Constructor and Description
AwardDocumentAuthorizer()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	awardHasHierarchyChildren(org.kuali.rice.krad.document.Document document)
boolean	canApprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user approve the given document?
boolean	canBlanketApprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user blanket approve the given document?
boolean	canCancel(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user cancel the given document?
boolean	canCopy(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user copy the given document?
boolean	canCreateAwardAccount(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) This method decides if a user has permissions to create a financial account.
boolean	canDisapprove(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user disapprove the given document?
boolean	canEdit(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user edit the given document?
boolean	canFyi(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user FYI the given document?
boolean	canInitiate(String documentTypeName, org.kuali.rice.kim.api.identity.Person user)
boolean	canOpen(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canSave(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user save the given document?
boolean	canSendNoteFyi(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user)
boolean	canViewAccountElement(AwardDocument document)
boolean	canViewChartOfAccountsElement(AwardDocument document)
AwardHierarchyService	getAwardHierarchyService()
Set<String>	getEditModes(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user, Set<String> currentEditModes)
boolean	hasCreateAccountPermission(AwardDocument document)
protected boolean	isFinancialSystemIntegrationParameterOn()

Methods inherited from class org.kuali.kra.authorization.KcTransactionalDocumentAuthorizerBase

addPermissionDetails, addRoleQualification, canAcknowledge, canAddAdhocRequests, canAddNoteAttachment, canAdHocRoute, canAdHocRoute, canAnnotate, canAnnotate, canApproveAndDisapprove, canBlanketApprove, canCancel, canClose, canClose, canComplete, canCopy, canDeleteNoteAttachment, canEdit, canEditDocumentOverview, canPerformRouteReport, canPerformRouteReport, canRecall, canReceiveAdHoc, canReload, canReload, canRoute, canRoute, canSave, canSendAdhocRequests, canSendAdhocRequests, canSendAdHocRequests, canSendAnyTypeAdHocRequests, canTakeRequestedAction, canViewNoteAttachment, canViewNoteAttachment, getDocumentActions, getDocumentActions, getParameterService, getTaskAuthorizationService, isEnroute, isFinal

Methods inherited from class org.kuali.rice.kns.bo.authorization.BusinessObjectAuthorizerBase

getCollectionItemPermissionDetails, getCollectionItemRoleQualifications, getDataDictionaryService, getKualiModuleService, getRoleQualification, isAuthorized, isAuthorized, isAuthorizedByTemplate, permissionExistsByTemplate, permissionExistsByTemplate

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.kns.authorization.BusinessObjectAuthorizer

getCollectionItemPermissionDetails, getCollectionItemRoleQualifications, isAuthorized, isAuthorized, isAuthorizedByTemplate, isAuthorizedByTemplate

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

isAuthorized, isAuthorized, isAuthorizedByTemplate, isAuthorizedByTemplate

Constructor Detail

AwardDocumentAuthorizer

public AwardDocumentAuthorizer()

Method Detail

getEditModes

public Set<String> getEditModes(org.kuali.rice.krad.document.Document document,
                       org.kuali.rice.kim.api.identity.Person user,
                       Set<String> currentEditModes)

See Also:

TransactionalDocumentAuthorizer.getEditModes( org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person, java.util.Set)

canInitiate

public boolean canInitiate(String documentTypeName,
                  org.kuali.rice.kim.api.identity.Person user)

See Also:

DocumentAuthorizer.canInitiate(java.lang.String, org.kuali.rice.kim.api.identity.Person)

canCreateAwardAccount

public boolean canCreateAwardAccount(org.kuali.rice.krad.document.Document document,
                            org.kuali.rice.kim.api.identity.Person user)

This method decides if a user has permissions to create a financial account.

Parameters:

document -

user -

Returns:

hasPermission

isFinancialSystemIntegrationParameterOn

protected boolean isFinancialSystemIntegrationParameterOn()

hasCreateAccountPermission

public boolean hasCreateAccountPermission(AwardDocument document)

canViewChartOfAccountsElement

public boolean canViewChartOfAccountsElement(AwardDocument document)

canViewAccountElement

public boolean canViewAccountElement(AwardDocument document)

canOpen

public boolean canOpen(org.kuali.rice.krad.document.Document document,
              org.kuali.rice.kim.api.identity.Person user)

See Also:

DocumentAuthorizer.canOpen(org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person)

canEdit

public boolean canEdit(org.kuali.rice.krad.document.Document document,
              org.kuali.rice.kim.api.identity.Person user)

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user edit the given document?

Specified by:

canEdit in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canEdit in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can edit the document; otherwise false

See Also:

KcTransactionalDocumentAuthorizerBase.canEdit(org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person)

canSave

public boolean canSave(org.kuali.rice.krad.document.Document document,
              org.kuali.rice.kim.api.identity.Person user)

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user save the given document?

Specified by:

canSave in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canSave in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can save the document; otherwise false

See Also:

KcTransactionalDocumentAuthorizerBase.canSave(org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person)

canCopy

public boolean canCopy(org.kuali.rice.krad.document.Document document,
              org.kuali.rice.kim.api.identity.Person user)

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user copy the given document?

Specified by:

canCopy in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canCopy in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can copy the document; otherwise false

See Also:

KcTransactionalDocumentAuthorizerBase.canCopy(org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person)

canCancel

public boolean canCancel(org.kuali.rice.krad.document.Document document,
                org.kuali.rice.kim.api.identity.Person user)

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user cancel the given document?

Specified by:

canCancel in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canCancel in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can cancel the document; otherwise false

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

KcTransactionalDocumentAuthorizerBase.canCancel(org.kuali.rice.krad.document.Document, org.kuali.rice.kim.api.identity.Person)

canApprove

public boolean canApprove(org.kuali.rice.krad.document.Document document,
                 org.kuali.rice.kim.api.identity.Person user)

Can the user approve the given document?

Specified by:

canApprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canApprove in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can approve the document; otherwise false

canDisapprove

public boolean canDisapprove(org.kuali.rice.krad.document.Document document,
                    org.kuali.rice.kim.api.identity.Person user)

Can the user disapprove the given document?

Specified by:

canDisapprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canDisapprove in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can disapprove the document; otherwise false

canBlanketApprove

public boolean canBlanketApprove(org.kuali.rice.krad.document.Document document,
                        org.kuali.rice.kim.api.identity.Person user)

Can the user blanket approve the given document?

Specified by:

canBlanketApprove in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canBlanketApprove in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can blanket approve the document; otherwise false

awardHasHierarchyChildren

protected boolean awardHasHierarchyChildren(org.kuali.rice.krad.document.Document document)

getAwardHierarchyService

public AwardHierarchyService getAwardHierarchyService()

canSendNoteFyi

public boolean canSendNoteFyi(org.kuali.rice.krad.document.Document document,
                     org.kuali.rice.kim.api.identity.Person user)

canFyi

public boolean canFyi(org.kuali.rice.krad.document.Document document,
             org.kuali.rice.kim.api.identity.Person user)

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user FYI the given document?

Specified by:

canFyi in interface org.kuali.rice.krad.document.DocumentAuthorizer

Overrides:

canFyi in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can FYI the document; otherwise false