org.kuali.kfs.coa.identity
Class OrgReviewRoleLookupableHelperServiceImpl

java.lang.Object
  org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
      org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl
          org.kuali.kfs.coa.identity.OrgReviewRoleLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.lookup.LookupableHelperService

Direct Known Subclasses:

AccountSecurityOrgReviewRoleLookupableHelperServiceImpl

public class OrgReviewRoleLookupableHelperServiceImpl
extends org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

See Also:

Serialized Form

Field Summary

protected static String	ACTIVE
protected static String	ACTIVE_FROM_DATE
protected static String	ACTIVE_TO_DATE
protected static String	DELEGATE
protected static String	DELEGATION_MEMBER_ATTRIBUTE_NAME_KEY
protected static String	DELEGATION_MEMBER_ATTRIBUTE_VALUE_KEY
protected static String	DELEGATION_MEMBER_ID
protected static String	DOCUMENT_TYPE_NAME
static String	MEMBER_ATTRIBUTE_CHART_OF_ACCOUNTS_CODE
protected static String	MEMBER_ATTRIBUTE_NAME_KEY
static String	MEMBER_ATTRIBUTE_ORGANIZATION_CODE
protected static String	MEMBER_ATTRIBUTE_VALUE_KEY
protected static String	MEMBER_GROUP_NAME
protected static String	MEMBER_GROUP_NAMESPACE_CODE
protected static String	MEMBER_ID
protected static String	MEMBER_PRINCIPAL_NAME
protected static String	MEMBER_ROLE_NAME
protected static String	MEMBER_ROLE_NAMESPACE
static String	ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_GROUP
static String	ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_PREFIX
protected static String	SEARCH_CRITERIA_DOCUMENT_TYPE_NAME
protected static String	WILDCARD

Fields inherited from class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

LOG, searchUsingOnlyPrimaryKeyValues

Fields inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

ACTION_URLS_CHILDREN_END, ACTION_URLS_CHILDREN_SEPARATOR, ACTION_URLS_CHILDREN_STARTER, ACTION_URLS_EMPTY, ACTION_URLS_SEPARATOR, backLocation, businessObjectAuthorizationService, businessObjectClass, businessObjectDictionaryService, businessObjectMetaDataService, businessObjectService, configurationService, dataDictionaryService, docFormKey, docNum, encryptionService, fieldConversions, forceLookupResultFieldInquiryCache, inquirableClassCache, kualiInquirable, lookupResultsService, lookupService, maintenanceDocumentDictionaryService, noLookupResultFieldInquiryCache, parameters, parameterService, persistenceStructureService, readOnlyFieldsList, referencesToRefresh, resultColumns, RESULTS_DEFAULT_MAX_COLUMN_LENGTH, rows, sequenceAccessorService, TITLE_ACTION_URL_PREPENDTEXT_PROPERTY, TITLE_RETURN_URL_PREPENDTEXT_PROPERTY

Constructor Summary

OrgReviewRoleLookupableHelperServiceImpl()

Method Summary

