com.appiancorp.suiteapi.personalization

Class Attribute

java.lang.Object

com.appiancorp.suiteapi.personalization.Attribute

All Implemented Interfaces:

java.io.Serializable

public class Attribute
extends java.lang.Object
implements java.io.Serializable

This represents the Attribute object. ALL FIELDS are required.
The default attribute types supported are: TYPE_BOOLEAN, TYPE_STRING, TYPE_INTEGER, TYPE_FLOAT, TYPE_DATE, TYPE_USER, TYPE_GROUP

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BOOLEAN
static int	TYPE_DATE
static int	TYPE_FLOAT
static int	TYPE_GROUP
static int	TYPE_INTEGER
static int	TYPE_STRING
static int	TYPE_USER

Constructor Summary

Constructors

Constructor and Description
Attribute()
Attribute(java.lang.String name, java.lang.Integer type)
Attribute(java.lang.String name, java.lang.Integer type, java.lang.Object value)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Attribute	findAttributeByName(Attribute[] attributes, java.lang.String name) Finds an attribute in a list of attributes, searching by name
static int	findAttributeIndexByName(Attribute[] attributes, java.lang.String name) Finds the index of an attribute in a list of attributes, searching by name
static java.lang.Long	getAppianTypeFromAttributeType(java.lang.Integer attributeType)
static java.lang.Integer	getAttributeTypeFromAppianType(java.lang.Long appianType)
java.lang.String	getName() The attribute name (unique per group type, serves as the attribute handle).
java.lang.Integer	getType() Can be any one of the TYPE_XXX constants on this class.
java.lang.String	getTypeName() Returns the name of this Attribute's type.
java.lang.Object	getValue() Returns the attribute value.
int	hashCode()
void	setName(java.lang.String name) Sets the name.
void	setType(java.lang.Integer type) Sets the type.
void	setValue(java.lang.Object value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

See Also:

Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

See Also:

Constant Field Values

TYPE_USER

public static final int TYPE_USER

See Also:

Constant Field Values

TYPE_GROUP

public static final int TYPE_GROUP

See Also:

Constant Field Values

Constructor Detail

Attribute

public Attribute()

Attribute

public Attribute(java.lang.String name,
                 java.lang.Integer type)

Attribute

public Attribute(java.lang.String name,
                 java.lang.Integer type,
                 java.lang.Object value)

Method Detail

getName

public java.lang.String getName()

The attribute name (unique per group type, serves as the attribute handle).

Returns:

String

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - The name to set

getType

public java.lang.Integer getType()

Can be any one of the TYPE_XXX constants on this class.

Returns:

Integer

setType

public void setType(java.lang.Integer type)

Sets the type.

Parameters:

type - The type to set

getValue

public java.lang.Object getValue()

Returns the attribute value.

setValue

public void setValue(java.lang.Object value)

Sets the value.

Parameters:

value - The value to set

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAppianTypeFromAttributeType

public static java.lang.Long getAppianTypeFromAttributeType(java.lang.Integer attributeType)

getAttributeTypeFromAppianType

public static java.lang.Integer getAttributeTypeFromAppianType(java.lang.Long appianType)

getTypeName

public java.lang.String getTypeName()

Returns the name of this Attribute's type. The name is just a String that can be displayed to the end-user instead of a raw integer; the name has no special meaning (it's not a key) and can change in the future.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

findAttributeIndexByName

public static int findAttributeIndexByName(Attribute[] attributes,
                                           java.lang.String name)

Finds the index of an attribute in a list of attributes, searching by name

Parameters:

attributes - the list of attributes to search in

name - the name of the attribute to search for

Returns:

the index of the attribute if found, -1 if not found

findAttributeByName

public static Attribute findAttributeByName(Attribute[] attributes,
                                            java.lang.String name)

Finds an attribute in a list of attributes, searching by name

Parameters:

attributes - the list of attributes to search in

name - the name of the attribute to search for

Returns:

the attribute if found, null if not found