org.kuali.kra.protocol

Class ProtocolLookupableHelperServiceImplBase<GenericProtocol extends ProtocolBase>

java.lang.Object

org.kuali.rice.kns.lookup.AbstractLookupableHelperServiceImpl

org.kuali.rice.kns.lookup.KualiLookupableHelperServiceImpl

org.kuali.kra.lookup.KraLookupableHelperServiceImpl

org.kuali.kra.protocol.ProtocolLookupableHelperServiceImplBase<GenericProtocol>

All Implemented Interfaces:

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

Direct Known Subclasses:

IacucProtocolLookupableHelperServiceImpl, ProtocolLookupableHelperServiceImpl

public abstract class ProtocolLookupableHelperServiceImplBase<GenericProtocol extends ProtocolBase>
extends KraLookupableHelperServiceImpl

This class handles searching for protocols.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AMEND_RENEW_PROTOCOL_LOOKUP_ACTION
protected org.kuali.rice.krad.service.DocumentService	documentService
protected KcPersonService	kcPersonService
protected KraAuthorizationService	kraAuthorizationService
protected static String	PENDING_PI_ACTION_PROTOCOL_LOOKUP
protected static String	PENDING_PROTOCOL_LOOKUP
protected static String	PROTOCOL_PERSON_ID_LOOKUP
protected static String	REQUEST_PROTOCOL_ACTION
protected TaskAuthorizationService	taskAuthorizationService

Fields inherited from class org.kuali.kra.lookup.KraLookupableHelperServiceImpl

MEDUSA

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

Constructors

Constructor and Description
ProtocolLookupableHelperServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ProtocolTaskBase	createNewProtocolTaskInstanceHook(String taskName, ProtocolBase protocol)
protected List<? extends org.kuali.rice.krad.bo.BusinessObject>	filterProtocols(Map<String,String> fieldValues) Filters the unbounded list of protocols by the given field values
protected List<? extends org.kuali.rice.krad.bo.BusinessObject>	filterProtocolsByPrincipal(Map<String,String> fieldValues, String principalKey) Filters the unbounded list of protocols by the given field values and whether the given principalId represents a protocol initiator or PI.
protected List<? extends org.kuali.rice.krad.bo.BusinessObject>	filterProtocolsByStatus(Map<String,String> fieldValues, String... protocolStatusCodes) Filters the unbounded list of protocols by the given field values and protocol status codes.
protected List<? extends org.kuali.rice.krad.bo.BusinessObject>	filterProtocolsByTask(Map<String,String> fieldValues, String... taskNames) Filters the unbounded list of protocols by the given field values and protocol tasks.
protected abstract List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActions(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames)
List<org.kuali.rice.kns.lookup.HtmlData>	getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames) create 'edit' link
org.kuali.rice.kns.service.DictionaryValidationService	getDictionaryValidationService() This method returns an instance of a DictionaryValidationService implementation
protected String	getDocumentTypeName() This method to set document type of the lookup bo's document
protected abstract String	getDocumentTypeNameHook()
protected List<org.kuali.rice.kns.lookup.HtmlData>	getEditCopyViewLinks(org.kuali.rice.krad.bo.BusinessObject businessObject, List pkNames) Construct and return edit, view, and copy links.
protected String	getHtmlAction() htmlaction for 'edit' link
protected abstract String	getHtmlActionHook()
org.kuali.rice.kns.lookup.HtmlData	getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject bo, String propertyName) This method is for several fields that does not have inquiry created by lookup frame work.
protected String	getKeyFieldName() This method is set the key field to retrieve bo for editing.
protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData	getPerformActionLink(org.kuali.rice.krad.bo.BusinessObject businessObject, String actionKey) Constructs and returns the perform action links.
protected abstract Class<? extends ProtocolBase>	getProtocolClassHook()
protected abstract ProtocolDao<GenericProtocol>	getProtocolDaoHook()
List<org.kuali.rice.kns.web.ui.Row>	getRows() This override is reset field definition for research area lookup fields & investigator label.
List<? extends org.kuali.rice.krad.bo.BusinessObject>	getSearchResults(Map<String,String> fieldValues)
protected abstract List<? extends org.kuali.rice.krad.bo.BusinessObject>	getSearchResultsFilteredByTask(Map<String,String> fieldValues)
protected String	getUserIdentifier()
protected boolean	isParameterTrue(String parameterKey)
protected abstract Map<String,String>	removeExtraFilterParameters(Map<String,String> fieldValues)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setKcPersonService(KcPersonService kcPersonService) Sets the KC Person Service.
void	setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
void	setTaskAuthorizationService(TaskAuthorizationService taskAuthorizationService)
protected List<GenericProtocol>	trimResult(List<GenericProtocol> result, Integer trimSize) This method trims the search result.
protected boolean	validateDate(String dateFieldName, String dateFieldValue)
void	validateSearchParameters(Map fieldValues)

