org.osid.offering

Interface CatalogueHierarchyDesignSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.