com.sas.hls.common
Class AttributeDefinition

java.lang.Object
  extended by com.sas.hls.common.AttributeDefinition
All Implemented Interfaces:
Serializable

public class AttributeDefinition
extends Object
implements Serializable

A local representation of how an attribute is defined on an object.

See Also:
Serialized Form

Constructor Summary
AttributeDefinition()
          Zero-arg constructor for an AttributeDefinition.
AttributeDefinition(String name)
          Constructs an AttributeDefinition object which defines an attribute on an object.
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getDisplayName()
          Get the displayName value for this attribute definition.
 String getName()
          Returns a String containing the name of the attribute defined.
 AttributeType getType()
          Get the type of the value set on the attribute defined.
 int hashCode()
          Return a hash code value for the object.
 boolean isEditable()
          Returns the boolean value indicating if this attribute defined to be modifiable by an end user.
 boolean isExtended()
          Returns whether or not this is an extended attribute definition or an attribute defined by the platform.
 boolean isRequired()
          Returns whether or not this attribute is required to have a value.
 void setDisplayName(String displayName)
          Set the displayName to be shown to end users for this attribute definition.
 void setEditable(boolean editable)
          Set the indicator of whether or not this attribute value can be changed by an end user.
 void setExtended(boolean extended)
          Set whether this attribute is user defined.
 void setName(String name)
          Set the internal name of the attribute being defined.
 void setRequired(boolean required)
          Set whether or not this attribute is required to have a value.
 void setType(AttributeType type)
          Set the type of the value on the defined attribute.
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AttributeDefinition

public AttributeDefinition()
Zero-arg constructor for an AttributeDefinition.


AttributeDefinition

public AttributeDefinition(String name)
Constructs an AttributeDefinition object which defines an attribute on an object.

Parameters:
name - A String containing the (internal) name of the attribute being defined. Cannot be null.
Method Detail

setName

public void setName(String name)
Set the internal name of the attribute being defined.

Parameters:
name - The internal name of the attribute being defined.

getName

public String getName()
Returns a String containing the name of the attribute defined.

Returns:
the name of the attribute defined..

setEditable

public void setEditable(boolean editable)
Set the indicator of whether or not this attribute value can be changed by an end user.

Parameters:
editable - Is this attribute defined to be modifiable by an end user?

isEditable

public boolean isEditable()
Returns the boolean value indicating if this attribute defined to be modifiable by an end user.

Returns:
Is this attribute defined to be modifiable by an end user.

isExtended

public boolean isExtended()
Returns whether or not this is an extended attribute definition or an attribute defined by the platform.

Returns:
a boolean value indicating if this is an extended attribute.

setExtended

public void setExtended(boolean extended)
Set whether this attribute is user defined.

Parameters:
extended - The boolean value indicating if this attribute is user defined.

isRequired

public boolean isRequired()
Returns whether or not this attribute is required to have a value.

Returns:
The boolean value indicating whether or not this attribute is required to have a value.

setRequired

public void setRequired(boolean required)
Set whether or not this attribute is required to have a value.

Parameters:
required - The boolean value indicating if this attribute is required to be set.

getDisplayName

public String getDisplayName()
Get the displayName value for this attribute definition.

Returns:
the displayName for this attribute definition.

setDisplayName

public void setDisplayName(String displayName)
Set the displayName to be shown to end users for this attribute definition.

Parameters:
displayName - the displayName to set

getType

public AttributeType getType()
Get the type of the value set on the attribute defined.

Returns:
the type of the attribute value.

setType

public void setType(AttributeType type)
Set the type of the value on the defined attribute.

Parameters:
type - the type to set

hashCode

public int hashCode()
Return a hash code value for the object.

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2012, SAS Institute Inc., Cary, NC, USA