org.kuali.ole.sec.service

Interface AccessSecurityService

All Known Implementing Classes:

AccessSecurityServiceImpl

public interface AccessSecurityService

Exposes methods to apply access security restrictions to business objects from the various framework points (lookups, inquiries, document accounting lines)

Method Summary

Methods

Modifier and Type	Method and Description
void	applySecurityRestrictions(List<? extends org.kuali.rice.krad.bo.BusinessObject> results, org.kuali.rice.kim.api.identity.Person person, org.kuali.rice.kim.api.common.template.Template permissionTemplate, Map<String,String> additionalPermissionDetails) Retrieves any setup security permissions for the given person and evaluates against List of business objects.
void	applySecurityRestrictionsForGLInquiry(List<? extends org.kuali.rice.krad.bo.BusinessObject> results, org.kuali.rice.kim.api.identity.Person person) Retrieves any setup security permissions (with gl inquiry template) for the given person and evaluates against List of business objects.
void	applySecurityRestrictionsForLookup(List<? extends org.kuali.rice.krad.bo.BusinessObject> results, org.kuali.rice.kim.api.identity.Person person) Retrieves any setup security permissions (with lookup template) for the given person and evaluates against List of business objects.
boolean	canEditDocumentAccountingLine(AccountingDocument document, AccountingLine accountingLine, org.kuali.rice.kim.api.identity.Person person) Checks any edit access security permissions setup for the user and for accounting lines of the given document type
boolean	canEditDocumentAccountingLine(AccountingDocument document, AccountingLine accountingLine, org.kuali.rice.kim.api.identity.Person person, AccessSecurityRestrictionInfo restrictionInfo) Checks any edit access security permissions setup for the user and for accounting lines of the given document type
boolean	canViewDocument(AccountingDocument document, org.kuali.rice.kim.api.identity.Person person, AccessSecurityRestrictionInfo restrictionInfo) Checks view access on all accounting lines contained on the document for given user
boolean	canViewDocumentAccountingLine(AccountingDocument document, AccountingLine accountingLine, org.kuali.rice.kim.api.identity.Person person) Checks any view access security permissions setup for the user and for accounting lines of the given document type
boolean	canViewDocumentNotesAttachments(AccountingDocument document, org.kuali.rice.kim.api.identity.Person person) Checks access is allowed to view document notes based on the document's accounting lines
boolean	canViewGLPE(org.kuali.rice.krad.document.Document document, GeneralLedgerPendingEntry pendingEntry, org.kuali.rice.kim.api.identity.Person person) Calls access security service to check view access on given GLPE for current user.
void	compareListSizeAndAddMessageIfChanged(int previousListSize, List<?> results, String messageKey) Compares the size of the given list against the given previous size and if different adds an info message
Collection<String>	getAccessSecurityControlledDocumentTypeNames() Returns all the documents for which access security controls are in place.
org.kuali.rice.kim.api.common.template.Template	getEditAccountingLineWithFieldValueTemplate() Gets the Edit Accounting Line With Field Value Template Id.
org.kuali.rice.kim.api.common.template.Template	getEditDocumentWithFieldValueTemplate() Gets the Edit Document With Field Value Template Id.
org.kuali.rice.kim.api.common.template.Template	getInquiryWithFieldValueTemplate() Gets the Inquiry With Field Value Template Id.
org.kuali.rice.kim.api.common.template.Template	getLookupWithFieldValueTemplate() Gets the Lookup With Field Value Template Id.
org.kuali.rice.kim.api.common.template.Template	getViewAccountingLineWithFieldValueTemplate() Gets the View Accounting Line With Field Value Template Id.
org.kuali.rice.kim.api.common.template.Template	getViewDocumentWithFieldValueTemplate() Gets the View Document With Field Values template ID.
org.kuali.rice.kim.api.common.template.Template	getViewNotesAttachmentsWithFieldValueTemplate() Gets the View Notes Attachments With Field Value Template Id.
boolean	isAccessSecurityControlledDocumentType(String documentTypeName)

Method Detail

applySecurityRestrictionsForLookup

void applySecurityRestrictionsForLookup(List<? extends org.kuali.rice.krad.bo.BusinessObject> results,
                                      org.kuali.rice.kim.api.identity.Person person)

Retrieves any setup security permissions (with lookup template) for the given person and evaluates against List of business objects. Any instances not passing validation are removed from given list.

Parameters:

results - List of business object instances with data to check

person - Person to apply security for

applySecurityRestrictionsForGLInquiry

void applySecurityRestrictionsForGLInquiry(List<? extends org.kuali.rice.krad.bo.BusinessObject> results,
                                         org.kuali.rice.kim.api.identity.Person person)

Retrieves any setup security permissions (with gl inquiry template) for the given person and evaluates against List of business objects. Any instances not passing validation are removed from given list.

Parameters:

results - List of business object instances with data to check

person - Person to apply security for

applySecurityRestrictions

void applySecurityRestrictions(List<? extends org.kuali.rice.krad.bo.BusinessObject> results,
                             org.kuali.rice.kim.api.identity.Person person,
                             org.kuali.rice.kim.api.common.template.Template permissionTemplate,
                             Map<String,String> additionalPermissionDetails)

Retrieves any setup security permissions for the given person and evaluates against List of business objects. Any instances not passing validation are removed from given list.

Parameters:

results - List of business object instances with data to check

