Package com.axemble.vdoc.sdk.impl

Class PortalCategory

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalElement

com.axemble.vdoc.sdk.impl.PortalCategory

All Implemented Interfaces:

ICategory, IElement, ILibraryElement, IProtocolSupport, Serializable

public class PortalCategory
extends PortalElement
implements ICategory

Author:

vlygeros

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected com.axemble.webdrive.om.CategoryNode	category

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalElement

path, storageKey

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Constructor	Description
PortalCategory(IModule module, com.axemble.webdrive.om.CategoryNode category)

Method Summary

Modifier and Type	Method	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.
Object	getNativeObject()	Gets the native object underneath.
ICategory	getParentCategory()	Gets the parent category.
void	setDescription(String description)	Sets the description of the category.

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalElement

equals, getId, getPath, getProtocolURI, getProtocolURI, hashCode, replaceBackSlash, replaceSlash, save, setId

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getId, getModule, getPath, save

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

getProtocolURI, getProtocolURI

Field Details

category

protected com.axemble.webdrive.om.CategoryNode category

Constructor Details

PortalCategory

public PortalCategory(IModule module,
 com.axemble.webdrive.om.CategoryNode category)

Method Details

getNativeObject

public Object getNativeObject()

Description copied from interface: IElement

Gets the native object underneath.

Specified by:

getNativeObject in interface IElement

Returns:

an object.

getName

public String getName()

Description copied from interface: ICategory

Gets the name of the ICategory object.

Specified by:

getName in interface ICategory

Specified by:

getName in interface ILibraryElement

Returns:

The name of the category object.

getCategories

public Collection getCategories()

Description copied from interface: ICategory

Gets the child categories

Specified by:

getCategories in interface ICategory

Returns:

A collection of ICategory objects.

getCategory

public ICategory getCategory(String name)

Description copied from interface: ICategory

Gets a child ICategory object by its name.

Specified by:

getCategory in interface ICategory

Parameters:

name - The name of the child category.

Returns:

A ICategory object.

getParentCategory

public ICategory getParentCategory()

Description copied from interface: ICategory

Gets the parent category.

Specified by:

getParentCategory in interface ICategory

Returns:

A ICategory object.

getDescription

public String getDescription()

Description copied from interface: ICategory

Gets the description of the category.

Specified by:

getDescription in interface ICategory

Specified by:

getDescription in interface ILibraryElement

Returns:

a String of the file.

setDescription

public void setDescription(String description)

Description copied from interface: ICategory

Sets the description of the category.

Specified by:

setDescription in interface ICategory

Parameters:

description - the new description to set.