com.sas.hls.type
Class AttributeDefinition

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

public class AttributeDefinition
extends Object
implements Serializable

Provides information about attributes defined on a Type. Object types are defined by the system and provide default attributes as well as extended attributes that can be defined by end-users.

Since:
1.7
See Also:
Type.getAttributeDefinitions(), Serialized Form

Nested Class Summary
static class AttributeDefinition.AttributeType
          The enumeration of value types that an attribute can have.
 
Constructor Summary
AttributeDefinition(String name, String displayName, AttributeDefinition.AttributeType attributeType, boolean inherited, boolean editable, boolean extended, boolean required)
          Initializing constructor which allocates a new AttributeDefinition and sets all attributes to the specified values.
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 AttributeDefinition.AttributeType getAttributeType()
          Returns the data type of this attribute definition.
 String getDisplayName()
          Returns the display name of this attribute definition.
 String getName()
          Returns the name of 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 (defined by an end-user), or an attribute defined by the system.
 boolean isInherited()
          Returns whether or not this attribute definition was defined on a super type and therefore inherited or whether this definition was defined on the enclosing type.
 boolean isRequired()
          Returns whether or not this attribute is required to have a value.
 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(String name,
                           String displayName,
                           AttributeDefinition.AttributeType attributeType,
                           boolean inherited,
                           boolean editable,
                           boolean extended,
                           boolean required)
Initializing constructor which allocates a new AttributeDefinition and sets all attributes to the specified values.

Parameters:
name - The name of this attribute definition.
displayName - The display name of this attribute definition.
attributeType - The data type of the attribute represented by this attribute definition.
inherited - If this attribute definition was inherited from a super type.
editable - If the attribute represented by this attribute definition is editable by end-users.
extended - If this attribute definition was defined as an extended attribute.
required - If the attribute represented by this attribute definition is a required field.
Method Detail

getName

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

Returns:
The name of the attribute defined.

getDisplayName

public String getDisplayName()
Returns the display name of this attribute definition.

Returns:
The display name of this attribute definition.

getAttributeType

public AttributeDefinition.AttributeType getAttributeType()
Returns the data type of this attribute definition.

Returns:
The data type of this attribute definition.

isInherited

public boolean isInherited()
Returns whether or not this attribute definition was defined on a super type and therefore inherited or whether this definition was defined on the enclosing type.

Returns:
true if this attribute definition was inherited from a super type, false otherwise.

isEditable

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

Returns:
true if this attribute can be modified by an end-user, false otherwise.

isExtended

public boolean isExtended()
Returns whether or not this is an extended attribute (defined by an end-user), or an attribute defined by the system.

Returns:
true if this attribute definition was defined as an extended attribute by an end-user, false if the attribute definition is system-defined.

isRequired

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

Returns:
true if this attribute is required to have a value, false otherwise.

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) 2016, SAS Institute Inc., Cary, NC, USA