protected Map<String,String>	addRoleToConsiderSearchCriteria(String documentTypeName, Map<String,String> searchCriteria)
protected Map<String,String>	buildOrgReviewRoleSearchCriteria(String documentTypeName, Map<String,String> fieldValues)
protected Map<String,String>	buildOrgReviewRoleSearchCriteriaForDelegations(String documentTypeName, Map<String,String> fieldValues)
boolean	currentDocTypeAndChildrenHaveZeroOrgAndAccountReviewRoles(String currentDocumentTypeName)
protected void	filterOrgReview(Map<String,String> fieldValues, List<OrgReviewRole> searchResults)
protected List<OrgReviewRole>	flattenToOrgReviewDelegationMembers(String active, String documentTypeName, List<org.kuali.rice.kim.bo.role.dto.DelegateMemberCompleteInfo> delegationMembers)
protected List<OrgReviewRole>	flattenToOrgReviewMembers(String active, String documentTypeName, List<org.kuali.rice.kim.bo.role.dto.RoleMemberCompleteInfo> members)
protected String	getActionUrlHref(org.kuali.rice.kns.bo.BusinessObject businessObject, String methodToCall, List pkNames)
protected String	getActionUrlTitleText(org.kuali.rice.kns.bo.BusinessObject businessObject, String displayText, List pkNames, org.kuali.rice.kns.authorization.BusinessObjectRestrictions businessObjectRestrictions)
protected org.kuali.rice.ksb.cache.RiceCacheAdministrator	getCacheAdministrator()
String	getClosestOrgReviewRoleParentDocumentTypeName(String documentTypeName)
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getCreateDelegationUrl(org.kuali.rice.kns.bo.BusinessObject businessObject, List pkNames)
List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActionUrls(org.kuali.rice.kns.bo.BusinessObject businessObject, List pkNames)
protected org.kuali.rice.kim.bo.role.impl.KimDelegationImpl	getDelegation(org.kuali.rice.kim.bo.role.impl.KimDelegationMemberImpl delegationMember)
org.kuali.rice.kew.doctype.service.DocumentTypeService	getDocumentTypeService()
org.kuali.rice.kim.bo.Group	getGroup(Map<String,Object> fieldValues)
List<org.kuali.rice.kim.bo.Group>	getGroups(Map<String,Object> fieldValues)
org.kuali.rice.kim.service.GroupService	getGroupService() Gets the groupService attribute.
org.kuali.rice.kim.service.IdentityManagementService	getIdentityManagementService() Gets the identityManagementService attribute.
protected List<? extends org.kuali.rice.kns.bo.BusinessObject>	getMemberSearchResults(Map<String,String> fieldValues)
protected List<String>	getOverridePKNames(OrgReviewRole orr)
org.kuali.rice.kim.bo.Person	getPerson(Map<String,Object> fieldValues)
List<org.kuali.rice.kim.bo.Person>	getPersons(Map<String,Object> fieldValues)
protected String	getQueryString(String parameter)
org.kuali.rice.kim.bo.Role	getRole(Map<String,Object> fieldValues)
org.kuali.rice.kim.service.RoleManagementService	getRoleManagementService()
List<org.kuali.rice.kim.bo.Role>	getRoles(Map<String,Object> fieldValues)
List<String>	getRolesToConsider(String documentTypeName)
List<String>	getRolesToConsider(String documentTypeName, boolean hasOrganizationHierarchy, boolean hasAccountingOrganizationHierarchy, String closestParentDocumentTypeName) 1.
List<? extends org.kuali.rice.kns.bo.BusinessObject>	getSearchResults(Map<String,String> fieldValues)
List<? extends org.kuali.rice.kns.bo.BusinessObject>	getSearchResultsUnbounded(Map<String,String> fieldValues)
protected org.kuali.rice.kim.service.KimTypeInfoService	getTypeInfoService()
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getUrlData(org.kuali.rice.kns.bo.BusinessObject businessObject, String methodToCall, String displayText, List pkNames)
boolean	hasAccountingOrganizationHierarchy(String documentTypeName)
boolean	hasOrganizationHierarchy(String documentTypeName)
boolean	isValidDocumentTypeForOrgReview(String documentTypeName)
Collection	performLookup(org.kuali.rice.kns.web.struts.form.LookupForm lookupForm, Collection resultTable, boolean bounded)
protected List<org.kuali.rice.kim.bo.role.dto.DelegateMemberCompleteInfo>	searchDelegations(Map<String,String> searchCriteriaDelegateMembers)
protected List<org.kuali.rice.kim.bo.role.dto.RoleMemberCompleteInfo>	searchRoleMembers(Map<String,String> searchCriteriaRoleMembers)
void	setGroupService(org.kuali.rice.kim.service.GroupService groupService) Sets the groupService attribute value.
void	setIdentityManagementService(org.kuali.rice.kim.service.IdentityManagementService identityManagementService) Sets the identityManagementService attribute value.
void	setRoleManagementService(org.kuali.rice.kim.service.RoleManagementService roleManagementService)
void	validateDocumentType(String documentTypeName)
void	validateSearchParameters(Map fieldValues)

