org.kuali.kra.common.permissions.rule

Interface PermissionsRule

All Superinterfaces:

org.kuali.rice.krad.rules.rule.BusinessRule

All Known Implementing Classes:

AwardDocumentRule, AwardPermissionsRule, PermissionsRuleBase, ProtocolDocumentRule, ProtocolPermissionsRule, ProtocolPermissionsRule

public interface PermissionsRule
extends org.kuali.rice.krad.rules.rule.BusinessRule

Defines the Business Rule for processing Permissions.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

processAddPermissionsUserBusinessRules

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.

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.

processDeletePermissionsUserBusinessRules

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.

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.

processEditPermissionsUserRolesBusinessRules

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.

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.