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

java.lang.Object
  org.kuali.rice.krad.uif.field.AttributeQueryResult

All Implemented Interfaces:

Serializable, Cloneable, Copyable

public class AttributeQueryResult
extends Object
implements Serializable, Copyable

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

AttributeQueryResult()

Method Summary

AttributeQueryResult	clone() Override Object.clone() to assign the public modifier.
<T> T	copy() Return a copy of the class.
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	preventModification() Modification is not controlled at this level.
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
Copyable	unwrap() Get the innermost copyable instance, if wrapped by a proxy.

Methods inherited from class java.lang.Object

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 -

clone

public AttributeQueryResult clone()
                           throws CloneNotSupportedException

Description copied from interface: Copyable

Override Object.clone() to assign the public modifier.

Specified by:

clone in interface Copyable

Overrides:

clone in class Object

Returns:

Object.clone()

Throws:

CloneNotSupportedException - If Cloneable is not implemented. This should not be possible when using this interface.

See Also:

Copyable.clone()

preventModification

public void preventModification()

Modification is not controlled at this level.

Specified by:

preventModification in interface Copyable

See Also:

Copyable.preventModification()

copy

public final <T> T copy()

Description copied from interface: Copyable

Return a copy of the class.

Specified by:

copy in interface Copyable

Type Parameters:

T - copyable type

Returns:

the copy

See Also:

Copyable.copy(), CopyUtils.copy(Copyable)

unwrap

public Copyable unwrap()

Get the innermost copyable instance, if wrapped by a proxy. When not wrapped, return this.

Specified by:

unwrap in interface Copyable

Returns:

wrapped instance