Methods inherited from class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResultsHelper, hasExternalBusinessObjectProperty, isExternalBusinessObjectProperty, isSearchUsingOnlyPrimaryKeyValues, removeExternalizableBusinessObjectFieldValues

Methods inherited from class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrls, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getDataDictionaryService, getDefaultSortColumns, getDocFormKey, getDocNum, getEmptyActionUrls, getEmptyAnchorHtmlData, getEncryptionService, getExtraField, getInquiryUrl, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getRows, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, preprocessDateFields, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD

protected static final String WILDCARD

See Also:

Constant Field Values

DOCUMENT_TYPE_NAME

protected static final String DOCUMENT_TYPE_NAME

See Also:

Constant Field Values

SEARCH_CRITERIA_DOCUMENT_TYPE_NAME

protected static final String SEARCH_CRITERIA_DOCUMENT_TYPE_NAME

See Also:

Constant Field Values

MEMBER_ATTRIBUTE_CHART_OF_ACCOUNTS_CODE

public static final String MEMBER_ATTRIBUTE_CHART_OF_ACCOUNTS_CODE

See Also:

Constant Field Values

MEMBER_ATTRIBUTE_ORGANIZATION_CODE

public static final String MEMBER_ATTRIBUTE_ORGANIZATION_CODE

See Also:

Constant Field Values

MEMBER_PRINCIPAL_NAME

protected static final String MEMBER_PRINCIPAL_NAME

See Also:

Constant Field Values

MEMBER_GROUP_NAMESPACE_CODE

protected static final String MEMBER_GROUP_NAMESPACE_CODE

See Also:

Constant Field Values

MEMBER_GROUP_NAME

protected static final String MEMBER_GROUP_NAME

See Also:

Constant Field Values

MEMBER_ROLE_NAMESPACE

protected static final String MEMBER_ROLE_NAMESPACE

See Also:

Constant Field Values

MEMBER_ROLE_NAME

protected static final String MEMBER_ROLE_NAME

See Also:

Constant Field Values

MEMBER_ID

protected static final String MEMBER_ID

See Also:

Constant Field Values

MEMBER_ATTRIBUTE_NAME_KEY

protected static final String MEMBER_ATTRIBUTE_NAME_KEY

See Also:

Constant Field Values

MEMBER_ATTRIBUTE_VALUE_KEY

protected static final String MEMBER_ATTRIBUTE_VALUE_KEY

See Also:

Constant Field Values

DELEGATION_MEMBER_ID

protected static final String DELEGATION_MEMBER_ID

See Also:

Constant Field Values

DELEGATION_MEMBER_ATTRIBUTE_NAME_KEY

protected static final String DELEGATION_MEMBER_ATTRIBUTE_NAME_KEY

See Also:

Constant Field Values

DELEGATION_MEMBER_ATTRIBUTE_VALUE_KEY

protected static final String DELEGATION_MEMBER_ATTRIBUTE_VALUE_KEY

See Also:

Constant Field Values

DELEGATE

protected static final String DELEGATE

See Also:

Constant Field Values

ACTIVE

protected static final String ACTIVE

See Also:

Constant Field Values

ACTIVE_FROM_DATE

protected static final String ACTIVE_FROM_DATE

See Also:

Constant Field Values

ACTIVE_TO_DATE

protected static final String ACTIVE_TO_DATE

See Also:

Constant Field Values

ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_GROUP

public static final String ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_GROUP

See Also:

Constant Field Values

ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_PREFIX

public static final String ORG_ACCT_REVIEW_ROLE_DOC_TYPE_CACHE_PREFIX

See Also:

Constant Field Values

Constructor Detail

OrgReviewRoleLookupableHelperServiceImpl

public OrgReviewRoleLookupableHelperServiceImpl()

Method Detail

performLookup

public Collection performLookup(org.kuali.rice.kns.web.struts.form.LookupForm lookupForm,
                                Collection resultTable,
                                boolean bounded)

Specified by:

performLookup in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

