KimAttribute

Name KimAttribute
Usage KimTypeInfoService
KimTypeAttribute
Type Complex

Description

An immutable representation of a {@link KimAttributeContract}.

To construct an instance of a KimAttribute, use the {@link KimAttribute.Builder} class.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Id String The unique identifier for an object. This can be null.     One No  
componentName Component Name String A fully-qualified class name which contains the {@link #getAttributeName()}. This cannot be null or a blank string.     One No  
attributeName Attribute Name String The name of the attribute on the {@link #getComponentName()}. This cannot be null or a blank string. Required   One No  
namespaceCode Namespace Code String The namespace code that this kim attribute belongs too. This cannot be null or a blank string. Required   One No  
attributeLabel Attribute Label String The label for the kim attribute. This is optional and can be null or blank.     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.
    One No  
objectId Object Id String Return the globally unique object id of this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
    One No