Methods inherited from class org.kuali.kra.lookup.KraLookupableHelperServiceImpl

addEditHtmlData, getCustomLink, getMedusaLink, getViewLink, performLookup, setBackLocationDocFormKey, updateLookupField

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

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

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

addToReturnHref, allowsMaintenanceDeleteAction, allowsMaintenanceEditAction, allowsMaintenanceNewOrCopyAction, allowsNewOrCopyAction, 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, getReturnAnchorHtmlData, getReturnHref, getReturnHref, getReturnInputHtmlData, getReturnKeys, getReturnLocation, getReturnUrl, getReturnUrl, getSequenceAccessorService, getSupplementalMenuBar, getTitle, getUrlData, getUrlData, isResultReturnable, maskValueIfNecessary, performClear, performCustomAction, 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

AMEND_RENEW_PROTOCOL_LOOKUP_ACTION

protected static final String AMEND_RENEW_PROTOCOL_LOOKUP_ACTION

See Also:

Constant Field Values

REQUEST_PROTOCOL_ACTION

protected static final String REQUEST_PROTOCOL_ACTION

See Also:

Constant Field Values

PENDING_PROTOCOL_LOOKUP

protected static final String PENDING_PROTOCOL_LOOKUP

See Also:

Constant Field Values

PENDING_PI_ACTION_PROTOCOL_LOOKUP

protected static final String PENDING_PI_ACTION_PROTOCOL_LOOKUP

See Also:

Constant Field Values

PROTOCOL_PERSON_ID_LOOKUP

protected static final String PROTOCOL_PERSON_ID_LOOKUP

See Also:

Constant Field Values

kcPersonService

protected KcPersonService kcPersonService

kraAuthorizationService

protected KraAuthorizationService kraAuthorizationService

taskAuthorizationService

protected TaskAuthorizationService taskAuthorizationService

documentService

protected org.kuali.rice.krad.service.DocumentService documentService

Constructor Detail

ProtocolLookupableHelperServiceImplBase

public ProtocolLookupableHelperServiceImplBase()

Method Detail

getSearchResults

public List<? extends org.kuali.rice.krad.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

filterProtocolsByTask

protected List<? extends org.kuali.rice.krad.bo.BusinessObject> filterProtocolsByTask(Map<String,String> fieldValues,
                                                                          String... taskNames)

Filters the unbounded list of protocols by the given field values and protocol tasks.

Parameters:

fieldValues - the field values that form a normal protocol search

taskNames - the list of protocol tasks that the user must be able to perform in a protocol in order for it to be in the search results

Returns:

a list of all protocols filtered by the given field values and being able to perform tasks in the taskNames

createNewProtocolTaskInstanceHook

protected abstract ProtocolTaskBase createNewProtocolTaskInstanceHook(String taskName,
                                                 ProtocolBase protocol)

filterProtocolsByStatus

protected List<? extends org.kuali.rice.krad.bo.BusinessObject> filterProtocolsByStatus(Map<String,String> fieldValues,
                                                                            String... protocolStatusCodes)

Filters the unbounded list of protocols by the given field values and protocol status codes.

Parameters:

fieldValues - the field values that form a normal protocol search

protocolStatusCodes - the list of protocol status codes that should be included in the search result

Returns:

a list of all protocols filtered by the given field values and having statuses in protocolStatusCodes

filterProtocolsByPrincipal

protected List<? extends org.kuali.rice.krad.bo.BusinessObject> filterProtocolsByPrincipal(Map<String,String> fieldValues,
                                                                               String principalKey)

Filters the unbounded list of protocols by the given field values and whether the given principalId represents a protocol initiator or PI.

Parameters:

fieldValues - the field values that form a normal protocol search

personKey - the key in the fieldValues that maps to the principalId

Returns:

