org.kuali.kfs.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

void	applySecurityRestrictions(List<? extends org.kuali.rice.kns.bo.BusinessObject> results, org.kuali.rice.kim.bo.Person person, String templateId, org.kuali.rice.kim.bo.types.dto.AttributeSet additionalPermissionDetails) Retrieves any setup security permissions for the given person and evaluates against List of business objects.
void	applySecurityRestrictionsForGLInquiry(List<? extends org.kuali.rice.kns.bo.BusinessObject> results, org.kuali.rice.kim.bo.Person person) Retrieves any setup security permissions (with gl inquiry template) for the given person and evaluates against List of business objects.
void	applySecurityRestrictionsForLaborInquiry(List<? extends org.kuali.rice.kns.bo.BusinessObject> results, org.kuali.rice.kim.bo.Person person) Retrieves any setup security permissions (with ld inquiry template) for the given person and evaluates against List of business objects.
void	applySecurityRestrictionsForLookup(List<? extends org.kuali.rice.kns.bo.BusinessObject> results, org.kuali.rice.kim.bo.Person person) Retrieves any setup security permissions (with lookup template) for the given person and evaluates against List of business objects.
boolean	canEditDocument(AccountingDocument document, org.kuali.rice.kim.bo.Person person) Checks edit access on all accounting lines contained on the document for given user
boolean	canEditDocumentAccountingLine(AccountingDocument document, AccountingLine accountingLine, org.kuali.rice.kim.bo.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.bo.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.bo.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.bo.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.bo.Person person) Checks access is allowed to view document notes based on the document's accounting lines
boolean	checkSecurityRestrictionsForBusinessObject(org.kuali.rice.kns.bo.BusinessObject businessObject, org.kuali.rice.kim.bo.Person person, AccessSecurityRestrictionInfo restrictionInfo) Retrieves any access security permissions that are assigned to the user and applicable for the given business object, then evaluates permissions against the business object instance
String	getEditAccountingLineWithFieldValueTemplateId() Gets the Edit Accounting Line With Field Value Template Id.
String	getEditDocumentWithFieldValueTemplateId() Gets the Edit Document With Field Value Template Id.
String	getInquiryWithFieldValueTemplateId() Gets the Inquiry With Field Value Template Id.
String	getLookupWithFieldValueTemplateId() Gets the Lookup With Field Value Template Id.
String	getViewAccountingLineWithFieldValueTemplateId() Gets the View Accounting Line With Field Value Template Id.
String	getViewDocumentWithFieldValueTemplateId() Gets the View Document With Field Values template ID.
String	getViewNotesAttachmentsWithFieldValueTemplateId() Gets the View Notes Attachments With Field Value Template Id.

Method Detail

applySecurityRestrictionsForLookup

void applySecurityRestrictionsForLookup(List<? extends org.kuali.rice.kns.bo.BusinessObject> results,
                                        org.kuali.rice.kim.bo.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.kns.bo.BusinessObject> results,
                                           org.kuali.rice.kim.bo.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

applySecurityRestrictionsForLaborInquiry

void applySecurityRestrictionsForLaborInquiry(List<? extends org.kuali.rice.kns.bo.BusinessObject> results,
                                              org.kuali.rice.kim.bo.Person person)

Retrieves any setup security permissions (with ld 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.kns.bo.BusinessObject> results,
                               org.kuali.rice.kim.bo.Person person,
                               String templateId,
                               org.kuali.rice.kim.bo.types.dto.AttributeSet 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

checkSecurityRestrictionsForBusinessObject

boolean checkSecurityRestrictionsForBusinessObject(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                   org.kuali.rice.kim.bo.Person person,
                                                   AccessSecurityRestrictionInfo restrictionInfo)

Retrieves any access security permissions that are assigned to the user and applicable for the given business object, then evaluates permissions against the business object instance

Parameters:

businessObject - BusinessObject instance to check access permissions against

person - Person to retrieve access permissions for

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

Returns:

boolean true if all access permissions pass (or none are found), false if at least one access permission fails

canViewDocumentAccountingLine

boolean canViewDocumentAccountingLine(AccountingDocument document,
                                      AccountingLine accountingLine,
                                      org.kuali.rice.kim.bo.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.bo.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.bo.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.bo.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

canEditDocument

boolean canEditDocument(AccountingDocument document,
                        org.kuali.rice.kim.bo.Person person)

Checks edit 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

Returns:

boolean true if the user has edit 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.bo.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

getViewDocumentWithFieldValueTemplateId

String getViewDocumentWithFieldValueTemplateId()

Gets the View Document With Field Values template ID.

Returns:

the View Document With Field Values template ID

getViewAccountingLineWithFieldValueTemplateId

String getViewAccountingLineWithFieldValueTemplateId()

Gets the View Accounting Line With Field Value Template Id.

Returns:

the View Accounting Line With Field Value Template Id

getViewNotesAttachmentsWithFieldValueTemplateId

String getViewNotesAttachmentsWithFieldValueTemplateId()

Gets the View Notes Attachments With Field Value Template Id.

Returns:

the View Notes Attachments With Field Value Template Id

getEditDocumentWithFieldValueTemplateId

String getEditDocumentWithFieldValueTemplateId()

Gets the Edit Document With Field Value Template Id.

Returns:

the Edit Document With Field Value Template Id

getEditAccountingLineWithFieldValueTemplateId

String getEditAccountingLineWithFieldValueTemplateId()

Gets the Edit Accounting Line With Field Value Template Id.

Returns:

the Edit Accounting Line With Field Value Template Id

getLookupWithFieldValueTemplateId

String getLookupWithFieldValueTemplateId()

Gets the Lookup With Field Value Template Id.

Returns:

the Lookup With Field Value Template Id

getInquiryWithFieldValueTemplateId

String getInquiryWithFieldValueTemplateId()

Gets the Inquiry With Field Value Template Id.

Returns:

the InquiryWithFieldValueTemplateId