org.olat.catalog
Interface CatalogEntry

All Superinterfaces:

CreateInfo, OLATResourceable, Persistable, java.io.Serializable

All Known Implementing Classes:

CatalogEntryImpl

public interface CatalogEntry
extends CreateInfo, Persistable, OLATResourceable

Description:
A CatalogEntry represents either a category or an alias to a linked repository entry. The distinction is made by using the TYPE_XXX attributes.
Further the catalog entries together build up the catalog, which is a tree structure. This tree structure is implemented by having each catalog entry pointing to its parent.

Author:

Felix Jost

Field Summary

static int	TYPE_LEAF define a catalog entry as a leaf TYPE_LEAF
static int	TYPE_NODE define a catalog entry as a node TYPE_NODE

Method Summary

java.lang.String	getDescription() getter
java.lang.String	getExternalURL() getter for an external URL pointer of ths catalogentry
java.lang.String	getName() getter
SecurityGroup	getOwnerGroup() getter
CatalogEntry	getParent() parent node of this catalog entry
RepositoryEntry	getRepositoryEntry() getter
int	getType() getter
void	setDescription(java.lang.String description) setter
void	setExternalURL(java.lang.String externalURL) setter for an external URL pointer of ths catalogentry
void	setName(java.lang.String name) setter
void	setOwnerGroup(SecurityGroup ownerGroup) getter
void	setParent(CatalogEntry parent) parent node of this catalog entry
void	setRepositoryEntry(RepositoryEntry repositoryEntry) setter
void	setType(int type) setter

Methods inherited from interface org.olat.core.id.CreateInfo

getCreationDate

Methods inherited from interface org.olat.core.id.Persistable

equalsByPersistableKey, getKey

Methods inherited from interface org.olat.core.id.OLATResourceable

getResourceableId, getResourceableTypeName

Field Detail

TYPE_NODE

static final int TYPE_NODE

define a catalog entry as a node TYPE_NODE

See Also:

Constant Field Values

TYPE_LEAF

static final int TYPE_LEAF

define a catalog entry as a leaf TYPE_LEAF

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()

getter

Returns:

String

setDescription

void setDescription(java.lang.String description)

setter

Parameters:

description -

getName

java.lang.String getName()

getter

Returns:

String

setName

void setName(java.lang.String name)

setter

Parameters:

name -

getRepositoryEntry

RepositoryEntry getRepositoryEntry()

getter

Returns:

RepositoryEntry

setRepositoryEntry

void setRepositoryEntry(RepositoryEntry repositoryEntry)

setter

Parameters:

repositoryEntry -

getOwnerGroup

SecurityGroup getOwnerGroup()

getter

Returns:

SecurityGroup

setOwnerGroup

void setOwnerGroup(SecurityGroup ownerGroup)

getter

Parameters:

ownerGroup -

getType

int getType()

getter

Returns:

int

See Also:

TYPE_LEAF, TYPE_NODE

setType

void setType(int type)

setter

Parameters:

type -

See Also:

TYPE_LEAF, TYPE_NODE

getExternalURL

java.lang.String getExternalURL()

getter for an external URL pointer of ths catalogentry

Returns:

String

setExternalURL

void setExternalURL(java.lang.String externalURL)

setter for an external URL pointer of ths catalogentry

Parameters:

externalURL -

setParent

void setParent(CatalogEntry parent)

parent node of this catalog entry

Parameters:

parent -

getParent

CatalogEntry getParent()

parent node of this catalog entry

Returns:

CatalogEntry