|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.ram.common.data.CategorySchema
com.ibm.ram.client.RAMCategorySchema
public class RAMCategorySchema
Defines a category schema, which is a collection of categories that can be applied to assets to categorize the assets. This object can be a modifiable instance that is obtained from the session or a read-only instance that is obtained from a specific asset.
| Method Summary | |
|---|---|
void |
clear()
Clears out any cached category schema objects so that it can be rebuilt based on the maifest |
RAMCategory |
createCategory(java.lang.String name)
Create a new category to populate for upload. |
RAMAction |
getAction()
Set the action to be performed on the session object. |
Category[] |
getCategories()
|
Category |
getCategory(java.lang.String name)
Returns a category by name |
java.lang.String |
getDescription()
Return the description of the category schema |
java.lang.String |
getName()
|
RAMCommunity[] |
getRestrictedCommunities()
If this category schema is restricted to specific communities this returns all restricted communities if not restricted all communities are returned. |
RAMSubCategory |
getSubCategoryById(java.lang.String id)
Given an id fetch a sub category within the category schema |
java.lang.String |
getURI()
|
boolean |
isDirty()
Returns true if the Object has been modified from the copy on the server |
boolean |
isRestricted()
Is the category schema restricted to a set of communities |
void |
setAction(RAMAction action)
Set the action to be performed when passed to RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor)
Accepts
RAMAction.CREATE
RAMAction.UPDATE
RAMAction.DELETE |
void |
setCategories(Category[] categories)
|
void |
setDescription(java.lang.String desciption)
|
void |
setName(java.lang.String name)
|
void |
setRestricted(boolean restricted)
Set that this set of category schemas is restricted to a set of communities. |
void |
setRestrictedCommunities(CommunityInformation[] communities)
Set the communities explicitly set to be restricted to. |
void |
setURI(java.lang.String uri)
|
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public Category[] getCategories()
getCategories in class CategorySchemapublic void clear()
public Category getCategory(java.lang.String name)
CategorySchema
getCategory in class CategorySchemapublic RAMSubCategory getSubCategoryById(java.lang.String id)
id -
public java.lang.String getName()
getName in class CategorySchemapublic void setName(java.lang.String name)
setName in class CategorySchemaname - The name of the Category Schema.public java.lang.String getDescription()
public void setDescription(java.lang.String desciption)
name - public java.lang.String getURI()
getURI in class CategorySchemapublic void setURI(java.lang.String uri)
setURI in class CategorySchemauri - The URI of this Category Schema.public boolean isDirty()
public java.lang.String toString()
toString in class java.lang.Objectpublic void setCategories(Category[] categories)
setCategories in class CategorySchemacategories - The list of child categories.public RAMCategory createCategory(java.lang.String name)
public RAMAction getAction()
public void setAction(RAMAction action)
RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor)
Accepts
RAMAction.CREATE
RAMAction.UPDATE
RAMAction.DELETE
action - public boolean isRestricted()
public void setRestricted(boolean restricted)
restricted - the restricted to set
public RAMCommunity[] getRestrictedCommunities()
throws RAMRuntimeException
RAMRuntimeExceptionpublic void setRestrictedCommunities(CommunityInformation[] communities)
communities - The communities this schema is restricted to
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||