com.axemble.vdoc.sdk.interfaces

Interface ICategory

All Superinterfaces:

IElement, ILibraryElement, IProtocolSupport, Serializable

public interface ICategory
extends IElement, IProtocolSupport, ILibraryElement

The ICategory interface represents a category object.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IBaseLibraryModule, ILibrary, IFile

Method Summary

Modifier and Type	Method and Description
Collection	getCategories() Gets the child categories
ICategory	getCategory(String name) Gets a child ICategory object by its name.
String	getDescription() Gets the description of the category.
String	getName() Gets the name of the ICategory object.
ICategory	getParentCategory() Gets the parent category.
void	setDescription(String description) Sets the description of the category.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Gets the name of the ICategory object.

Specified by:

getName in interface ILibraryElement

Returns:

The name of the category object.

setDescription

void setDescription(String description)

Sets the description of the category.

Parameters:

description - the new description to set.

getDescription

String getDescription()

Gets the description of the category.

Specified by:

getDescription in interface ILibraryElement

Returns:

a String of the file.

getCategories

Collection getCategories()

Gets the child categories

Returns:

A collection of ICategory objects.

getCategory

ICategory getCategory(String name)

Gets a child ICategory object by its name.

Parameters:

name - The name of the child category.

Returns:

A ICategory object.

getParentCategory

ICategory getParentCategory()

Gets the parent category.

Returns:

A ICategory object.