org.kuali.kra.common.permissions.rules

Class PermissionsRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.common.permissions.rules.PermissionsRuleBase

All Implemented Interfaces:

PermissionsRule, org.kuali.rice.krad.rules.rule.AddAdHocRoutePersonRule, org.kuali.rice.krad.rules.rule.AddAdHocRouteWorkgroupRule, org.kuali.rice.krad.rules.rule.AddNoteRule, org.kuali.rice.krad.rules.rule.ApproveDocumentRule, org.kuali.rice.krad.rules.rule.BusinessRule, org.kuali.rice.krad.rules.rule.CompleteDocumentRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule, org.kuali.rice.krad.rules.rule.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

Direct Known Subclasses:

AwardPermissionsRule, ProtocolPermissionsRule, ProtocolPermissionsRule

public abstract class PermissionsRuleBase
extends ResearchDocumentRuleBase
implements PermissionsRule

Business Rule to determine the legality of modifying the access to a Document. Please see the Permissions tab web page.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Field Summary

Fields inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME, DOCUMENT_ERROR_PATH, VALIDATION_REQUIRED

Constructor Summary

Constructors

Constructor and Description
PermissionsRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getAdministratorRoleName() Get the name of the role for the Administrator.
protected KcPersonService	getKcPersonService() Gets the KC Person Service.
boolean	processAddPermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, PermissionsUser newUser) Determines the legality of adding a user with a given role to a document.
boolean	processDeletePermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, int index) Determines the legality of deleting a user from the given document.
boolean	processEditPermissionsUserRolesBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, PermissionsUserEditRoles editRoles) Determines if it is legal to edit the roles for a user.

Methods inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, processRunAuditBusinessRules, reportError, reportErrorWithoutFullErrorPath, reportSoftError, reportWarning, setBusinessObjectService, setParameterService

Methods inherited from class org.kuali.rice.krad.rules.DocumentRuleBase

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDictionaryValidationService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, getPersonService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processApproveDocument, processCompleteDocument, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomCompleteDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, processRouteDocument, processSaveDocument, processSendAdHocRequests, setDocumentDictionaryService, setMaxDictionaryValidationDepth, useKimPermission, validateSensitiveDataValue

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsRuleBase

public PermissionsRuleBase()

Method Detail

processAddPermissionsUserBusinessRules

public boolean processAddPermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document,
                                             List<User> users,
                                             PermissionsUser newUser)

Description copied from interface: PermissionsRule

Determines the legality of adding a user with a given role to a document.

Specified by:

processAddPermissionsUserBusinessRules in interface PermissionsRule

Parameters:

document - the document.

users - the current list of users who have a role in the document

newUser - the new user to add to the document

Returns:

true if the addition is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processAddPermissionsUserBusinessRules(org.kuali.core.document.Document, java.util.List, org.kuali.kra.common.permissions.bo.PermissionsUser)

processDeletePermissionsUserBusinessRules

public boolean processDeletePermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document,
                                                List<User> users,
                                                int index)

Description copied from interface: PermissionsRule

Determines the legality of deleting a user from the given document.

Specified by:

processDeletePermissionsUserBusinessRules in interface PermissionsRule

Parameters:

document - the document.

users - list of current users who have a role in the document

index - the index into "users" of the user to delete

Returns:

true if the deletion is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processDeletePermissionsUserBusinessRules(org.kuali.core.document.Document, java.util.List, int)

processEditPermissionsUserRolesBusinessRules

public boolean processEditPermissionsUserRolesBusinessRules(org.kuali.rice.krad.document.Document document,
                                                   List<User> users,
                                                   PermissionsUserEditRoles editRoles)

Description copied from interface: PermissionsRule

Determines if it is legal to edit the roles for a user.

Specified by:

processEditPermissionsUserRolesBusinessRules in interface PermissionsRule

Parameters:

document - the document.

users - list of current users who have a role in the document

editRoles - the new set of roles for the user

Returns:

true if the role change is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processEditPermissionsUserRolesBusinessRules(org.kuali.core.document.Document, java.util.List, org.kuali.kra.common.permissions.bo.PermissionsUserEditRoles)

getAdministratorRoleName

protected abstract String getAdministratorRoleName()

Get the name of the role for the Administrator. The term "Administrator" is generic. It refers to the a role which has full access to a document. For example, the "Protocol Aggregator" is the name of the administrative role for a Protocol. Since different documents will have different administrative roles, the subclass must provide this value.

Returns:

the name of the role for the Administrator

getKcPersonService

protected KcPersonService getKcPersonService()

Gets the KC Person Service.

Returns:

KC Person Service.