org.osid.course.syllabus

Interface SyllabusLookupSession

All Superinterfaces:

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

public interface SyllabusLookupSession
extends OsidSession

This session defines methods for retrieving syllabi.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated course catalog view: All syllabus methods in this session operate, retrieve and pertain to syllabi defined explicitly in the current course catalog. Using an isolated view is useful for managing syllabi with the SyllabusAdminSession.
• federated course catalog view: All syllabus lookup methods in this session operate, retrieve and pertain to all syllabi defined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupSyllabi() Tests if this user can lookup syllabi.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
SyllabusList	getSyllabi() Gets all syllabi.
SyllabusList	getSyllabiByGenusType(Type syllabusGenusType) Gets a SyllabusList corresponding to the given syllabus genus Type which does not include syllabi of genus types derived from the specified Type.
SyllabusList	getSyllabiByIds(IdList syllabusIds) Gets a SyllabusList corresponding to the given IdList.
SyllabusList	getSyllabiByParentGenusType(Type syllabusGenusType) Gets a SyllabusList corresponding to the given syllabus genus Type and include any additional syllabi with genus types derived from the specified Type.
SyllabusList	getSyllabiByRecordType(Type syllabusRecordType) Gets a SyllabusList containing the given syllabus record Type.
SyllabusList	getSyllabiForCourse(Id courseId) Gets a SyllabusList for the given course .
Syllabus	getSyllabus(Id syllabusId) Gets the Syllabus specified by its Id.
void	useComparativeSyllabusView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenarySyllabusView() A complete view of the Syllabus returns is desired.

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

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSyllabi

boolean canLookupSyllabi()

Tests if this user can lookup syllabi. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 these operations.

Returns:

false if syllabus lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSyllabusView

void useComparativeSyllabusView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySyllabusView

void usePlenarySyllabusView()

A complete view of the Syllabus returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include syllabi in course catalogs which are children of this course catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getSyllabus

Syllabus getSyllabus(Id syllabusId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the Syllabus specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Syllabus may have a different Id than requested, such as the case where a duplicate Id was assigned to a Syllabus and retained for compatibility.

Parameters:

syllabusId - the Id of the Syllabus to retrieve

Returns:

the returned Syllabus

Throws:

NotFoundException - no Syllabus found with the given Id

NullArgumentException - syllabusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabiByIds

SyllabusList getSyllabiByIds(IdList syllabusIds)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets a SyllabusList corresponding to the given IdList. In plenary mode, the returned list contains all of the syllabi specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible syllabi may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

syllabusIds - the list of Ids to retrieve

Returns:

the returned Syllabus list

Throws:

NotFoundException - an Id was not found

NullArgumentException - syllabusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabiByGenusType

SyllabusList getSyllabiByGenusType(Type syllabusGenusType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a SyllabusList corresponding to the given syllabus genus Type which does not include syllabi of genus types derived from the specified Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parameters:

syllabusGenusType - a syllabus genus type

Returns:

the returned Syllabus list

Throws:

NullArgumentException - syllabusGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabiByParentGenusType

SyllabusList getSyllabiByParentGenusType(Type syllabusGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a SyllabusList corresponding to the given syllabus genus Type and include any additional syllabi with genus types derived from the specified Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parameters:

syllabusGenusType - a syllabus genus type

Returns:

the returned Syllabus list

Throws:

NullArgumentException - syllabusGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabiByRecordType

SyllabusList getSyllabiByRecordType(Type syllabusRecordType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a SyllabusList containing the given syllabus record Type. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parameters:

syllabusRecordType - a syllabus record type

Returns:

the returned Syllabus list

Throws:

NullArgumentException - syllabusRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabiForCourse

SyllabusList getSyllabiForCourse(Id courseId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a SyllabusList for the given course . In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Parameters:

courseId - a course Id

Returns:

the returned Syllabus list

Throws:

NullArgumentException - courseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSyllabi

SyllabusList getSyllabi()
                        throws OperationFailedException,
                               PermissionDeniedException

Gets all syllabi. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session.

Returns:

a list of syllabi

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.