org.ametys.plugins.explorer

Interface ExplorerNode

All Superinterfaces:

AmetysObject

All Known Subinterfaces:

Calendar, ModifiableCalendar, ModifiableExplorerNode, ModifiableResourceCollection, ModifiableTasksList, ModifiableThread, ResourceCollection, Thread

All Known Implementing Classes:

CMISResourcesCollection, CMISRootResourcesCollection, JCRCalendar, JCRResourcesCollection, JCRTasksList, JCRThread

public interface ExplorerNode
extends AmetysObject

AmetysObject composing the resources tree of the resources explorer.

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() Returns the application id corresponding to this Node.
String	getDescription() Get the description of the application
String	getExplorerPath() Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository). If this collection is the root explorer node, "" is returned.
String	getIconCls() Returns the icon css class for this Node.
boolean	hasChildExplorerNodes() Returns true if this explorer node contains child explorer nodes.

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Method Detail

getIconCls

String getIconCls()

Returns the icon css class for this Node.

Returns:

the icon css class for this Node for rendering in the tree.

getApplicationId

String getApplicationId()

Returns the application id corresponding to this Node.

Returns:

the application id corresponding to this Node.

getExplorerPath

String getExplorerPath()

Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository).
If this collection is the root explorer node, "" is returned.

Returns:

the path of this node in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

hasChildExplorerNodes

boolean hasChildExplorerNodes()
                       throws AmetysRepositoryException

Returns true if this explorer node contains child explorer nodes.

Returns:

true if this explorer node contains child explorer nodes.

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

String getDescription()

Get the description of the application

Returns:

the description