org.kuali.rice.kim.lookup

Class RoleLookupableHelperServiceImpl

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.RoleLookupableHelperServiceImpl

All Implemented Interfaces:

Serializable, LookupableHelperService

public class RoleLookupableHelperServiceImpl
extends KimLookupableHelperServiceImpl

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

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GROUP_CRITERIA
protected static String	LOOKUP_PARM_PERMISSION_NAME
protected static String	LOOKUP_PARM_PERMISSION_NAMESPACE
protected static String	LOOKUP_PARM_PERMISSION_TEMPLATE_NAME
protected static String	LOOKUP_PARM_PERMISSION_TEMPLATE_NAMESPACE
protected static String	LOOKUP_PARM_RESP_NAME
protected static String	LOOKUP_PARM_RESP_NAMESPACE
protected static String	LOOKUP_PARM_RESP_TEMPLATE_NAME
protected static String	LOOKUP_PARM_RESP_TEMPLATE_NAMESPACE
protected static String	OTHER_CRITERIA
protected static List<String>	PERM_FIELD_NAMES
protected static String	PERMISSION_CRITERIA
protected static List<String>	RESP_FIELD_NAMES
protected static String	RESPONSIBILITY_CRITERIA
protected static String	ROLE_MEMBER_ATTRIBUTE_CRITERIA

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

Constructors