performLookup in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getCustomActionUrls

public List<org.kuali.rice.kns.lookup.HtmlData> getCustomActionUrls(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                                    List pkNames)

Specified by:

getCustomActionUrls in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getCustomActionUrls in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getUrlData

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getUrlData(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                                       String methodToCall,
                                                                       String displayText,
                                                                       List pkNames)

Overrides:

getUrlData in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getCreateDelegationUrl

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getCreateDelegationUrl(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                                                                   List pkNames)

getActionUrlHref

protected String getActionUrlHref(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                  String methodToCall,
                                  List pkNames)

Overrides:

getActionUrlHref in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getOverridePKNames

protected List<String> getOverridePKNames(OrgReviewRole orr)

getActionUrlTitleText

protected String getActionUrlTitleText(org.kuali.rice.kns.bo.BusinessObject businessObject,
                                       String displayText,
                                       List pkNames,
                                       org.kuali.rice.kns.authorization.BusinessObjectRestrictions businessObjectRestrictions)

Overrides:

getActionUrlTitleText in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getSearchResults

public List<? extends org.kuali.rice.kns.bo.BusinessObject> getSearchResults(Map<String,String> fieldValues)

Specified by:

getSearchResults in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getSearchResults in class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

getSearchResultsUnbounded

public List<? extends org.kuali.rice.kns.bo.BusinessObject> getSearchResultsUnbounded(Map<String,String> fieldValues)

Specified by:

getSearchResultsUnbounded in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

getSearchResultsUnbounded in class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

See Also:

KualiLookupableHelperServiceImpl.getSearchResultsUnbounded(java.util.Map)

getMemberSearchResults

protected List<? extends org.kuali.rice.kns.bo.BusinessObject> getMemberSearchResults(Map<String,String> fieldValues)

filterOrgReview

protected void filterOrgReview(Map<String,String> fieldValues,
                               List<OrgReviewRole> searchResults)

addRoleToConsiderSearchCriteria

protected Map<String,String> addRoleToConsiderSearchCriteria(String documentTypeName,
                                                             Map<String,String> searchCriteria)

searchRoleMembers

protected List<org.kuali.rice.kim.bo.role.dto.RoleMemberCompleteInfo> searchRoleMembers(Map<String,String> searchCriteriaRoleMembers)

searchDelegations

protected List<org.kuali.rice.kim.bo.role.dto.DelegateMemberCompleteInfo> searchDelegations(Map<String,String> searchCriteriaDelegateMembers)

hasOrganizationHierarchy

public boolean hasOrganizationHierarchy(String documentTypeName)

hasAccountingOrganizationHierarchy

public boolean hasAccountingOrganizationHierarchy(String documentTypeName)

getClosestOrgReviewRoleParentDocumentTypeName

public String getClosestOrgReviewRoleParentDocumentTypeName(String documentTypeName)

getRolesToConsider

public List<String> getRolesToConsider(String documentTypeName)

getRolesToConsider

public List<String> getRolesToConsider(String documentTypeName,
                                       boolean hasOrganizationHierarchy,
                                       boolean hasAccountingOrganizationHierarchy,
                                       String closestParentDocumentTypeName)

1. Check WorkflowInfo.hasNode(documentTypeName, nodeName) to see if the document type selected has OrganizationHierarchy and/or AccountingOrganizationHierarchy - if it has either or both, set the Review Types radio group appropriately and make it read only. 2. Else, if KFS is the document type selected, set the Review Types radio group to both and leave it editable. 3. Else, if FinancialSystemTransactionalDocument is the closest parent (per KimCommonUtils.getClosestParent), set the Review Types radio group to Organization Accounting Only and leave it editable. 4. Else, if FinancialSystemComplexMaintenanceDocument is the closest parent (per KimCommonUtils.getClosestParent), set the Review Types radio group to Organization Only and make read-only. 5. Else, if FinancialSystemSimpleMaintenanceDocument is the closest parent (per KimCommonUtils.getClosestParent), this makes no sense and should generate an error.

Parameters:

documentTypeName -

