Interface CatalogHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of catalogs. Catalogs may be organized into a hierarchy for organizing or federating. A parent Catalog includes all of the Ids of its children such that a single root node contains all of the Ids of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildCatalog(Id catalogId, Id childId)	Adds a child to a catalog.
void	addRootCatalog(Id catalogId)	Adds a root catalog.
boolean	canModifyCatalogHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCatalogHierarchy()	Gets the hierarchy associated with this session.
Id	getCatalogHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCatalog(Id catalogId, Id childId)	Removes a child from a catalog.
void	removeChildCatalogs(Id catalogId)	Removes all children from a catalog.
void	removeRootCatalog(Id catalogId)	Removes a root catalog.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCatalogHierarchyId

Id getCatalogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogHierarchy

Hierarchy getCatalogHierarchy()
                       throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

canModifyCatalogHierarchy

boolean canModifyCatalogHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootCatalog

void addRootCatalog(Id catalogId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root catalog.

Parameters:

catalogId - the Id of a catalog

Throws:

AlreadyExistsException - catalogId is already in hierarchy

NotFoundException - catalogId not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeRootCatalog

void removeRootCatalog(Id catalogId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root catalog.

Parameters:

catalogId - the Id of a catalog

Throws:

NotFoundException - catalogId is not a root

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

addChildCatalog

void addChildCatalog(Id catalogId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a catalog.

Parameters:

catalogId - the Id of a catalog

childId - the Id of the new child

Throws:

AlreadyExistsException - catalogId is already a parent of childId

NotFoundException - catalogId or childId not found

NullArgumentException - catalogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeChildCatalog

void removeChildCatalog(Id catalogId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a catalog.

Parameters:

catalogId - the Id of a catalog

childId - the Id of the new child

Throws:

NotFoundException - catalogId is not a parent of childId

NullArgumentException - catalogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

removeChildCatalogs

void removeChildCatalogs(Id catalogId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a catalog.

Parameters:

catalogId - the Id of a catalog

Throws:

NotFoundException - catalogId is not in hierarchy

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.