Constructor and Description
RoleLookupableHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	allowsMaintenanceEditAction(BusinessObject businessObject) This overridden method ...
boolean	allowsMaintenanceNewOrCopyAction() This overridden method ...
List<KimAttributeField>	getAttrDefinitions()
List<Row>	getAttrRows()
List<HtmlData>	getCustomActionUrls(BusinessObject bo, List pkNames) Child classes should override this method if they want to return some other action urls.
static String	getCustomRoleInquiryHref(String href)
protected HtmlData	getEditRoleUrl(RoleBo roleBo)
protected Collection<String>	getGroupCriteriaRoleIds(Map<String,String> groupCrit)
protected String	getMaintenanceDocumentTypeName() This overridden method ...
protected Collection<String>	getPermissionRoleIds(Map<String,String> permCrit)
protected Collection<String>	getResponsibilityRoleIds(Map<String,String> respCrit)
protected HtmlData	getReturnAnchorHtmlData(BusinessObject businessObject, Properties parameters, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
QueryByCriteria	getRoleCriteria(Map<String,String> fieldValues) This method will generate a QueryByCriteria which locates the roles matching the criteria passed into the fieldValues parameter, or null if the search would return zero results.
protected Collection<String>	getRoleIdsForPrincipalName(String principalName)
List<Row>	getRoleRows()
List<Row>	getRows() Returns a list of Row objects to be used to generate the search query screen Generally, setDataObjectClass needs to be called with a non-null value for proper operation
List<? extends BusinessObject>	getSearchResults(Map<String,String> fieldValues) Uses Lookup Service to provide a basic search.
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.
String	getTypeId()
void	setAttrDefinitions(List<KimAttributeField> attrDefinitions)
void	setAttrRows(List<Row> attrRows)
void	setRoleRows(List<Row> roleRows)
void	setTypeId(String typeId)

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, getSearchResultsUnbounded, hasExternalBusinessObjectProperty, isExternalBusinessObjectProperty, isSearchUsingOnlyPrimaryKeyValues, removeExternalizableBusinessObjectFieldValues

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

addToReturnHref, allowsMaintenanceDeleteAction, applyConditionalLogicForFieldDisplay, applyFieldAuthorizationsFromNestedLookups, checkForAdditionalFields, getActionUrlHref, getActionUrls, getActionUrlTitleText, 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, getMaintenanceUrl, getParameters, getParameters, getParameterService, getParametersFromPrimaryKey, getPersistenceStructureService, getPropertyClass, getReadOnlyFieldsList, getReferencesToRefresh, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, performLookup, setBackLocation, setBusinessObjectClass, setBusinessObjectDictionaryService, setBusinessObjectMetaDataService, setBusinessObjectService, setDataDictionaryService, setDocFormKey, setDocNum, setEncryptionService, setFieldConversions, setKualiInquirable, setLookupResultsService, setLookupService, setMaintenanceDocumentDictionaryService, setParameters, setParameterService, setParameterService, setPersistenceStructureService, setReadOnlyFieldsList, setReferencesToRefresh, setRows, setSequenceAccessorService, shouldDisplayHeaderNonMaintActions, shouldDisplayLookupCriteria, validateSearchParameters, validateSearchParameterWildcardAndOperators

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_CRITERIA

protected static final String GROUP_CRITERIA

See Also:

Constant Field Values

RESPONSIBILITY_CRITERIA

protected static final String RESPONSIBILITY_CRITERIA

See Also:

Constant Field Values

PERMISSION_CRITERIA

protected static final String PERMISSION_CRITERIA

See Also:

Constant Field Values

ROLE_MEMBER_ATTRIBUTE_CRITERIA

protected static final String ROLE_MEMBER_ATTRIBUTE_CRITERIA

See Also:

Constant Field Values

OTHER_CRITERIA

protected static final String OTHER_CRITERIA

See Also:

Constant Field Values

LOOKUP_PARM_PERMISSION_TEMPLATE_NAMESPACE

protected static final String LOOKUP_PARM_PERMISSION_TEMPLATE_NAMESPACE

See Also:

Constant Field Values

LOOKUP_PARM_PERMISSION_TEMPLATE_NAME

protected static final String LOOKUP_PARM_PERMISSION_TEMPLATE_NAME

See Also:

Constant Field Values

LOOKUP_PARM_PERMISSION_NAMESPACE

protected static final String LOOKUP_PARM_PERMISSION_NAMESPACE

See Also:

Constant Field Values

LOOKUP_PARM_PERMISSION_NAME

protected static final String LOOKUP_PARM_PERMISSION_NAME

See Also:

Constant Field Values

LOOKUP_PARM_RESP_TEMPLATE_NAMESPACE

protected static final String LOOKUP_PARM_RESP_TEMPLATE_NAMESPACE

See Also:

Constant Field Values

LOOKUP_PARM_RESP_TEMPLATE_NAME

protected static final String LOOKUP_PARM_RESP_TEMPLATE_NAME

See Also:

Constant Field Values

LOOKUP_PARM_RESP_NAMESPACE

protected static final String LOOKUP_PARM_RESP_NAMESPACE

See Also:

Constant Field Values

LOOKUP_PARM_RESP_NAME

protected static final String LOOKUP_PARM_RESP_NAME

See Also:

Constant Field Values

PERM_FIELD_NAMES

protected static List<String> PERM_FIELD_NAMES

RESP_FIELD_NAMES

protected static List<String> RESP_FIELD_NAMES

Constructor Detail

RoleLookupableHelperServiceImpl

public RoleLookupableHelperServiceImpl()

Method Detail

allowsMaintenanceNewOrCopyAction

public boolean allowsMaintenanceNewOrCopyAction()

This overridden method ...

Specified by:

allowsMaintenanceNewOrCopyAction in interface LookupableHelperService

Overrides:

allowsMaintenanceNewOrCopyAction in class AbstractLookupableHelperServiceImpl

Returns:

true if bo has maint doc that allows new or copy actions

See Also:

AbstractLookupableHelperServiceImpl.allowsMaintenanceNewOrCopyAction()

allowsMaintenanceEditAction

protected boolean allowsMaintenanceEditAction(BusinessObject businessObject)

This overridden method ...

Overrides:

allowsMaintenanceEditAction in class AbstractLookupableHelperServiceImpl

See Also:

AbstractLookupableHelperServiceImpl.allowsMaintenanceEditAction(org.kuali.rice.krad.bo.BusinessObject)

getCustomActionUrls

public List<HtmlData> getCustomActionUrls(BusinessObject bo,
                                 List pkNames)

Description copied from class: AbstractLookupableHelperServiceImpl

Child classes should override this method if they want to return some other action urls.

Specified by:

getCustomActionUrls in interface LookupableHelperService

Overrides:

getCustomActionUrls in class AbstractLookupableHelperServiceImpl

Returns:

See Also:

LookupableHelperService#getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject, java.util.List, java.util.List pkNames)

getEditRoleUrl

protected HtmlData getEditRoleUrl(RoleBo roleBo)

getReturnAnchorHtmlData

protected HtmlData getReturnAnchorHtmlData(BusinessObject businessObject,
                               Properties parameters,
                               LookupForm lookupForm,
                               List returnKeys,
                               BusinessObjectRestrictions businessObjectRestrictions)

Overrides:

getReturnAnchorHtmlData in class AbstractLookupableHelperServiceImpl

getSearchResults

public List<? extends BusinessObject> getSearchResults(Map<String,String> fieldValues)

Description copied from class: KualiLookupableHelperServiceImpl

Uses Lookup Service to provide a basic search.

Specified by:

getSearchResults in interface LookupableHelperService

Overrides:

getSearchResults in class KualiLookupableHelperServiceImpl

Parameters:

fieldValues - - Map containing prop name keys and search values

Returns:

List found business objects

See Also:

LookupableHelperService.getSearchResults(java.util.Map)

getRoleRows

public List<Row> getRoleRows()

setRoleRows

public void setRoleRows(List<Row> roleRows)

getAttrDefinitions

public List<KimAttributeField> getAttrDefinitions()

setAttrDefinitions

public void setAttrDefinitions(List<KimAttributeField> attrDefinitions)

getAttrRows

public List<Row> getAttrRows()

setAttrRows

public void setAttrRows(List<Row> attrRows)

getTypeId

public String getTypeId()

setTypeId

public void setTypeId(String typeId)

getRows

public List<Row> getRows()

Description copied from interface: LookupableHelperService

Returns a list of Row objects to be used to generate the search query screen Generally, setDataObjectClass needs to be called with a non-null value for proper operation

Specified by:

getRows in interface LookupableHelperService

Overrides:

getRows in class AbstractLookupableHelperServiceImpl

Returns:

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.

getCustomRoleInquiryHref

public static String getCustomRoleInquiryHref(String href)

getRoleCriteria

public QueryByCriteria getRoleCriteria(Map<String,String> fieldValues)

This method will generate a QueryByCriteria which locates the roles matching the criteria passed into the fieldValues parameter, or null if the search would return zero results.

Parameters:

fieldValues - A Map of the desired criteria to use when finding roles

Returns:

A QueryByCriteria object which can be used to locate matching roles in the database or null if the search would yield zero results

getRoleIdsForPrincipalName

protected Collection<String> getRoleIdsForPrincipalName(String principalName)

getPermissionRoleIds

protected Collection<String> getPermissionRoleIds(Map<String,String> permCrit)

getResponsibilityRoleIds

protected Collection<String> getResponsibilityRoleIds(Map<String,String> respCrit)

getGroupCriteriaRoleIds

protected Collection<String> getGroupCriteriaRoleIds(Map<String,String> groupCrit)

getMaintenanceDocumentTypeName

protected String getMaintenanceDocumentTypeName()

This overridden method ...

Overrides:

getMaintenanceDocumentTypeName in class AbstractLookupableHelperServiceImpl

Returns:

String representing the maintenance document type name

See Also:

AbstractLookupableHelperServiceImpl.getMaintenanceDocumentTypeName()