public interface GradebookColumnCalculationLookupSession extends OsidSession
This session provides methods for retrieving
GradebookColumnCalculationss
.
This session defines views that offer differing behaviors when retrieving multiple objects.
Gradebook column calculations may have an additional records indicated
by their respective record types. The record may not be accessed through a
cast of the GradebookColumnCalculation.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupGradebookColumnCalculations()
Tests if this user can perform
GradebookColumnCalculation
lookups. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
GradebookColumnCalculation |
getGradebookColumnCalculation(Id gradebookColumnCalculationId)
Gets the
GradebookColumnCalculation specified by its
Id. |
GradebookColumnCalculation |
getGradebookColumnCalculationForGradebookColumn(Id gradebookColumnId)
Gets the
GradebookColumnCalculation mapped to a
GradebookColumn to which this calculation is applied. |
GradebookColumnCalculationList |
getGradebookColumnCalculations()
Gets all gradebook column calculations.
|
GradebookColumnCalculationList |
getGradebookColumnCalculationsByGenusType(Type gradebookColumnCalculationGenusType)
Gets a
GradebookColumnCalculationList corresponding to
the given gradebook column calculation genus Type which
does not include gradebook column calculations of genus types derived
from the specified Type. |
GradebookColumnCalculationList |
getGradebookColumnCalculationsByIds(IdList gradebookColumnCalculationIds)
Gets a
GradebookColumnCalculationList corresponding to
the given IdList. |
GradebookColumnCalculationList |
getGradebookColumnCalculationsByParentGenusType(Type gradebookColumnCalculationGenusType)
Gets a
GradebookColumnCalculationList corresponding to
the given gradebook column calculation genus Type and
include any additional column calculations with genus types derived
from the specified Type. |
GradebookColumnCalculationList |
getGradebookColumnCalculationsByRecordType(Type gradebookColumnCalculationRecordType)
Gets a
GradebookColumnCalculationList containing the
given gradebook column calculation record Type. |
GradebookColumnCalculationList |
getGradebookColumnCalculationsForGradebookColumns(IdList gradebookColumnIds)
Gets a
GradebookColumnCalculationList corresponding to
the given gradebook column Ids to which this
calculation is applied. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
void |
useActiveGradebookColumnCalculationView()
Only active gradebook column calculations are returned by methods in
this session.
|
void |
useAnyStatusGradebookColumnCalculationView()
All active and inactive gradebook column calculations are returned by
methods in this session.
|
void |
useComparativeGradebookColumnCalculationView()
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 |
useFederatedGradebookView()
Federates the view for methods in this session.
|
void |
useIsolatedGradebookView()
Isolates the view for methods in this session.
|
void |
usePlenaryGradebookColumnCalculationView()
A complete view of the
GradebookColumnCalculation
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGradebookId()
Gradebook
Id
associated with
this session. Gradebook Id
associated with this sessionmandatory
- This method must be implemented. Gradebook getGradebook() throws OperationFailedException, PermissionDeniedException
Gradebook
associated with this session. Gradebook
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupGradebookColumnCalculations()
GradebookColumnCalculation
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 useComparativeGradebookColumnCalculationView()
mandatory
- This method is must be implemented. void usePlenaryGradebookColumnCalculationView()
GradebookColumnCalculation
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 useFederatedGradebookView()
mandatory
- This method is must be implemented. void useIsolatedGradebookView()
mandatory
- This method is must be implemented. void useActiveGradebookColumnCalculationView()
mandatory
- This method is must be implemented. void useAnyStatusGradebookColumnCalculationView()
mandatory
- This method is must be implemented. GradebookColumnCalculation getGradebookColumnCalculation(Id gradebookColumnCalculationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradebookColumnCalculation
specified by its
Id.
In plenary mode, the exact Id
is
found or a NOT_FOUND
results. Otherwise, the returned
GradebookColumnCalculation
may have a different
Id
than requested, such as the case where a duplicate
Id
was assigned to a GradebookColumnCalculation
and retained for compatibility.gradebookColumnCalculationId
- Id
of the
GradebookColumnCalculation
NotFoundException
- gradebookColumnCalculationId
not foundNullArgumentException
-
gradebookColumnCalculationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradebookColumnCalculationList getGradebookColumnCalculationsByIds(IdList gradebookColumnCalculationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
corresponding to
the given IdList.
In plenary mode, the returned list
contains all of the gradebook column calculations specified in the
Id
list, in the order of the list, including
duplicates, or an error results if a Id
in the supplied
list is not found or inaccessible. Otherwise, inaccessible gradeboook
column calculations may be omitted from the list.gradebookColumnCalculationIds
- the list of Ids
to retrieve GradebookColumnCalculation
listNotFoundException
- an Id
was not foundNullArgumentException
-
gradeBookColumnCalculationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnCalculationList getGradebookColumnCalculationsByGenusType(Type gradebookColumnCalculationGenusType) throws OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
corresponding to
the given gradebook column calculation genus Type
which
does not include gradebook column calculations of genus types derived
from the specified Type.
In plenary mode, the returned
list contains all known gradebook column calculations or an error
results. Otherwise, the returned list may contain only those gradebook
column calculations that are accessible through this session.gradebookColumnCalculationGenusType
- a gradebook column
calculation genus type GradebookColumnCalculation
listNullArgumentException
-
gradebookColumnCalculationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnCalculationList getGradebookColumnCalculationsByParentGenusType(Type gradebookColumnCalculationGenusType) throws OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
corresponding to
the given gradebook column calculation genus Type
and
include any additional column calculations with genus types derived
from the specified Type.
In plenary mode, the returned
list contains all known gradebook column calculations or an error
results. Otherwise, the returned list may contain only those gradebook
column calculations that are accessible through this session.gradebookColumnCalculationGenusType
- a gradebook column
calculation genus type GradebookColumnCalculation
listNullArgumentException
-
gradebookColumnCalculationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnCalculationList getGradebookColumnCalculationsByRecordType(Type gradebookColumnCalculationRecordType) throws OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
containing the
given gradebook column calculation record Type.
In
plenary mode, the returned list contains all known gradebook column
calculations or an error results. Otherwise, the returned list may
contain only those gradebook column calculations that are accessible
through this session.gradebookColumnCalculationRecordType
- a gradebook column
calculation record type GradebookColumnCalculation
listNullArgumentException
-
gradebookColumnCalculationRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnCalculation getGradebookColumnCalculationForGradebookColumn(Id gradebookColumnId) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradebookColumnCalculation
mapped to a
GradebookColumn
to which this calculation is applied. In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
GradebookColumnCalculation
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a GradebookColumnCalculation
and retained for compatibility.gradebookColumnId
- Id
of a
GradebookColumn
NotFoundException
- gradebookColumnId
not foundNullArgumentException
- gradebookColumnId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. GradebookColumnCalculationList getGradebookColumnCalculationsForGradebookColumns(IdList gradebookColumnIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
corresponding to
the given gradebook column Ids
to which this
calculation is applied. In plenary mode, the returned list contains
all of the gradebook column calculations specified in the Id
list, in the order of the list, including duplicates, or an
error results if a Id
in the supplied list is not found
or inaccessible. Otherwise, inaccessible gradeboook column
calculations may be omitted from the list.gradebookColumnIds
- a list of gradebook column Ids
GradebookColumnCalculation
listNotFoundException
- an Id
was not foundNullArgumentException
- gradeBookColumnIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GradebookColumnCalculationList getGradebookColumnCalculations() throws OperationFailedException, PermissionDeniedException
GradebookColumnCalculationList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.