org.osid.course.syllabus

Interface SyllabusCourseCatalogAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SyllabusCourseCatalogAssignmentSession
extends OsidSession

This session provides methods to re-assign Syllabi to Course Catalogs. A Syllabus may map to multiple CourseCatalogs and removing the last reference to a Syllabus is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Syllabus to another CourseCatalog is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSyllabusToCourseCatalog(Id syllabusId, Id courseCatalogId) Adds an existing Syllabus to an CourseCatalog.
boolean	canAssignSyllabi() Tests if this user can alter syllabus/course catalog mappings.
boolean	canAssignSyllabussToCourseCatalog(Id courseCatalogId) Tests if this user can alter syllabus/course catalog mappings.
IdList	getAssignableCourseCatalogIds(Id courseCatalogId) Gets a list of course catalogs including and under the given course catalog node in which any syllabus can be assigned.
IdList	getAssignableCourseCatalogIdsForSyllabus(Id courseCatalogId, Id syllabusId) Gets a list of course catalogs including and under the given course catalog node in which a specific syllabus can be assigned.
void	reassignSyllabusToCourseCatalog(Id syllabusId, Id fromCourseCatalogId, Id toCourseCatalogId) Moves a Syllabus from one CourseCatalog to another.
void	unassignSyllabusFromCourseCatalog(Id syllabusId, Id courseCatalogId) Removes a Syllabus from an CourseCatalog.

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

canAssignSyllabi

boolean canAssignSyllabi()

Tests if this user can alter syllabus/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignSyllabussToCourseCatalog

boolean canAssignSyllabussToCourseCatalog(Id courseCatalogId)

Tests if this user can alter syllabus/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCourseCatalogIds

IdList getAssignableCourseCatalogIds(Id courseCatalogId)
                                     throws OperationFailedException

Gets a list of course catalogs including and under the given course catalog node in which any syllabus can be assigned.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCourseCatalogIdsForSyllabus

IdList getAssignableCourseCatalogIdsForSyllabus(Id courseCatalogId,
                                              Id syllabusId)
                                                throws OperationFailedException

Gets a list of course catalogs including and under the given course catalog node in which a specific syllabus can be assigned.

Parameters:

courseCatalogId - the Id of the CourseCatalog

syllabusId - the Id of the Syllabus

Returns:

list of assignable course catalog Ids

Throws:

NullArgumentException - courseCatalogId or syllabusId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSyllabusToCourseCatalog

void assignSyllabusToCourseCatalog(Id syllabusId,
                                 Id courseCatalogId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an existing Syllabus to an CourseCatalog.

Parameters:

syllabusId - the Id of the Syllabus

courseCatalogId - the Id of the CourseCatalog

Throws:

AlreadyExistsException - syllabusId is already assigned to courseCatalogId

NotFoundException - syllabusId or courseCatalogId not found

NullArgumentException - syllabusId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSyllabusFromCourseCatalog

void unassignSyllabusFromCourseCatalog(Id syllabusId,
                                     Id courseCatalogId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Removes a Syllabus from an CourseCatalog.

Parameters:

syllabusId - the Id of the Syllabus

courseCatalogId - the Id of the CourseCatalog

Throws:

NotFoundException - syllabusId or courseCatalogId not found or syllabusId not assigned to courseCatalogId

NullArgumentException - syllabusId or courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignSyllabusToCourseCatalog

void reassignSyllabusToCourseCatalog(Id syllabusId,
                                   Id fromCourseCatalogId,
                                   Id toCourseCatalogId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Moves a Syllabus from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

Parameters:

syllabusId - the Id of the Syllabus

fromCourseCatalogId - the Id of the current CourseCatalog

toCourseCatalogId - the Id of the destination CourseCatalog

Throws:

NotFoundException - syllabusId, fromCourseCatalogId, or toCourseCatalogId not found or syllabusId not mapped to fromCourseCatalogId

NullArgumentException - syllabusId, fromCourseCatalogId, or toCourseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.