org.kuali.rice.krad.uif.authorization
Class DocumentAuthorizerBase

java.lang.Object
  org.kuali.rice.krad.uif.authorization.AuthorizerBase
      org.kuali.rice.krad.uif.authorization.DocumentAuthorizerBase

All Implemented Interfaces:

Authorizer

Direct Known Subclasses:

MaintenanceDocumentAuthorizerBase

public class DocumentAuthorizerBase
extends AuthorizerBase

Author:

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

Field Summary

static String	EDIT_MODE_DEFAULT_TRUE_VALUE
protected static org.apache.commons.logging.Log	LOG
static String	PRE_ROUTING_ROUTE_NAME
static String	USER_SESSION_METHOD_TO_CALL_COMPLETE_OBJECT_KEY
static String	USER_SESSION_METHOD_TO_CALL_OBJECT_KEY

Constructor Summary

DocumentAuthorizerBase()

Method Summary

protected void	addPermissionDetails(Object dataObject, Map<String,String> attributes) Override this method to populate the permission details from the primary data object or document.
protected void	addRoleQualification(Object dataObject, Map<String,String> attributes) Override this method to populate the role qualifier attributes from the primary data object or document.
protected void	addStandardAttributes(Document document, Map<String,String> attributes)
boolean	canAddNoteAttachment(Document document, String attachmentTypeCode, Person user)
boolean	canDeleteNoteAttachment(Document document, String attachmentTypeCode, String createdBySelfOnly, Person user)
boolean	canEditDocumentOverview(Document document, Person user)
boolean	canInitiate(String documentTypeName, Person user)
boolean	canOpen(Document document, Person user)
boolean	canReceiveAdHoc(Document document, Person user, String actionRequestCode)
boolean	canSendAdHocRequests(Document document, String actionRequestCd, Person user)
protected boolean	canSendAnyTypeAdHocRequests(Document document, Person user)
protected boolean	canTakeRequestedAction(Document document, String actionRequestCode, Person user)
boolean	canViewNoteAttachment(Document document, String attachmentTypeCode, Person user)
Set<String>	getActionFlags(UifFormBase model, Person user, Set<String> documentActions)
protected boolean	isDocumentInitiator(Document document, Person user)

Methods inherited from class org.kuali.rice.krad.uif.authorization.AuthorizerBase

getDataDictionaryService, getEditModes, getKualiModuleService, getPermissionDetailValues, getPermissionService, getPersonService, getRoleQualification, getRoleQualification, getSecurePotentiallyHiddenGroupIds, getSecurePotentiallyReadOnlyGroupIds, 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

Field Detail

LOG

protected static org.apache.commons.logging.Log LOG

PRE_ROUTING_ROUTE_NAME

public static final String PRE_ROUTING_ROUTE_NAME

See Also:

Constant Field Values

EDIT_MODE_DEFAULT_TRUE_VALUE

public static final String EDIT_MODE_DEFAULT_TRUE_VALUE

See Also:

Constant Field Values

USER_SESSION_METHOD_TO_CALL_OBJECT_KEY

public static final String USER_SESSION_METHOD_TO_CALL_OBJECT_KEY

See Also:

Constant Field Values

USER_SESSION_METHOD_TO_CALL_COMPLETE_OBJECT_KEY

public static final String USER_SESSION_METHOD_TO_CALL_COMPLETE_OBJECT_KEY

See Also:

Constant Field Values

Constructor Detail

DocumentAuthorizerBase

public DocumentAuthorizerBase()

Method Detail

getActionFlags

public Set<String> getActionFlags(UifFormBase model,
                                  Person user,
                                  Set<String> documentActions)

Specified by:

getActionFlags in interface Authorizer

Overrides:

getActionFlags in class AuthorizerBase

See Also:

Authorizer.getActionFlags(org.kuali.rice.krad.web.form.UifFormBase, org.kuali.rice.kim.api.identity.Person, java.util.Set)

canInitiate

public final boolean canInitiate(String documentTypeName,
                                 Person user)

canReceiveAdHoc

public final boolean canReceiveAdHoc(Document document,
                                     Person user,
                                     String actionRequestCode)

canOpen

public final boolean canOpen(Document document,
                             Person user)

canAddNoteAttachment

public final boolean canAddNoteAttachment(Document document,
                                          String attachmentTypeCode,
                                          Person user)

canDeleteNoteAttachment

public final boolean canDeleteNoteAttachment(Document document,
                                             String attachmentTypeCode,
                                             String createdBySelfOnly,
                                             Person user)

canViewNoteAttachment

public final boolean canViewNoteAttachment(Document document,
                                           String attachmentTypeCode,
                                           Person user)

canSendAdHocRequests

public final boolean canSendAdHocRequests(Document document,
                                          String actionRequestCd,
                                          Person user)

canEditDocumentOverview

public boolean canEditDocumentOverview(Document document,
                                       Person user)

canSendAnyTypeAdHocRequests

protected final boolean canSendAnyTypeAdHocRequests(Document document,
                                                    Person user)

canTakeRequestedAction

protected boolean canTakeRequestedAction(Document document,
                                         String actionRequestCode,
                                         Person user)

addPermissionDetails

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

Description copied from class: AuthorizerBase

Override this method to populate the permission details from the primary data object or document. This will only be called once per request.

Overrides:

addPermissionDetails in class AuthorizerBase

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

addRoleQualification

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

Description copied from class: AuthorizerBase

Override this method to populate the role qualifier attributes from the primary data object or document. This will only be called once per request.

Overrides:

addRoleQualification in class AuthorizerBase

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

addStandardAttributes

protected void addStandardAttributes(Document document,
                                     Map<String,String> attributes)

isDocumentInitiator

protected boolean isDocumentInitiator(Document document,
                                      Person user)