Public Member Functions | Package Functions

de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition Interface Reference

List of all members.

Public Member Functions

String getDescription ()
String getKey ()
EADatatype getType ()
boolean isSetDefaultValue ()
void setDefaultValue (String value)
void setDescription (String value)
void setKey (String value)
void setType (EADatatype value)
void unsetDefaultValue ()

Package Functions

String getDefaultValue ()

Detailed Description

UserAttributeDefinition (from UserAttributes)

Generalizations
EAElement (from Elements)

Description
UserAttributeDefinition represents a user attribute, i.e. it states that all UserAttributeableElements of a certain UserAttributeElementType are to be attached with an attribute identified by 'key'. For example, it can be specified that certain elements should be amended with an attribute "Status".

Attributes

Associations
type : EADatatype [1]
- The type of the user attribute. This type defines the set of legal values for the given user attribute, i.e. for all UserAttributeValues with the same key as this UserAttributeDefinition.

Constraints
No additional constraints

Semantics
-

Author:
dprenzel

Member Function Documentation

String de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.getDefaultValue (  )  [package]

Returns the value of the 'Default Value' attribute.

defaultValue : String [0..1]
The default value. This is to be used whenever a user attributeable element has no UserAttributeValue for the key of this UserAttributeDefinition.

Returns:
the value of the 'Default Value' attribute.
See also:
isSetDefaultValue()
unsetDefaultValue()
setDefaultValue(String)
de.fraunhofer.isst.eastadl.userattributes.UserattributesPackage.getUserAttributeDefinition_DefaultValue() unsettable="true"

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

String de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.getDescription (  ) 

Returns the value of the 'Description' attribute.

description : String [1]
A description statement.

Returns:
the value of the 'Description' attribute.
See also:
setDescription(String)
de.fraunhofer.isst.eastadl.userattributes.UserattributesPackage.getUserAttributeDefinition_Description() required="true"

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

String de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.getKey (  ) 

Returns the value of the 'Key' attribute.

key : String [1]
A unique identifier for the user attribute. Please refer to the description of attribute 'key' in metaclass UserAttributeValue for a detailed discussion on how to construct valid, globally unique keys.

Returns:
the value of the 'Key' attribute.
See also:
setKey(String)
de.fraunhofer.isst.eastadl.userattributes.UserattributesPackage.getUserAttributeDefinition_Key() required="true"

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

EADatatype de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.getType (  ) 

Returns the value of the 'Type' reference.

type : EADatatype [1]
The type of the user attribute. This type defines the set of legal values for the given user attribute, i.e. for all UserAttributeValues with the same key as this UserAttributeDefinition.

Returns:
the value of the 'Type' reference.
See also:
setType(EADatatype)
de.fraunhofer.isst.eastadl.userattributes.UserattributesPackage.getUserAttributeDefinition_Type() required="true"

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

boolean de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.isSetDefaultValue (  ) 

Returns whether the value of the 'Default Value' attribute is set.

defaultValue : String [0..1]
The default value. This is to be used whenever a user attributeable element has no UserAttributeValue for the key of this UserAttributeDefinition.

Returns:
whether the value of the 'Default Value' attribute is set.
See also:
unsetDefaultValue()
getDefaultValue()
setDefaultValue(String)

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

void de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.setDefaultValue ( String  value  ) 

Sets the value of the 'Default Value' attribute.

defaultValue : String [0..1]
The default value. This is to be used whenever a user attributeable element has no UserAttributeValue for the key of this UserAttributeDefinition.

Parameters:
value the new value of the 'Default Value' attribute.
See also:
isSetDefaultValue()
unsetDefaultValue()
getDefaultValue()

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

void de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.setDescription ( String  value  ) 

Sets the value of the 'Description' attribute.

description : String [1]
A description statement.

Parameters:
value the new value of the 'Description' attribute.
See also:
getDescription()

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

void de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.setKey ( String  value  ) 

Sets the value of the 'Key' attribute.

key : String [1]
A unique identifier for the user attribute. Please refer to the description of attribute 'key' in metaclass UserAttributeValue for a detailed discussion on how to construct valid, globally unique keys.

Parameters:
value the new value of the 'Key' attribute.
See also:
getKey()

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

void de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.setType ( EADatatype  value  ) 

Sets the value of the 'Type' reference.

type : EADatatype [1]
The type of the user attribute. This type defines the set of legal values for the given user attribute, i.e. for all UserAttributeValues with the same key as this UserAttributeDefinition.

Parameters:
value the new value of the 'Type' reference.
See also:
getType()

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.

void de.fraunhofer.isst.eastadl.userattributes.UserAttributeDefinition.unsetDefaultValue (  ) 

Unsets the value of the 'Default Value' attribute.

defaultValue : String [0..1]
The default value. This is to be used whenever a user attributeable element has no UserAttributeValue for the key of this UserAttributeDefinition.

See also:
isSetDefaultValue()
getDefaultValue()
setDefaultValue(String)

Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeDefinitionImpl.