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 inherited from class org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

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

RoleLookupableHelperServiceImpl()

Method Summary

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(org.kuali.rice.kim.impl.role.RoleBo roleBo)
HtmlData	getInquiryUrl(BusinessObject bo, String propertyName) Returns the inquiry url for a field if one exist.
protected HtmlData	getReturnAnchorHtmlData(BusinessObject businessObject, Properties parameters, LookupForm lookupForm, List returnKeys, BusinessObjectRestrictions businessObjectRestrictions)
RoleDao	getRoleDao()
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	setRoleDao(RoleDao roleDao)
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, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, 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, getKualiConfigurationService, getKualiInquirable, getLookupResultsService, getLookupService, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentTypeName, 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

Constructor Detail

RoleLookupableHelperServiceImpl

public RoleLookupableHelperServiceImpl()

Method Detail

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(org.kuali.rice.kim.impl.role.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)

getRoleDao

public RoleDao getRoleDao()

setRoleDao

public void setRoleDao(RoleDao roleDao)

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.

getInquiryUrl

public HtmlData getInquiryUrl(BusinessObject bo,
                              String propertyName)

Description copied from class: AbstractLookupableHelperServiceImpl

Returns the inquiry url for a field if one exist.

Specified by:

getInquiryUrl in interface LookupableHelperService

Overrides:

getInquiryUrl in class AbstractLookupableHelperServiceImpl

Parameters:

bo - the business object instance to build the urls for

propertyName - the property which links to an inquirable

Returns:

String url to inquiry

getCustomRoleInquiryHref

public static String getCustomRoleInquiryHref(String href)