hasOrganizationHierarchy -

hasAccountingOrganizationHierarchy -

closestParentDocumentTypeName -

Returns:

isValidDocumentTypeForOrgReview

public boolean isValidDocumentTypeForOrgReview(String documentTypeName)

currentDocTypeAndChildrenHaveZeroOrgAndAccountReviewRoles

public boolean currentDocTypeAndChildrenHaveZeroOrgAndAccountReviewRoles(String currentDocumentTypeName)

flattenToOrgReviewMembers

protected List<OrgReviewRole> flattenToOrgReviewMembers(String active,
                                                        String documentTypeName,
                                                        List<org.kuali.rice.kim.bo.role.dto.RoleMemberCompleteInfo> members)

flattenToOrgReviewDelegationMembers

protected List<OrgReviewRole> flattenToOrgReviewDelegationMembers(String active,
                                                                  String documentTypeName,
                                                                  List<org.kuali.rice.kim.bo.role.dto.DelegateMemberCompleteInfo> delegationMembers)

getDelegation

protected org.kuali.rice.kim.bo.role.impl.KimDelegationImpl getDelegation(org.kuali.rice.kim.bo.role.impl.KimDelegationMemberImpl delegationMember)

getQueryString

protected String getQueryString(String parameter)

getPerson

public org.kuali.rice.kim.bo.Person getPerson(Map<String,Object> fieldValues)

getPersons

public List<org.kuali.rice.kim.bo.Person> getPersons(Map<String,Object> fieldValues)

getRole

public org.kuali.rice.kim.bo.Role getRole(Map<String,Object> fieldValues)

getRoles

public List<org.kuali.rice.kim.bo.Role> getRoles(Map<String,Object> fieldValues)

getGroup

public org.kuali.rice.kim.bo.Group getGroup(Map<String,Object> fieldValues)

getGroups

public List<org.kuali.rice.kim.bo.Group> getGroups(Map<String,Object> fieldValues)

buildOrgReviewRoleSearchCriteria

protected Map<String,String> buildOrgReviewRoleSearchCriteria(String documentTypeName,
                                                              Map<String,String> fieldValues)

buildOrgReviewRoleSearchCriteriaForDelegations

protected Map<String,String> buildOrgReviewRoleSearchCriteriaForDelegations(String documentTypeName,
                                                                            Map<String,String> fieldValues)

getRoleManagementService

public org.kuali.rice.kim.service.RoleManagementService getRoleManagementService()

Returns:

the roleService

setRoleManagementService

public void setRoleManagementService(org.kuali.rice.kim.service.RoleManagementService roleManagementService)

Parameters:

roleService - the roleService to set

getDocumentTypeService

public org.kuali.rice.kew.doctype.service.DocumentTypeService getDocumentTypeService()

validateDocumentType

public void validateDocumentType(String documentTypeName)

validateSearchParameters

public void validateSearchParameters(Map fieldValues)

Specified by:

validateSearchParameters in interface org.kuali.rice.kns.lookup.LookupableHelperService

Overrides:

validateSearchParameters in class org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

getGroupService

public org.kuali.rice.kim.service.GroupService getGroupService()

Gets the groupService attribute.

Returns:

Returns the groupService.

setGroupService

public void setGroupService(org.kuali.rice.kim.service.GroupService groupService)

Sets the groupService attribute value.

Parameters:

groupService - The groupService to set.

getIdentityManagementService

public org.kuali.rice.kim.service.IdentityManagementService getIdentityManagementService()

Gets the identityManagementService attribute.

Returns:

Returns the identityManagementService.

setIdentityManagementService

public void setIdentityManagementService(org.kuali.rice.kim.service.IdentityManagementService identityManagementService)

Sets the identityManagementService attribute value.

Parameters:

identityManagementService - The identityManagementService to set.

getTypeInfoService

protected org.kuali.rice.kim.service.KimTypeInfoService getTypeInfoService()

getCacheAdministrator

protected org.kuali.rice.ksb.cache.RiceCacheAdministrator getCacheAdministrator()