org.kuali.rice.kns.inquiry

Class KualiInquirableImpl

java.lang.Object

org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

org.kuali.rice.krad.inquiry.InquirableImpl

org.kuali.rice.kns.inquiry.KualiInquirableImpl

All Implemented Interfaces:

Serializable, Inquirable, ViewHelperService

Direct Known Subclasses:

AgendaInquiryHelperServiceImpl, ComponentInquirableImpl, GroupInquirableImpl, KimTypeInquirableImpl, PersonInquirableImpl, RoleInquirableImpl, RoleMemberInquirableImpl, RuleBaseValuesInquirableImpl, RuleDelegationInquirableImpl

public class KualiInquirableImpl
extends InquirableImpl
implements Inquirable

Kuali inquirable implementation. Implements methods necessary to retrieve the business object and render the ui. NOTE: this class is not thread safe. When using this class or any subclasses in Spring, make sure that this is not a singleton service, or serious errors may occur.

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BusinessObjectAuthorizationService	businessObjectAuthorizationService
protected BusinessObjectDictionaryService	businessObjectDictionaryService
protected BusinessObjectMetaDataService	businessObjectMetaDataService
protected EncryptionService	encryptionService
protected Map<String,Boolean>	inactiveRecordDisplay
static String	INQUIRY_TITLE_PREFIX
protected LookupService	lookupService

Fields inherited from class org.kuali.rice.krad.inquiry.InquirableImpl

dataObjectClass, SUPER_CLASS_TRANSLATOR_LIST

Constructor Summary

Constructors

Constructor and Description
KualiInquirableImpl() Default constructor, initializes services from spring

Method Summary

Modifier and Type	Method and Description
void	addAdditionalSections(List columns, BusinessObject bo) Deprecated.
protected String	createTitleText(Class<?> dataObjectClass) Deprecated.
BusinessObject	getBusinessObject(Map fieldValues) Deprecated.
protected BusinessObjectAuthorizationService	getBusinessObjectAuthorizationService()
Class	getBusinessObjectClass() Deprecated.
protected BusinessObjectDictionaryService	getBusinessObjectDictionaryService()
protected BusinessObjectMetaDataService	getBusinessObjectMetaDataService()
protected EncryptionService	getEncryptionService()
String	getHtmlMenuBar() Deprecated.
protected HtmlData.AnchorHtmlData	getHyperLink(Class inquiryClass, Map<String,String> fieldList, String inquiryUrl) Deprecated.
protected HtmlData.AnchorHtmlData	getHyperLink(Class inquiryClass, Map<String,String> fieldList, String inquiryUrl, String displayText) Deprecated.
Map<String,Boolean>	getInactiveRecordDisplay() Deprecated.
HtmlData	getInquiryUrl(BusinessObject businessObject, String attributeName, boolean forceInquiry) Deprecated.
protected HtmlData.AnchorHtmlData	getInquiryUrlForPrimaryKeys(Class clazz, Object businessObject, List<String> primaryKeys, String displayText) Deprecated.
protected ConfigurationService	getKualiConfigurationService()
protected LookupService	getLookupService()
List<Section>	getSections(BusinessObject bo) Deprecated.
boolean	getShowInactiveRecords(String collectionName) Deprecated.
String	getTitle() Deprecated.
Object	retrieveDataObject(Map fieldValues) TODO: generics do not match between call to module service and call to lookup service
void	setBusinessObjectAuthorizationService(BusinessObjectAuthorizationService businessObjectAuthorizationService)
void	setBusinessObjectClass(Class businessObjectClass) Deprecated.
void	setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService)
void	setBusinessObjectMetaDataService(BusinessObjectMetaDataService businessObjectMetaDataService)
void	setEncryptionService(EncryptionService encryptionService)
void	setLookupService(LookupService lookupService)
void	setShowInactiveRecords(String collectionName, boolean showInactive) Deprecated.

Methods inherited from class org.kuali.rice.krad.inquiry.InquirableImpl

buildInquirableLink, getAlternateKeysForClass, getDataDictionaryService, getDataObjectAuthorizationService, getDataObjectClass, getDataObjectMetaDataService, getKualiModuleService, retrieveKeySetFromMap, setDataObjectClass

Methods inherited from class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

addCustomContainerComponents, addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildExportTableData, buildExportTableRow, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getBusinessObjectService, getCommonContext, getConfigurationService, getExportTableFormatOptions, getExpressionEvaluator, getPersistenceService, getPersistenceStructureService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterAddLine, processAfterDeleteLine, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, retrieveEditModesAndActionFlags, runComponentModifiers, setBusinessObjectService, setConfigurationService, setDataDictionaryService, setExpressionEvaluator, setPersistenceService, setPersistenceStructureService, setViewContext, setViewDictionaryService, spawnSubLifecyle, syncClientSideStateForComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.inquiry.Inquirable

buildInquirableLink, setDataObjectClass

Field Detail

lookupService

protected LookupService lookupService

businessObjectAuthorizationService

protected BusinessObjectAuthorizationService businessObjectAuthorizationService

businessObjectDictionaryService

protected BusinessObjectDictionaryService businessObjectDictionaryService

businessObjectMetaDataService

protected BusinessObjectMetaDataService businessObjectMetaDataService

encryptionService

protected EncryptionService encryptionService

inactiveRecordDisplay

protected Map<String,Boolean> inactiveRecordDisplay

