com.ibm.ram.common.data
Class AssetAttribute

java.lang.Object
  extended by com.ibm.ram.common.data.AssetAttribute
Direct Known Subclasses:
RAMAssetAttribute

public class AssetAttribute
extends java.lang.Object

Defines the attribute of the asset. The class contains the name of the attribute and the URI string to the attribute in the classification schemas. It might also contain a description.

Since:
7.1

Field Summary
static java.lang.String TYPE_BOOLEAN
          Boolean Attribute Type
static java.lang.String TYPE_DATE
          Date Attribute Type
static java.lang.String TYPE_LINK
          Link Attribute Type
static java.lang.String TYPE_NUMBER
          Numeric Attribute Type
static java.lang.String TYPE_RESOURCE
          Jazz resource attribute type
static java.lang.String TYPE_TEXT
          Text Attribute Type
static java.lang.String TYPE_USER
          User Attribute Type
static java.lang.String TYPE_XML
          XML Artifact bound Attribute Type
 
Constructor Summary
AssetAttribute()
          Construct a default Attribute
 
Method Summary
 java.lang.String getDescription()
          The optional description.
 java.lang.String getName()
          Get the name of the attribute.
 java.lang.String getType()
           
 java.lang.String getURI()
          The string will be fully-qualified.
 java.lang.String[] getValidValues()
          Get the array of valid settings.
 java.lang.String[] getValues()
          Returns the value of this custom attribute
 boolean isRestrictedSetting()
          Answer whether this is a standard any value setting, or if it is a restricted value setting (i.e.
 boolean isSingleSetting()
          Answer whether this is a single setting attribute of a multi-setting attribute.
 void setDescription(java.lang.String description)
           
 void setName(java.lang.String name)
           
 void setRestrictedSetting(boolean restrictedSetting)
          The array of valid settings.
 void setSingleSetting(boolean singleSetting)
           
 void setType(java.lang.String type)
           
 void setURI(java.lang.String uriString)
           
 void setValidValues(java.lang.String[] validSettings)
           
 void setValues(java.lang.String[] values)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_BOOLEAN

public static final java.lang.String TYPE_BOOLEAN
Boolean Attribute Type

Since:
7.1.1

TYPE_DATE

public static final java.lang.String TYPE_DATE
Date Attribute Type

Since:
7.1.1

TYPE_LINK

public static final java.lang.String TYPE_LINK
Link Attribute Type

Since:
7.1.1

TYPE_NUMBER

public static final java.lang.String TYPE_NUMBER
Numeric Attribute Type

Since:
7.1.1

TYPE_TEXT

public static final java.lang.String TYPE_TEXT
Text Attribute Type

Since:
7.1.1

TYPE_RESOURCE

public static final java.lang.String TYPE_RESOURCE
Jazz resource attribute type

Since:
7.5

TYPE_USER

public static final java.lang.String TYPE_USER
User Attribute Type

Since:
7.1.1

TYPE_XML

public static final java.lang.String TYPE_XML
XML Artifact bound Attribute Type

Since:
7.1.1
Constructor Detail

AssetAttribute

public AssetAttribute()
Construct a default Attribute

Since:
7.1
Method Detail

getURI

public java.lang.String getURI()
The string will be fully-qualified.

Returns:
Returns the uriString.
Since:
7.1

setURI

public void setURI(java.lang.String uriString)
Parameters:
uriString - The uriString to set.
Since:
7.1

getName

public java.lang.String getName()
Get the name of the attribute.

Returns:
the attribute name. If it could not be resolved then this would be the uri string.
Since:
7.1

getDescription

public java.lang.String getDescription()
The optional description.

Returns:
Returns the description. null if there is no description.
Since:
7.1

setDescription

public void setDescription(java.lang.String description)
Parameters:
description - The description to set.
Since:
7.1

setName

public void setName(java.lang.String name)
Parameters:
name - The name to set.
Since:
7.1

isRestrictedSetting

public boolean isRestrictedSetting()
Answer whether this is a standard any value setting, or if it is a restricted value setting (i.e. only values from a specific list).

Returns:
true if restricted, false if no restriction.
Since:
7.1

isSingleSetting

public boolean isSingleSetting()
Answer whether this is a single setting attribute of a multi-setting attribute. This is only valid if isRestrictedSetting() returns true.

Returns:
Returns if this is a single-setting attribute (only one setting can selected).
Since:
7.1

setSingleSetting

public void setSingleSetting(boolean singleSetting)
Parameters:
singleSetting - The singleSetting to set.
Since:
7.1

getValidValues

public java.lang.String[] getValidValues()
Get the array of valid settings. This is only valid if isRestrictedSetting() returns true.

Returns:
Returns the validSettings.
Since:
7.1
See Also:
isRestrictedSetting(), isSingleSetting()

setValidValues

public void setValidValues(java.lang.String[] validSettings)
Parameters:
validSettings - The validSettings to set.
Since:
7.1

getValues

public java.lang.String[] getValues()
Returns the value of this custom attribute

Since:
7.1

setValues

public void setValues(java.lang.String[] values)
Parameters:
validSettings - The validSettings to set.
Since:
7.1

getType

public java.lang.String getType()
Returns:
Returns the type.
Since:
7.1.1

setType

public void setType(java.lang.String type)
Parameters:
type - The type to set.
Since:
7.1.1

setRestrictedSetting

public void setRestrictedSetting(boolean restrictedSetting)
The array of valid settings. This is only valid if isRestrictedSetting() returns true.

Since:
7.1
See Also:
isRestrictedSetting(), isSingleSetting()