Interface CatalogueHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogueHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of catalogues. Catalogues may be organized into a hierarchy for organizing or federating. A parent Catalogue includes all of the canonical units of its children such that a single root node contains all of the canonical units of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildCatalogue(Id catalogueId, Id childId)	Adds a child to a catalogue.
void	addRootCatalogue(Id catalogueId)	Adds a root catalogue.
boolean	canModifyCatalogueHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCatalogueHierarchy()	Gets the hierarchy associated with this session.
Id	getCatalogueHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCatalogue(Id catalogueId, Id childId)	Removes a child from a catalogue.
void	removeChildCatalogues(Id catalogueId)	Removes all children from a catalogue.
void	removeRootCatalogue(Id catalogueId)	Removes a root catalogue.

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

getCatalogueHierarchyId

Id getCatalogueHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogueHierarchy

Hierarchy getCatalogueHierarchy()
                         throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyCatalogueHierarchy

boolean canModifyCatalogueHierarchy()

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.

addRootCatalogue

void addRootCatalogue(Id catalogueId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root catalogue.

Parameters:

catalogueId - the Id of a catalogue

Throws:

AlreadyExistsException - catalogueId is already in hierarchy

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootCatalogue

void removeRootCatalogue(Id catalogueId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root catalogue.

Parameters:

catalogueId - the Id of a catalogue

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildCatalogue

void addChildCatalogue(Id catalogueId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a catalogue.

Parameters:

catalogueId - the Id of a catalogue

childId - the Id of the new child

Throws:

AlreadyExistsException - catalogueId is already a parent of childId

NotFoundException - catalogueId or childId not found

NullArgumentException - catalogueId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCatalogue

void removeChildCatalogue(Id catalogueId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a catalogue.

Parameters:

catalogueId - the Id of a catalogue

childId - the Id of the new child

Throws:

NotFoundException - catalogueId not a parent of childId

NullArgumentException - catalogueId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCatalogues

void removeChildCatalogues(Id catalogueId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a catalogue.

Parameters:

catalogueId - the Id of a catalogue

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.