INQUIRY_TITLE_PREFIX

public static final String INQUIRY_TITLE_PREFIX

See Also:

Constant Field Values

Constructor Detail

KualiInquirableImpl

public KualiInquirableImpl()

Default constructor, initializes services from spring

Method Detail

retrieveDataObject

public Object retrieveDataObject(Map fieldValues)

TODO: generics do not match between call to module service and call to lookup service

Specified by:

retrieveDataObject in interface Inquirable

Overrides:

retrieveDataObject in class InquirableImpl

Parameters:

fieldValues - - a map of string field names and values

Returns:

the data object or null if not found

See Also:

Inquirable.retrieveDataObject(java.util.Map)

getBusinessObject

@Deprecated
public BusinessObject getBusinessObject(Map fieldValues)

Deprecated.

Return a business object by searching with map, the map keys should be a property name of the business object, with the map value as the value to search for.

getSections

@Deprecated
public List<Section> getSections(BusinessObject bo)

Deprecated.

Objects extending KualiInquirableBase must specify the Section objects used to display the inquiry result.

getInquiryUrl

@Deprecated
public HtmlData getInquiryUrl(BusinessObject businessObject,
                                          String attributeName,
                                          boolean forceInquiry)

Deprecated.

Helper method to build an inquiry url for a result field.

Parameters:

bo - the business object instance to build the urls for

propertyName - the property which links to an inquirable

Returns:

String url to inquiry

getHyperLink

@Deprecated
protected HtmlData.AnchorHtmlData getHyperLink(Class inquiryClass,
                                                           Map<String,String> fieldList,
                                                           String inquiryUrl)

Deprecated.

createTitleText

@Deprecated
protected String createTitleText(Class<?> dataObjectClass)

Deprecated.

Gets text to prepend to the inquiry link title

Parameters:

dataObjectClass - - data object class being inquired into

Returns:

String title prepend text

addAdditionalSections

@Deprecated
public void addAdditionalSections(List columns,
                                              BusinessObject bo)

Deprecated.

getHtmlMenuBar

@Deprecated
public String getHtmlMenuBar()

Deprecated.

See Also:

Inquirable.getHtmlMenuBar()

getTitle

@Deprecated
public String getTitle()

Deprecated.

See Also:

Inquirable.getTitle()

setBusinessObjectClass

@Deprecated
public void setBusinessObjectClass(Class businessObjectClass)

Deprecated.

Parameters:

businessObjectClass - The dataObjectClass to set.

getBusinessObjectClass

@Deprecated
public Class getBusinessObjectClass()

Deprecated.

Returns:

Returns the dataObjectClass.

getInactiveRecordDisplay

@Deprecated
public Map<String,Boolean> getInactiveRecordDisplay()

Deprecated.

Description copied from interface: Inquirable

Returns the Map used to control the state of inactive record collection display. Exposed for setting from the maintenance jsp.

See Also:

Inquirable.getInactiveRecordDisplay()

getShowInactiveRecords

@Deprecated
public boolean getShowInactiveRecords(String collectionName)

Deprecated.

Description copied from interface: Inquirable

Indicates whether inactive records for the given collection should be display.

Parameters:

collectionName - - name of the collection (or sub-collection) to check inactive record display setting

Returns:

true if inactive records should be displayed, false otherwise

See Also:

Inquirable.getShowInactiveRecords(java.lang.String)

setShowInactiveRecords

@Deprecated
public void setShowInactiveRecords(String collectionName,
                                               boolean showInactive)

Deprecated.

Description copied from interface: Inquirable

Indicates to maintainble whether or not inactive records should be displayed for the given collection name.

Parameters:

collectionName - - name of the collection (or sub-collection) to set inactive record display setting

showInactive - - true to display inactive, false to not display inactive records

See Also:

Inquirable.setShowInactiveRecords(java.lang.String, boolean)

getLookupService

protected LookupService getLookupService()

setLookupService

public void setLookupService(LookupService lookupService)

getBusinessObjectDictionaryService

protected BusinessObjectDictionaryService getBusinessObjectDictionaryService()

setBusinessObjectDictionaryService

public void setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService)

getEncryptionService

protected EncryptionService getEncryptionService()

Overrides:

getEncryptionService in class InquirableImpl

setEncryptionService

public void setEncryptionService(EncryptionService encryptionService)

getKualiConfigurationService

protected ConfigurationService getKualiConfigurationService()

getBusinessObjectMetaDataService

protected BusinessObjectMetaDataService getBusinessObjectMetaDataService()

setBusinessObjectMetaDataService

public void setBusinessObjectMetaDataService(BusinessObjectMetaDataService businessObjectMetaDataService)

getBusinessObjectAuthorizationService

protected BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()

setBusinessObjectAuthorizationService

public void setBusinessObjectAuthorizationService(BusinessObjectAuthorizationService businessObjectAuthorizationService)

getInquiryUrlForPrimaryKeys

@Deprecated
protected HtmlData.AnchorHtmlData getInquiryUrlForPrimaryKeys(Class clazz,
                                                                          Object businessObject,
                                                                          List<String> primaryKeys,
                                                                          String displayText)

Deprecated.

getHyperLink

@Deprecated
protected HtmlData.AnchorHtmlData getHyperLink(Class inquiryClass,
                                                           Map<String,String> fieldList,
                                                           String inquiryUrl,
                                                           String displayText)

Deprecated.