a list of all protocols filtered by the given field values and whether the given principalId represents a protocol initiator or PI

filterProtocols

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

Filters the unbounded list of protocols by the given field values

Parameters:

fieldValues - the field values that form a normal protocol search

Returns:

a list of all protocols filtered by the given field values

trimResult

protected List<GenericProtocol> trimResult(List<GenericProtocol> result,
                               Integer trimSize)

This method trims the search result.

Parameters:

result, - the result set to be trimmed

trimSize, - the maximum size of the trimmed result set

Returns:

the trimmed result set

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

validateDate

protected boolean validateDate(String dateFieldName,
                   String dateFieldValue)

getDictionaryValidationService

public org.kuali.rice.kns.service.DictionaryValidationService getDictionaryValidationService()

This method returns an instance of a DictionaryValidationService implementation

Returns:

getCustomActionUrls

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

create 'edit' link

Specified by:

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

Overrides:

getCustomActionUrls in class KraLookupableHelperServiceImpl

See Also:

KraLookupableHelperServiceImpl.getCustomActionUrls(org.kuali.rice.krad.bo.BusinessObject, java.util.List)

isParameterTrue

protected boolean isParameterTrue(String parameterKey)

getPerformActionLink

protected org.kuali.rice.kns.lookup.HtmlData.AnchorHtmlData getPerformActionLink(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                                                     String actionKey)

Constructs and returns the perform action links.

Parameters:

businessObject -

actionKey -

Returns:

getEditCopyViewLinks

protected List<org.kuali.rice.kns.lookup.HtmlData> getEditCopyViewLinks(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                                            List pkNames)

Construct and return edit, view, and copy links.

Parameters:

businessObject -

pkNames -

getRows

public List<org.kuali.rice.kns.web.ui.Row> getRows()

This override is reset field definition for research area lookup fields & investigator label.

Specified by:

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

Overrides:

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

See Also:

org.kuali.core.lookup.AbstractLookupableHelperServiceImpl#getRows()

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

Sets the KC Person Service.

Parameters:

kcPersonService - the kc person service

getInquiryUrl

public org.kuali.rice.kns.lookup.HtmlData getInquiryUrl(org.kuali.rice.krad.bo.BusinessObject bo,
                                               String propertyName)

This method is for several fields that does not have inquiry created by lookup frame work.

Specified by:

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

Overrides:

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

See Also:

org.kuali.core.lookup.AbstractLookupableHelperServiceImpl#getInquiryUrl(org.kuali.core.bo.BusinessObject, java.lang.String)

getHtmlAction

protected String getHtmlAction()

Description copied from class: KraLookupableHelperServiceImpl

htmlaction for 'edit' link

Specified by:

getHtmlAction in class KraLookupableHelperServiceImpl

getDocumentTypeName

protected String getDocumentTypeName()

Description copied from class: KraLookupableHelperServiceImpl

This method to set document type of the lookup bo's document

Specified by:

getDocumentTypeName in class KraLookupableHelperServiceImpl

Returns:

getKeyFieldName

protected String getKeyFieldName()

Description copied from class: KraLookupableHelperServiceImpl

This method is set the key field to retrieve bo for editing. May change to a map if there are multiple fields.

Specified by:

getKeyFieldName in class KraLookupableHelperServiceImpl

Returns:

getUserIdentifier

protected String getUserIdentifier()

setKraAuthorizationService

public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)

setTaskAuthorizationService

public void setTaskAuthorizationService(TaskAuthorizationService taskAuthorizationService)

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

getSearchResultsFilteredByTask

protected abstract List<? extends org.kuali.rice.krad.bo.BusinessObject> getSearchResultsFilteredByTask(Map<String,String> fieldValues)

removeExtraFilterParameters

protected abstract Map<String,String> removeExtraFilterParameters(Map<String,String> fieldValues)

getCustomActions

protected abstract List<org.kuali.rice.kns.lookup.HtmlData> getCustomActions(org.kuali.rice.krad.bo.BusinessObject businessObject,
                                                        List pkNames)

getProtocolDaoHook

protected abstract ProtocolDao<GenericProtocol> getProtocolDaoHook()

getDocumentTypeNameHook

protected abstract String getDocumentTypeNameHook()

getHtmlActionHook

protected abstract String getHtmlActionHook()

getProtocolClassHook

protected abstract Class<? extends ProtocolBase> getProtocolClassHook()