Interface CourseCatalogHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CourseCatalogHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of CourseCatalogs . Each node in the hierarchy is a unique CourseCatalog .

Method Summary

Modifier and Type	Method	Description
void	addChildCourseCatalog(Id courseCatalogId, Id childId)	Adds a child to a course catalog.
void	addRootCourseCatalog(Id courseCatalogId)	Adds a root course ecatalog.
boolean	canModifyCourseCatalogHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCourseCatalogHierarchy()	Gets the hierarchy associated with this session.
Id	getCourseCatalogHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCourseCatalog(Id courseCatalogId, Id childId)	Removes a child from a course catalog.
void	removeChildCourseCatalogs(Id courseCatalogId)	Removes all children from a course catalog.
void	removeRootCourseCatalog(Id courseCatalogId)	Removes a root course ecatalog.

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

getCourseCatalogHierarchyId

Id getCourseCatalogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalogHierarchy

Hierarchy getCourseCatalogHierarchy()
                             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.

canModifyCourseCatalogHierarchy

boolean canModifyCourseCatalogHierarchy()

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.

addRootCourseCatalog

void addRootCourseCatalog(Id courseCatalogId)
                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root course ecatalog.

Parameters:

courseCatalogId - the Id of a course catalog

Throws:

AlreadyExistsException - courseCatalogId is already in hierarchy

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootCourseCatalog

void removeRootCourseCatalog(Id courseCatalogId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root course ecatalog.

Parameters:

courseCatalogId - the Id of a course catalog

Throws:

NotFoundException - courseCatalogId not a root

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildCourseCatalog

void addChildCourseCatalog(Id courseCatalogId,
 Id childId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a course catalog.

Parameters:

courseCatalogId - the Id of a course catalog

childId - the Id of the new child

Throws:

AlreadyExistsException - courseCatalogId is already a parent of childId

NotFoundException - courseCatalogId or childId not found

NullArgumentException - courseCatalogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCourseCatalog

void removeChildCourseCatalog(Id courseCatalogId,
 Id childId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a course catalog.

Parameters:

courseCatalogId - the Id of a course catalog

childId - the Id of the new child

Throws:

NotFoundException - courseCatalogId is not a parent of childId

NullArgumentException - courseCatalogId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCourseCatalogs

void removeChildCourseCatalogs(Id courseCatalogId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a course catalog.

Parameters:

courseCatalogId - the Id of a course catalog

Throws:

NotFoundException - courseCatalogId is in hierarchy

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.