public interface DocetLookupSession extends OsidSession
This session provides methods for retrieving Docet
objects. The Docet
represents a collection of syllabi.
This session defines views that offer differing behaviors when retrieving multiple objects.
DocetAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDocets()
Tests if this user can perform
Docet lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
Docet |
getDocet(Id docetId)
Gets the
Docet specified by its Id. |
DocetList |
getDocets()
Gets all
Docets. |
DocetList |
getDocetsByGenusType(Type docetGenusType)
Gets an
DocetList corresponding to the given docet
genus Type which does not include docetsof genus types
derived from the specified Type. |
DocetList |
getDocetsByIds(IdList docetIds)
Gets an
DocetList corresponding to the given
IdList. |
DocetList |
getDocetsByParentGenusType(Type docetGenusType)
Gets an
DocetList corresponding to the given docet
genus Type and include any additional docetswith genus
types derived from the specified Type. |
DocetList |
getDocetsByRecordType(Type docetRecordType)
Gets an
DocetList containing the given docet record
Type. |
DocetList |
getDocetsForActivityUnit(Id activityUnitId)
Gets an
DocetList for the given activity unit
Id. |
DocetList |
getDocetsForActivityUnitOnDate(Id activityUnitId,
DateTime from,
DateTime to)
Gets an
DocetList for an activity unit effective
sduring the entire given date range inclusive but not confined to the
date range. |
DocetList |
getDocetsForModule(Id moduleId)
Gets an
DocetList for the given module Id. |
DocetList |
getDocetsForModuleAndActivityUnit(Id moduleId,
Id activityUnitId)
Gets an
DocetList for the given module and activity
unit . |
DocetList |
getDocetsForModuleAndActivityUnitOnDate(Id moduleId,
Id activityUnitId,
DateTime from,
DateTime to)
Gets an
DocetList for a module and activity unit
effective during the entire given date range inclusive but not
confined to the date range. |
DocetList |
getDocetsForModuleOnDate(Id moduleId,
DateTime from,
DateTime to)
Gets an
DocetList for a module effective during the
entire given date range inclusive but not confined to the date range. |
DocetList |
getDocetsOnDate(DateTime from,
DateTime to)
Gets an
DocetList effective sduring the entire given
date range inclusive but not confined to the date range. |
void |
useAnyEffectiveDocetView()
All docets of any effective dates are returned by all methods in this
session.
|
void |
useComparativeDocetView()
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 |
useEffectiveDocetView()
Only docets whose effective dates are current are returned by methods
in this session.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryDocetView()
A complete view of the
Docet returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupDocets()
Docet
lookups. 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 not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeDocetView()
mandatory
- This method is must be implemented. void usePlenaryDocetView()
Docet
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.mandatory
- This method is must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useEffectiveDocetView()
mandatory
- This method is must be implemented. void useAnyEffectiveDocetView()
mandatory
- This method is must be implemented. Docet getDocet(Id docetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Docet
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Docet
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to
an Docet
and retained for compatibility.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.docetId
- Id
of the Docet
NotFoundException
- docetId
not foundNullArgumentException
- docetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. DocetList getDocetsByIds(IdList docetIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
DocetList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
docetsspecified 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 Docets
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.docetIds
- the list of Ids
to retrieve Docet
listNotFoundException
- an Id was
not foundNullArgumentException
- docetIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsByGenusType(Type docetGenusType) throws OperationFailedException, PermissionDeniedException
DocetList
corresponding to the given docet
genus Type
which does not include docetsof genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.docetGenusType
- a docet genus type Docet
listNullArgumentException
- docetGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsByParentGenusType(Type docetGenusType) throws OperationFailedException, PermissionDeniedException
DocetList
corresponding to the given docet
genus Type
and include any additional docetswith genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.docetGenusType
- a docet genus type Docet
listNullArgumentException
- docetGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsByRecordType(Type docetRecordType) throws OperationFailedException, PermissionDeniedException
DocetList
containing the given docet record
Type.
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.docetRecordType
- a docet record type Docet
listNullArgumentException
- docetRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
DocetList
effective sduring the entire given
date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known docetsor an
error results. Otherwise, the returned list may contain only those
docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.from
- s atsrting dateto
- an ending date Docet
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForModule(Id moduleId) throws OperationFailedException, PermissionDeniedException
DocetList
for the given module Id.
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.moduleId
- a module Id
Docet
listNullArgumentException
- moduleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForModuleOnDate(Id moduleId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
DocetList
for a module effective during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known docetsor an
error results. Otherwise, the returned list may contain only those
docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.moduleId
- a module Id
from
- s atsrting dateto
- an ending date Docet
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- moduleId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForActivityUnit(Id activityUnitId) throws OperationFailedException, PermissionDeniedException
DocetList
for the given activity unit
Id.
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.activityUnitId
- an activity unit Id
Docet
listNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForActivityUnitOnDate(Id activityUnitId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
DocetList
for an activity unit effective
sduring the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known docetsor an
error results. Otherwise, the returned list may contain only those
docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.activityUnitId
- an activity unit Id
from
- s atsrting dateto
- an ending date Docet
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityUnitId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForModuleAndActivityUnit(Id moduleId, Id activityUnitId) throws OperationFailedException, PermissionDeniedException
DocetList
for the given module and activity
unit .
In plenary mode, the returned list contains all known
docetsor an error results. Otherwise, the returned list may contain
only those docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.moduleId
- a module Id
activityUnitId
- an activity unit Id
Docet
listNullArgumentException
- moduleId
or
activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocetsForModuleAndActivityUnitOnDate(Id moduleId, Id activityUnitId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
DocetList
for a module and activity unit
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known docetsor an
error results. Otherwise, the returned list may contain only those
docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned.moduleId
- a module Id
activityUnitId
- an activity unit Id
from
- s atsrting dateto
- an ending date Docet
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- moduleId,
activityUnitId, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DocetList getDocets() throws OperationFailedException, PermissionDeniedException
Docets.
In plenary mode, the returned list contains all known docetsor an
error results. Otherwise, the returned list may contain only those
docets that are accessible through this session.
In effective mode, docets are returned that are currently effective.
In any effective mode, effective docets and those currently expired
are returned. Docets
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.