com.ibm.ram.common.data
Class SubCategory

java.lang.Object
  extended by com.ibm.ram.common.data.SubCategory
Direct Known Subclasses:
RAMSubCategory

public class SubCategory
extends java.lang.Object

Can be set on an asset to further categorize the asset. Category schemas contain categories, and categories contain subcategories.

Since:
7.1

Constructor Summary
SubCategory()
          Constructor
SubCategory(java.lang.String name)
          Constructor
 
Method Summary
 java.lang.String getCategorization()
           
 java.lang.String getFullPath()
          The Full path to the sub category in the form...
 java.lang.String getId()
          The Unique ID of the Sub Category with in the Category Schema
 java.lang.String getName()
           
 SubCategory[] getSubCategories()
           
 SubCategory getSubCategory(java.lang.String name)
          Returns a category by fName
 boolean isSet()
          This method is used when a sub category is only applied to an asset.
 void setCategorization(java.lang.String categorization)
           
 void setFullPath(java.lang.String fullPath)
           
 void setId(java.lang.String id)
          Set the Unique ID of a Sub Category from within the Category Schema
 void setName(java.lang.String name)
           
 void setSet(boolean set)
          This method is used when a sub category is only applied to an asset.
 void setSubCategories(SubCategory[] categories)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubCategory

public SubCategory()
Constructor

Since:
7.1

SubCategory

public SubCategory(java.lang.String name)
Constructor

Since:
7.1.1
Method Detail

getId

public java.lang.String getId()
The Unique ID of the Sub Category with in the Category Schema

Returns:
Since:
7.1.1

setId

public void setId(java.lang.String id)
Set the Unique ID of a Sub Category from within the Category Schema

Parameters:
id -
Since:
7.1.1

getCategorization

public java.lang.String getCategorization()
Returns:
the path to this sub-category form category
Since:
7.1

setCategorization

public void setCategorization(java.lang.String categorization)

getName

public java.lang.String getName()
Returns:
The fName of the sub category
Since:
7.1

setName

public void setName(java.lang.String name)
Parameters:
fName - The fName of the sub category.
Since:
7.1

getSubCategories

public SubCategory[] getSubCategories()
Returns:
the list of sub categories that are children on this sub category.
Since:
7.1

setSubCategories

public void setSubCategories(SubCategory[] categories)
Parameters:
categories - The list of sub categories.
Since:
7.1

setFullPath

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

getFullPath

public java.lang.String getFullPath()
The Full path to the sub category in the form... CategorySchemaName/CatgeoryName/Categorization

Returns:
The Full path to the sub category.
Since:
7.1

getSubCategory

public SubCategory getSubCategory(java.lang.String name)
Returns a category by fName

Since:
7.1

isSet

public boolean isSet()
This method is used when a sub category is only applied to an asset. This indicates weather this specific sub category was set on the asset. For Example if an asset had the categorizations of... MySchema/Cat1/Sub1/Sub2/Sub3 MySchema/Cat1/Sub1 The SubCatgeories Sub1 and Sub3 would return true and Sub2 would return false.

Returns:
Returns the set.
Since:
7.1

setSet

public void setSet(boolean set)
This method is used when a sub category is only applied to an asset. This indicates weather this specific sub category was set on the asset. For Example if an asset had the categorizations of... MySchema/Cat1/Sub1/Sub2/Sub3 MySchema/Cat1/Sub1 The SubCatgeories Sub1 and Sub3 would be set to true and Sub2 would be set to false.

Parameters:
set - The set to set.
Since:
7.1