person - Person to apply security for

templateId - KIM template id for permissions to check

additionalPermissionDetails - Any additional details that should be matched on when retrieving permissions

canViewDocumentAccountingLine

boolean canViewDocumentAccountingLine(AccountingDocument document,
                                    AccountingLine accountingLine,
                                    org.kuali.rice.kim.api.identity.Person person)

Checks any view access security permissions setup for the user and for accounting lines of the given document type

Parameters:

document - AccountingDocument that contains the line to be validated, doc type of instance is used for retrieving permissions

accountingLine - AccountingLine instance with values to check

person - the user who we are checking access for

Returns:

boolean true if user has view access for the accounting line, false otherwise

canEditDocumentAccountingLine

boolean canEditDocumentAccountingLine(AccountingDocument document,
                                    AccountingLine accountingLine,
                                    org.kuali.rice.kim.api.identity.Person person)

Checks any edit access security permissions setup for the user and for accounting lines of the given document type

Parameters:

document - AccountingDocument instance that contains the line to be validated, doc type of instance is used for retrieving permissions

accountingLine - AccountingLine instance with values to check

person - the user who we are checking access for

Returns:

boolean true if user has edit access for the accounting line, false otherwise

canEditDocumentAccountingLine

boolean canEditDocumentAccountingLine(AccountingDocument document,
                                    AccountingLine accountingLine,
                                    org.kuali.rice.kim.api.identity.Person person,
                                    AccessSecurityRestrictionInfo restrictionInfo)

Checks any edit access security permissions setup for the user and for accounting lines of the given document type

Parameters:

document - AccountingDocument instance that contains the line to be validated, doc type of instance is used for retrieving permissions

accountingLine - AccountingLine instance with values to check

person - the user who we are checking access for

restrictionInfo - Object providing information on a restriction if one is found

Returns:

boolean true if user has edit access for the accounting line, false otherwise

canViewDocument

boolean canViewDocument(AccountingDocument document,
                      org.kuali.rice.kim.api.identity.Person person,
                      AccessSecurityRestrictionInfo restrictionInfo)

Checks view access on all accounting lines contained on the document for given user

Parameters:

document - AccountingDocument instance with accounting lines to check, doc type of instance is used for retrieving permissions

person - the user who we are checking access for

restrictionInfo - Object providing information on a restriction if one is found

Returns:

boolean true if the user has view access for all accounting lines on the document, false if access is denied on one or more lines

canViewDocumentNotesAttachments

boolean canViewDocumentNotesAttachments(AccountingDocument document,
                                      org.kuali.rice.kim.api.identity.Person person)

Checks access is allowed to view document notes based on the document's accounting lines

Parameters:

document - AccountingDocument instance with accounting lines to check, doc type of instance is used for retrieving permissions

person - the user who we are checking access for

Returns:

boolean true if the user has permission to view the notes/attachments, false otherwise

getViewDocumentWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getViewDocumentWithFieldValueTemplate()

Gets the View Document With Field Values template ID.

Returns:

the View Document With Field Values template ID

getViewAccountingLineWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getViewAccountingLineWithFieldValueTemplate()

Gets the View Accounting Line With Field Value Template Id.

Returns:

the View Accounting Line With Field Value Template Id

getViewNotesAttachmentsWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getViewNotesAttachmentsWithFieldValueTemplate()

Gets the View Notes Attachments With Field Value Template Id.

Returns:

the View Notes Attachments With Field Value Template Id

getEditDocumentWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getEditDocumentWithFieldValueTemplate()

Gets the Edit Document With Field Value Template Id.

Returns:

the Edit Document With Field Value Template Id

getEditAccountingLineWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getEditAccountingLineWithFieldValueTemplate()

Gets the Edit Accounting Line With Field Value Template Id.

Returns:

the Edit Accounting Line With Field Value Template Id

getLookupWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getLookupWithFieldValueTemplate()

Gets the Lookup With Field Value Template Id.

Returns:

the Lookup With Field Value Template Id

getInquiryWithFieldValueTemplate

org.kuali.rice.kim.api.common.template.Template getInquiryWithFieldValueTemplate()

Gets the Inquiry With Field Value Template Id.

Returns:

the InquiryWithFieldValueTemplateId

canViewGLPE

boolean canViewGLPE(org.kuali.rice.krad.document.Document document,
                  GeneralLedgerPendingEntry pendingEntry,
                  org.kuali.rice.kim.api.identity.Person person)

Calls access security service to check view access on given GLPE for current user. Access to view the GLPE on the document should be related to the view permissions for an accounting line with the same account attributes. Called from generalLedgerPendingEntries.tag

Parameters:

pendingEntry - GeneralLedgerPendingEntry to check access for

Returns:

boolean true if given user has view permission, false otherwise

compareListSizeAndAddMessageIfChanged

void compareListSizeAndAddMessageIfChanged(int previousListSize,
                                         List<?> results,
                                         String messageKey)

Compares the size of the given list against the given previous size and if different adds an info message

Parameters:

previousListSize - int giving previous size of list to compare to

results - List to get size for and compare

messageKey - String key of message that should be added

getAccessSecurityControlledDocumentTypeNames

Collection<String> getAccessSecurityControlledDocumentTypeNames()

Returns all the documents for which access security controls are in place.

isAccessSecurityControlledDocumentType

boolean isAccessSecurityControlledDocumentType(String documentTypeName)