org.kuali.rice.krad.uif.service

Interface AttributeQueryService

All Known Implementing Classes:

AttributeQueryServiceImpl

public interface AttributeQueryService

Provides methods for executing AttributeQuery instances and preparing the AttributeQueryResult with the result of the query

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
AttributeQueryResult	performFieldQuery(ViewPostMetadata viewPostMetadata, String fieldId, Map<String,String> queryParameters) Executes the AttributeQuery associated with the field given by the id.
AttributeQueryResult	performFieldSuggestQuery(ViewPostMetadata viewPostMetadata, String fieldId, String fieldTerm, Map<String,String> queryParameters) Executes the AttributeQuery associated with the Suggest widget within the field given by the Id.

Method Detail

performFieldSuggestQuery

AttributeQueryResult performFieldSuggestQuery(ViewPostMetadata viewPostMetadata,
                                            String fieldId,
                                            String fieldTerm,
                                            Map<String,String> queryParameters)

Executes the AttributeQuery associated with the Suggest widget within the field given by the Id. The given Map of key/value pairs are used to populate the criteria part of the attribute query or as arguments to the query method. The fieldTerm parameter gives the current value of the field that should be matched on. The query is expected to return a list of values to suggest

Parameters:

viewPostMetadata - - post metadata related to the field

fieldId - - id for the attribute field to perform the query for

fieldTerm - - the partial value of the query field to match

queryParameters - - map of key/value pairs that are parameters to the query

Returns:

AttributeQueryResult instance populated with the List data field of result data

performFieldQuery

AttributeQueryResult performFieldQuery(ViewPostMetadata viewPostMetadata,
                                     String fieldId,
                                     Map<String,String> queryParameters)

Executes the AttributeQuery associated with the field given by the id. The given Map of key/value pairs are used to populate the criteria part of the attribute query or as arguments to the query method. The query is expected to return a Map of field name/value pairs (unlike the suggest query which just returns values for one field)

Parameters:

viewPostMetadata - - post metadata related to the field

fieldId - - id for the attribute field to perform the query for

queryParameters - - map of key/value pairs that are parameters to the query

Returns:

AttributeQueryResult instance populated with the Map of result field data