org.kuali.kra.budget.document.authorization

Class BudgetDocumentAuthorizer

java.lang.Object

org.kuali.rice.krad.bo.DataObjectAuthorizerBase

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

org.kuali.kra.authorization.KcTransactionalDocumentAuthorizerBase

org.kuali.kra.budget.document.authorization.BudgetDocumentAuthorizer

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

Direct Known Subclasses:

AwardBudgetDocumentAuthorizer

public class BudgetDocumentAuthorizer
extends KcTransactionalDocumentAuthorizerBase

This class is the Budget Document Authorizer. It determines the edit modes and document actions for all budget 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
BudgetDocumentAuthorizer()

Method Summary

Methods

Modifier and Type	Method and Description
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	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	canReload(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user reload the given document?
boolean	canRoute(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user) Can the user route the given document?
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)
protected Task	createNewBudgetTask(String taskGroupName, String taskName, BudgetDocument budgetDocument)
Set<String>	getEditModes(org.kuali.rice.krad.document.Document document, org.kuali.rice.kim.api.identity.Person user, Set<String> currentEditModes)
protected String	getTaskGroupName()
protected void	setPermissions(String userId, BudgetParentDocument doc, Set<String> editModes) Set the permissions to be used during the creation of the web pages.

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

addPermissionDetails, addRoleQualification, canAcknowledge, canAddAdhocRequests, canAddNoteAttachment, canAdHocRoute, canAdHocRoute, canAnnotate, canAnnotate, canApprove, canApproveAndDisapprove, canBlanketApprove, canBlanketApprove, canCancel, canClose, canClose, canComplete, canCopy, canDeleteNoteAttachment, canDisapprove, canEdit, canEditDocumentOverview, canPerformRouteReport, canPerformRouteReport, canRecall, canReceiveAdHoc, canReload, 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

BudgetDocumentAuthorizer

public BudgetDocumentAuthorizer()

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)

setPermissions

protected void setPermissions(String userId,
                  BudgetParentDocument doc,
                  Set<String> editModes)

Set the permissions to be used during the creation of the web pages. The JSP files can access the editModeMap (editingMode) to determine what to display to the user. For example, a JSP file may contain the following: . . . In the above example, the contents are only rendered if the user is allowed to modify the proposal. Note that permissions are always signified as either TRUE or FALSE.

Parameters:

username - the user's unique username

doc - the Proposal Development Document

editModeMap - the edit mode map

createNewBudgetTask

protected Task createNewBudgetTask(String taskGroupName,
                       String taskName,
                       BudgetDocument budgetDocument)

getTaskGroupName

protected String getTaskGroupName()

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)

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)

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

See Also:

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

canReload

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

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user reload the given document?

Specified by:

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

Overrides:

canReload in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can reload the document; otherwise false

See Also:

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

canRoute

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

Description copied from class: KcTransactionalDocumentAuthorizerBase

Can the user route the given document?

Specified by:

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

Overrides:

canRoute in class KcTransactionalDocumentAuthorizerBase

Parameters:

document - the document

user - the user

Returns:

true if the user can route the document; otherwise false

See Also:

KcTransactionalDocumentAuthorizerBase.canRoute(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)

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