ActionParameterRequest¶

public class ActionParameterRequest implements Comparable<ActionParameterRequest>¶

Object representation of a parameter in the channel action request definition.

See also: ActionEventRequest

Constructors¶

ActionParameterRequest¶

public ActionParameterRequest()¶: Constructor.

ActionParameterRequest¶

public ActionParameterRequest(Integer order, String key, String value, String displayName, String type, boolean required, boolean hidden, SortedSet<String> options)¶

Constructor.

Parameters:	order – the parameter order key – the parameter key value – the parameter value displayName – the parameter display name type – the parameter type required – defines if the parameter is required hidden – defines if the parameter is hidden on the UI options – the parameter options for select parameter type

Methods¶

compareTo¶

public int compareTo(ActionParameterRequest o)¶

equals¶

public boolean equals(Object obj)¶

getDisplayName¶

public String getDisplayName()¶

Returns the display name of the parameter.

Returns:	the parameter display name

getKey¶

public String getKey()¶

Returns the key of the parameter.

Returns:	the parameter key

getOptions¶

public SortedSet<String> getOptions()¶

Returns the options of the parameter.

Returns:	options of the parameter order

getOrder¶

public Integer getOrder()¶

Returns the order of the parameter.

Returns:	the parameter order

getType¶

public String getType()¶

Returns the type of the parameter.

Returns:	the parameter type

getValue¶

public String getValue()¶

Returns the value of the parameter.

Returns:	the parameter value

hashCode¶

public int hashCode()¶

isHidden¶

public boolean isHidden()¶

Returns whether this action parameter should be hidden on the UI.

Returns:	true if this action parameter should be hidden on the UI, false otherwise

isRequired¶

public boolean isRequired()¶

Returns whether this action parameter is required.

Returns:	true if this action parameter is required, false otherwise

setOptions¶

public void setOptions(SortedSet<String> options)¶

Sets the options of the parameter.

Parameters:	options – of the parameter order

setOrder¶

public void setOrder(int order)¶

Sets the order of the parameter.

Parameters:	order – the parameter order

toString¶

public String toString()¶