org.kuali.rice.krad.uif.field

Class AttributeQueryResult

java.lang.Object

org.kuali.rice.krad.uif.field.AttributeQueryResult

All Implemented Interfaces:

Serializable

public class AttributeQueryResult
extends Object
implements Serializable

Object that is returned for Ajax attribute queries and exposed as JSON

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeQueryResult()

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	copy() Returns a copy of the attribute query result.
protected <T> void	copyProperties(T attributeQueryResult) Copies the properties over for the copy method.
List<Object>	getResultData() Result of an attribute query that will be sent back to the client
Map<String,String>	getResultFieldData() Returns data for multiple fields as a Map where key is the field name and map value is the field value
String	getResultMessage() Message text that should display (if non empty) with the results.
String	getResultMessageStyleClasses() CSS Style classes that should be applied to the result message text
void	setResultData(List<Object> resultData) Setter for the attribute query result data
void	setResultFieldData(Map<String,String> resultFieldData) Setter for the map field data
void	setResultMessage(String resultMessage) Setter for the result message text
void	setResultMessageStyleClasses(String resultMessageStyleClasses) Setter for the CSS style classes to use for the return message

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeQueryResult

public AttributeQueryResult()

Method Detail

getResultMessage

public String getResultMessage()

Message text that should display (if non empty) with the results. Can be used to given messages such as data not found

Returns:

text to display with results

setResultMessage

public void setResultMessage(String resultMessage)

Setter for the result message text

Parameters:

resultMessage -

getResultMessageStyleClasses

public String getResultMessageStyleClasses()

CSS Style classes that should be applied to the result message text

Returns:

CSS style classes

setResultMessageStyleClasses

public void setResultMessageStyleClasses(String resultMessageStyleClasses)

Setter for the CSS style classes to use for the return message

Parameters:

resultMessageStyleClasses -

getResultFieldData

public Map<String,String> getResultFieldData()

Returns data for multiple fields as a Map where key is the field name and map value is the field value

Returns:

result field data

setResultFieldData

public void setResultFieldData(Map<String,String> resultFieldData)

Setter for the map field data

Parameters:

resultFieldData -

getResultData

public List<Object> getResultData()

Result of an attribute query that will be sent back to the client

Returns:

result data

setResultData

public void setResultData(List<Object> resultData)

Setter for the attribute query result data

Parameters:

resultData -

copy

public <T> T copy()

Returns a copy of the attribute query result.

Returns:

AttributeQueryResult copy of the component

copyProperties

protected <T> void copyProperties(T attributeQueryResult)

Copies the properties over for the copy method.

Parameters:

attributeQuery - The AttributeQuery to copy