org.kuali.rice.kim.lookup
Class RoleMemberLookupableHelperServiceImpl

java.lang.Object
  org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl
      org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl
          org.kuali.rice.kim.lookup.KimLookupableHelperServiceImpl
              org.kuali.rice.kim.lookup.RoleMemberLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, LookupableHelperService

Direct Known Subclasses:

PermissionLookupableHelperServiceImpl, ResponsibilityLookupableHelperServiceImpl

public abstract class RoleMemberLookupableHelperServiceImpl
extends KimLookupableHelperServiceImpl

This is a description of what this class does - bhargavp don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

protected static String	ASSIGNED_TO_GROUP_NAME
protected static String	ASSIGNED_TO_GROUP_NAMESPACE_CODE
protected static String	ASSIGNED_TO_NAMESPACE_FOR_LOOKUP
protected static String	ASSIGNED_TO_PRINCIPAL_NAME
protected static String	ASSIGNED_TO_ROLE_MEMBER_ID
protected static String	ASSIGNED_TO_ROLE_NAME
protected static String	ASSIGNED_TO_ROLE_NAMESPACE_CODE
protected static String	ASSIGNED_TO_ROLE_ROLE_NAME
protected static String	ATTRIBUTE_NAME
protected static String	ATTRIBUTE_VALUE
protected static String	DETAIL_CRITERIA
protected static String	DETAIL_OBJECTS_ATTRIBUTE_NAME
protected static String	DETAIL_OBJECTS_ATTRIBUTE_VALUE
protected static String	GROUP_NAME
protected static String	NAME
protected static String	NAMESPACE_CODE
protected static String	TEMPLATE_NAME
protected static String	TEMPLATE_NAMESPACE_CODE
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

RoleMemberLookupableHelperServiceImpl()

Method Summary

protected Map<String,String>	buildRoleSearchCriteria(Map<String,String> fieldValues)
protected Map<String,String>	buildSearchCriteria(Map<String,String> fieldValues)
protected Long	getActualSizeIfTruncated(List result)
protected abstract List<? extends BusinessObject>	getMemberSearchResults(Map<String,String> searchCriteria, boolean unbounded)
protected String	getQueryString(String parameter)
List<Row>	getRows() This overridden method ...
protected List<? extends BusinessObject>	getSearchResultsHelper(Map<String,String> fieldValues, boolean unbounded) This method does the actual search, with the parameters specified, and returns the result.
protected boolean	isMapSubset(AttributeSet mainMap, AttributeSet subsetMap) Checks whether the 2nd map is a subset of the first.
protected AttributeSet	parseDetailCriteria(String detailCritiera) Converts a special criteria string that is in the form key=value,key2=value2 into a map
protected List<RoleImpl>	searchRoles(Map<String,String> roleSearchCriteria, boolean unbounded)
void	validateSearchParameters(Map fieldValues) - detail value: if this is provided a full (template namespace and template name) or namespace must be supplied - may need to do further restrictions once we see how this performs

Methods inherited from class org.kuali.rice.kim.lookup.KimLookupableHelperServiceImpl

allowsNewOrCopyAction, getDocumentHelperService, getTypeInfoService

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

getExternalBusinessObjectProperty, getExternalizableBusinessObjectClass, getExternalizableBusinessObjectFieldValues, getExternalizableBusinessObjectProperties, getPrimaryKeyFieldLabels, getSearchResults, getSearchResultsUnbounded, hasExternalBusinessObjectProperty, isExternalBusinessObjectProperty, isSearchUsingOnlyPrimaryKeyValues, removeExternalizableBusinessObjectFieldValues

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

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrlHref, getActionUrls, getActionUrlTitleText, getBackLocation, getBusinessObjectAuthorizationService, getBusinessObjectClass, getBusinessObjectDictionaryService, getBusinessObjectMetaDataService, getBusinessObjectService, getColumnMaxLength, getColumns, getConditionallyHiddenPropertyNames, getConditionallyReadOnlyPropertyNames, getConditionallyRequiredPropertyNames, getCurrentSearchFieldValue, getCustomActionUrls, 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, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, performLookup, 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

DETAIL_CRITERIA

protected static final String DETAIL_CRITERIA

See Also:

Constant Field Values

WILDCARD

protected static final String WILDCARD

See Also:

Constant Field Values

TEMPLATE_NAMESPACE_CODE

protected static final String TEMPLATE_NAMESPACE_CODE

See Also:

Constant Field Values

TEMPLATE_NAME

protected static final String TEMPLATE_NAME

See Also:

Constant Field Values

