Public Member Functions | |
| String | getValue () |
| void | setKey (String value) |
| void | setValue (String value) |
Package Functions | |
| String | getKey () |
UserAttributeValue (from UserAttributes)
Generalizations
EAElement (from Elements)
Description
UserAttributeValue represents a specific value for a certain user attribute. User attributes are simple key/value pairs which can be attached to all UserAttributeableElements. Each user attribute is identified by a globally unique key.
In principle, there is no restriction which user attributes, i.e. keys, may be attached to a particular element and what strings may be used as value (cf. class UserAttributeableElement). However, user attribute definitions can be used to define a set of legal values for a particular key (see class UserAttributeDefinition) and user attribute element types can be used to state what attributes, i.e. keys, may or should be attached to elements of certain types (cf. class UserAttributeElementType).
The actual value is captured in attribute 'value' and is always represented as a string.
Attributes
Associations
No additional associations
Constraints
No additional constraints
Semantics
-
| String de.fraunhofer.isst.eastadl.userattributes.UserAttributeValue.getKey | ( | ) | [package] |
Returns the value of the 'Key' attribute.
key : String [1]
The globally unique identifier of the user attribute for which this UserAttributeValue provides a value. Any string may be used as key as long as it is globally unique. However, there is a recommended procedure for building globally unique keys for user attributes, similar to packages in the Java programming language:
(1) use an internet domain name which is sufficiently specific so that you have control over who will use it for user attribute key generation (e.g. "myDepartment.myCompany.com")
(2) reverse it as in Java package names (e.g. "com.myCompany.myDepartment")
(3) optionally append additional, dot-separated names for the specific context in which the user attribute is to be used (e.g. "myProject" which results in "com.myCompany.myDepartment.myProject")
(4) add a last segment that names the user attribute and is sufficiently descriptive to explain its purpose (e.g. "ReviewStatus").
In this example, the key of our status attribute would be "com.myCompany.myDepartment.myProject.ReviewStatus".
In general, the last segment of the key, i.e. everything following the last dot, should be sufficient to identify the attribute in its usual, most specific context of use. Therefore, implementations may use this last segment as an abbreviated name of the user attribute, e.g. for presenting it in a GUI.
Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeValueImpl.
| String de.fraunhofer.isst.eastadl.userattributes.UserAttributeValue.getValue | ( | ) |
Returns the value of the 'Value' attribute.
value : String [1]
Holds the actual value of the user attribute identified by 'key'. This value is always represented as a string. Non-string values, such as integers, are specified by their corresponding string representation.
In cases where a UserAttributeDefinition is in effect and declares a particular Datatype for a user attribute (cf. association 'type' in UserAttributeDefinition), the 'value' attribute will hold the string representation of any valid value of this data type. The precise format depends on the data type: for numeric types the radix must be 10 and "." is to be used as decimal point ; date format is milliseconds since the standard base time known as "the
epoch", namely January 1, 1970, 00:00:00 GMT ; multi-valued types are realized as a comma-separated list of individual values.
Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeValueImpl.
| void de.fraunhofer.isst.eastadl.userattributes.UserAttributeValue.setKey | ( | String | value | ) |
Sets the value of the 'Key' attribute.
key : String [1]
The globally unique identifier of the user attribute for which this UserAttributeValue provides a value. Any string may be used as key as long as it is globally unique. However, there is a recommended procedure for building globally unique keys for user attributes, similar to packages in the Java programming language:
(1) use an internet domain name which is sufficiently specific so that you have control over who will use it for user attribute key generation (e.g. "myDepartment.myCompany.com")
(2) reverse it as in Java package names (e.g. "com.myCompany.myDepartment")
(3) optionally append additional, dot-separated names for the specific context in which the user attribute is to be used (e.g. "myProject" which results in "com.myCompany.myDepartment.myProject")
(4) add a last segment that names the user attribute and is sufficiently descriptive to explain its purpose (e.g. "ReviewStatus").
In this example, the key of our status attribute would be "com.myCompany.myDepartment.myProject.ReviewStatus".
In general, the last segment of the key, i.e. everything following the last dot, should be sufficient to identify the attribute in its usual, most specific context of use. Therefore, implementations may use this last segment as an abbreviated name of the user attribute, e.g. for presenting it in a GUI.
| value | the new value of the 'Key' attribute. |
Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeValueImpl.
| void de.fraunhofer.isst.eastadl.userattributes.UserAttributeValue.setValue | ( | String | value | ) |
Sets the value of the 'Value' attribute.
value : String [1]
Holds the actual value of the user attribute identified by 'key'. This value is always represented as a string. Non-string values, such as integers, are specified by their corresponding string representation.
In cases where a UserAttributeDefinition is in effect and declares a particular Datatype for a user attribute (cf. association 'type' in UserAttributeDefinition), the 'value' attribute will hold the string representation of any valid value of this data type. The precise format depends on the data type: for numeric types the radix must be 10 and "." is to be used as decimal point ; date format is milliseconds since the standard base time known as "the
epoch", namely January 1, 1970, 00:00:00 GMT ; multi-valued types are realized as a comma-separated list of individual values.
| value | the new value of the 'Value' attribute. |
Implemented in de.fraunhofer.isst.eastadl.userattributes.impl.UserAttributeValueImpl.
1.7.1