com.ibm.ram.client
Class RAMSubCategory

java.lang.Object
  extended by com.ibm.ram.common.data.SubCategory
      extended by com.ibm.ram.client.RAMSubCategory

public class RAMSubCategory
extends SubCategory

Is applied to an asset to categorize the asset. Category schemas contain categories, and categories contain subcategories.

Since:
7.1
Author:
kbauer

Method Summary
 RAMSubCategory createSubCategory(java.lang.String name)
          Create a new sub ategory to populate for upload
 java.lang.String getCategorization()
           
 Category getCategory()
          The category this sub-category belongs to
protected  java.lang.String getChildPath(Descriptor descriptor)
           
 java.lang.String getEncodedName()
           
 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 isDirty()
          Returns true is the Sub Category has been modified.
 boolean isExclusive()
          If a Sub Category's children are exclusive they cannot be selected along with child siblings.
 void setCategorization(java.lang.String categorization)
           
 void setExclusive(boolean exclusive)
          Set the Sub-Category's children as exclusive
 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)
           
 java.lang.String toString()
           
 
Methods inherited from class com.ibm.ram.common.data.SubCategory
isSet
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getSubCategories

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

getSubCategory

public SubCategory getSubCategory(java.lang.String name)
Description copied from class: SubCategory
Returns a category by fName

Overrides:
getSubCategory in class SubCategory

isExclusive

public boolean isExclusive()
If a Sub Category's children are exclusive they cannot be selected along with child siblings.

Returns:
true if this is an exclusive sub-category
Since:
7.1

setExclusive

public void setExclusive(boolean exclusive)
Set the Sub-Category's children as exclusive

Parameters:
exclusive - children are exclusive
Since:
7.2.0.1

isDirty

public boolean isDirty()
Returns true is the Sub Category has been modified.

Since:
7.1

getCategory

public Category getCategory()
The category this sub-category belongs to

Returns:
the category
Since:
7.1

getCategorization

public java.lang.String getCategorization()
Overrides:
getCategorization in class SubCategory
Returns:
the path to this sub-category form category

getFullPath

public java.lang.String getFullPath()
Description copied from class: SubCategory
The Full path to the sub category in the form... CategorySchemaName/CatgeoryName/Categorization

Overrides:
getFullPath in class SubCategory
Returns:
The Full path to the sub category.

getChildPath

protected java.lang.String getChildPath(Descriptor descriptor)
Parameters:
descriptor -
Returns:
Since:
7.1

createSubCategory

public RAMSubCategory createSubCategory(java.lang.String name)
Create a new sub ategory to populate for upload

Since:
7.1

getName

public java.lang.String getName()
Overrides:
getName in class SubCategory
Returns:
The fName of the sub category

getEncodedName

public java.lang.String getEncodedName()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setFullPath

public void setFullPath(java.lang.String fullPath)
Overrides:
setFullPath in class SubCategory
Parameters:
fullPath - The fullPath to set.

setName

public void setName(java.lang.String name)
Overrides:
setName in class SubCategory

getId

public java.lang.String getId()
Description copied from class: SubCategory
The Unique ID of the Sub Category with in the Category Schema

Overrides:
getId in class SubCategory
Returns:

setCategorization

public void setCategorization(java.lang.String categorization)
Overrides:
setCategorization in class SubCategory

setId

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

Overrides:
setId in class SubCategory

setSubCategories

public void setSubCategories(SubCategory[] categories)
Overrides:
setSubCategories in class SubCategory
Parameters:
categories - The list of sub categories.

setSet

public void setSet(boolean set)
Description copied from class: SubCategory
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.

Overrides:
setSet in class SubCategory
Parameters:
set - The set to set.