NAMESPACE_CODE

protected static final String NAMESPACE_CODE

See Also:

Constant Field Values

NAME

protected static final String NAME

See Also:

Constant Field Values

GROUP_NAME

protected static final String GROUP_NAME

See Also:

Constant Field Values

ASSIGNED_TO_PRINCIPAL_NAME

protected static final String ASSIGNED_TO_PRINCIPAL_NAME

See Also:

Constant Field Values

ASSIGNED_TO_GROUP_NAMESPACE_CODE

protected static final String ASSIGNED_TO_GROUP_NAMESPACE_CODE

See Also:

Constant Field Values

ASSIGNED_TO_GROUP_NAME

protected static final String ASSIGNED_TO_GROUP_NAME

See Also:

Constant Field Values

ASSIGNED_TO_NAMESPACE_FOR_LOOKUP

protected static final String ASSIGNED_TO_NAMESPACE_FOR_LOOKUP

See Also:

Constant Field Values

ASSIGNED_TO_ROLE_NAME

protected static final String ASSIGNED_TO_ROLE_NAME

See Also:

Constant Field Values

ATTRIBUTE_NAME

protected static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_VALUE

protected static final String ATTRIBUTE_VALUE

See Also:

Constant Field Values

ASSIGNED_TO_ROLE_NAMESPACE_CODE

protected static final String ASSIGNED_TO_ROLE_NAMESPACE_CODE

See Also:

Constant Field Values

ASSIGNED_TO_ROLE_ROLE_NAME

protected static final String ASSIGNED_TO_ROLE_ROLE_NAME

See Also:

Constant Field Values

ASSIGNED_TO_ROLE_MEMBER_ID

protected static final String ASSIGNED_TO_ROLE_MEMBER_ID

See Also:

Constant Field Values

DETAIL_OBJECTS_ATTRIBUTE_VALUE

protected static final String DETAIL_OBJECTS_ATTRIBUTE_VALUE

See Also:

Constant Field Values

DETAIL_OBJECTS_ATTRIBUTE_NAME

protected static final String DETAIL_OBJECTS_ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

RoleMemberLookupableHelperServiceImpl

public RoleMemberLookupableHelperServiceImpl()

Method Detail

getSearchResultsHelper

protected List<? extends BusinessObject> getSearchResultsHelper(Map<String,String> fieldValues,
                                                                boolean unbounded)

Description copied from class: KualiLookupableHelperServiceImpl

This method does the actual search, with the parameters specified, and returns the result. NOTE that it will not do any upper-casing based on the DD forceUppercase. That is handled through an external call to LookupUtils.forceUppercase().

Overrides:

getSearchResultsHelper in class KualiLookupableHelperServiceImpl

Parameters:

fieldValues - A Map of the fieldNames and fieldValues to be searched on.

unbounded - Whether the results should be bounded or not to a certain max size.

Returns:

A List of search results.

getMemberSearchResults

protected abstract List<? extends BusinessObject> getMemberSearchResults(Map<String,String> searchCriteria,
                                                                         boolean unbounded)

buildSearchCriteria

protected Map<String,String> buildSearchCriteria(Map<String,String> fieldValues)

getQueryString

protected String getQueryString(String parameter)

validateSearchParameters

public void validateSearchParameters(Map fieldValues)

- detail value: if this is provided a full (template namespace and template name) or namespace must be supplied - may need to do further restrictions once we see how this performs

Specified by:

validateSearchParameters in interface LookupableHelperService

Overrides:

validateSearchParameters in class AbstractLookupableHelperServiceImpl

Parameters:

fieldValues - the values of the query

See Also:

AbstractLookupableHelperServiceImpl.validateSearchParameters(java.util.Map)

buildRoleSearchCriteria

protected Map<String,String> buildRoleSearchCriteria(Map<String,String> fieldValues)

isMapSubset

protected boolean isMapSubset(AttributeSet mainMap,
                              AttributeSet subsetMap)

Checks whether the 2nd map is a subset of the first.

parseDetailCriteria

protected AttributeSet parseDetailCriteria(String detailCritiera)

Converts a special criteria string that is in the form key=value,key2=value2 into a map

getRows

public List<Row> getRows()

This overridden method ...

Specified by:

getRows in interface LookupableHelperService

Overrides:

getRows in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

AbstractLookupableHelperServiceImpl.getRows()

getActualSizeIfTruncated

protected Long getActualSizeIfTruncated(List result)

searchRoles

protected List<RoleImpl> searchRoles(Map<String,String> roleSearchCriteria,
                                     boolean unbounded)