public interface GradebookLookupSession extends OsidSession
This session provides methods for retrieving Gradebook
objects. The Gradebook
represents a collection of grade
systems, entries, and gradebook columns.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
Gradebooks
it can access, without breaking execution. However, an
administrative application may require all Gradebook
elements to be available.
Gradebooks may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Gradebook.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGradebooks()
Tests if this user can perform
Gradebook lookups. |
Gradebook |
getGradebook(Id gradebookId)
Gets the
Gradebook specified by its Id. |
GradebookList |
getGradebooks()
Gets all
Gradebooks. |
GradebookList |
getGradebooksByGenusType(Type gradebookGenusType)
Gets a
GradebookList corresponding to the given
gradebook genus Type which does not include gradebooks
of types derived from the specified Type. |
GradebookList |
getGradebooksByIds(IdList gradebookIds)
Gets a
GradebookList corresponding to the given
IdList. |
GradebookList |
getGradebooksByParentGenusType(Type gradebookGenusType)
Gets a
GradebookList corresponding to the given
gradebook genus Type and include any additional
gradebooks with genus types derived from the specified Type. |
GradebookList |
getGradebooksByProvider(Id resourceId)
Gets a
GradebookList for the given provider . |
GradebookList |
getGradebooksByRecordType(Type gradebookRecordType)
Gets a
GradebookList containing the given gradebook
record Type. |
void |
useComparativeGradebookView()
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 |
usePlenaryGradebookView()
A complete view of the
Gradebook returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupGradebooks()
Gradebook
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeGradebookView()
mandatory
- This method is must be implemented. void usePlenaryGradebookView()
Gradebook
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. Gradebook getGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Gradebook
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Gradebook
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Gradebook
and retained for compatility.gradebookId
- Id
of the Gradebook
NotFoundException
- gradebookId
not
foundNullArgumentException
- gradebookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradebookList getGradebooksByIds(IdList gradebookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradebookList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
gradebooks 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 Gradebook
objects may be omitted from the
list and may present the elements in any order including returning a
unique set.gradebookIds
- the list of Ids
to retrieve Gradebook
listNotFoundException
- an Id was
not foundNullArgumentException
- gradebookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooksByGenusType(Type gradebookGenusType) throws OperationFailedException, PermissionDeniedException
GradebookList
corresponding to the given
gradebook genus Type
which does not include gradebooks
of types derived from the specified Type.
In plenary
mode, the returned list contains all known gradebooks or an error
results. Otherwise, the returned list may contain only those
gradebooks that are accessible through this session.gradebookGenusType
- a gradebook genus type Gradebook
listNullArgumentException
- gradebookGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooksByParentGenusType(Type gradebookGenusType) throws OperationFailedException, PermissionDeniedException
GradebookList
corresponding to the given
gradebook genus Type
and include any additional
gradebooks with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
gradebooks or an error results. Otherwise, the returned list may
contain only those gradebooks that are accessible through this
session.gradebookGenusType
- a gradebook genus type Gradebook
listNullArgumentException
- gradebookGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooksByRecordType(Type gradebookRecordType) throws OperationFailedException, PermissionDeniedException
GradebookList
containing the given gradebook
record Type.
In plenary mode, the returned list
contains all known gradebooks or an error results. Otherwise, the
returned list may contain only those gradebooks that are accessible
through this session.gradebookRecordType
- a gradebook record type Gradebook
listNullArgumentException
- gradebookRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
GradebookList
for the given provider .
In plenary mode, the returned list contains all known
gradebooks or an error results. Otherwise, the returned list may
contain only those gradebooks that are accessible through this
session.resourceId
- a resource Id
Gradebook
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookList getGradebooks() throws OperationFailedException, PermissionDeniedException
Gradebooks.
In plenary mode, the returned list
contains all known gradebooks or an error results. Otherwise, the
returned list may contain only those gradebooks that are accessible
through this session. GradebookList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.