public interface ObjectiveBankLookupSession extends OsidSession
This session provides methods for retrieving ObjectiveBank
objects. The ObjectiveBank
represents a collection
of Objectives Activities
, and Proficiencies.
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
ObjectiveBanks
it can access, without breaking execution. However,
an administrative application may require all ObjectiveBank
elements to be available.
ObjectiveBanks
may have an additional records indicated
by their respective record types. The record may not be accessed through a
cast of the ObjectiveBank.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupObjectiveBanks()
Tests if this user can perform
ObjectiveBank lookups. |
ObjectiveBank |
getObjectiveBank(Id objectiveBankId)
Gets the
ObjectiveBank specified by its Id. |
ObjectiveBankList |
getObjectiveBanks()
Gets all
ObjectiveBanks. |
ObjectiveBankList |
getObjectiveBanksByGenusType(Type objectiveBankGenusType)
Gets a
ObjectiveBankList corresponding to the given
objective bank genus Type which does not include
objective banks of types derived from the specified Type. |
ObjectiveBankList |
getObjectiveBanksByIds(IdList objectiveBankIds)
Gets a
ObjectiveBankList corresponding to the given
IdList. |
ObjectiveBankList |
getObjectiveBanksByParentGenusType(Type objectiveBankGenusType)
Gets a
ObjectiveBankList corresponding to the given
objective bank genus Type and include any additional
objective banks with genus types derived from the specified
Type. |
ObjectiveBankList |
getObjectiveBanksByProvider(Id resourceId)
Gets a
ObjectiveBankList for the given provider. |
ObjectiveBankList |
getObjectiveBanksByRecordType(Type objectiveBankRecordType)
Gets a
ObjectiveBankList containing the given objective
bank record Type. |
void |
useComparativeObjectiveBankView()
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 |
usePlenaryObjectiveBankView()
A complete view of the
ObjectiveBank returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupObjectiveBanks()
ObjectiveBank
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 useComparativeObjectiveBankView()
mandatory
- This method is must be implemented. void usePlenaryObjectiveBankView()
ObjectiveBank
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. ObjectiveBank getObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBank
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
ObjectiveBank
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ObjectiveBank
and retained for
compatility.objectiveBankId
- Id
of the ObjectiveBank
NotFoundException
- objectiveBankId
not
foundNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ObjectiveBankList getObjectiveBanksByIds(IdList objectiveBankIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObjectiveBankList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the objective banks 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 ObjectiveBank
objects may be
omitted from the list and may present the elements in any order
including returning a unique set.objectiveBankIds
- the list of Ids
to retrieve ObjectiveBank
listNotFoundException
- an Id was
not foundNullArgumentException
- objectiveBankIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByGenusType(Type objectiveBankGenusType) throws OperationFailedException, PermissionDeniedException
ObjectiveBankList
corresponding to the given
objective bank genus Type
which does not include
objective banks of types derived from the specified Type.
In plenary mode, the returned list contains all known
objective banks or an error results. Otherwise, the returned list may
contain only those objective banks that are accessible through this
session.objectiveBankGenusType
- an objective bank genus type ObjectiveBank
listNullArgumentException
- objectiveBankGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByParentGenusType(Type objectiveBankGenusType) throws OperationFailedException, PermissionDeniedException
ObjectiveBankList
corresponding to the given
objective bank genus Type
and include any additional
objective banks with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
objective banks or an error results. Otherwise, the returned list may
contain only those objective banks that are accessible through this
session.objectiveBankGenusType
- an objective bank genus type ObjectiveBank
listNullArgumentException
- objectiveBankGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByRecordType(Type objectiveBankRecordType) throws OperationFailedException, PermissionDeniedException
ObjectiveBankList
containing the given objective
bank record Type.
In plenary mode, the returned list
contains all known objective banks or an error results. Otherwise, the
returned list may contain only those objective banks that are
accessible through this session.objectiveBankRecordType
- an objective bank record type ObjectiveBank
listNullArgumentException
- objectiveBankRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankList
for the given provider.
In plenary mode, the returned list contains all known
objective banks or an error results. Otherwise, the returned list may
contain only those objective banks that are accessible through this
session.resourceId
- a resource Id
ObjectiveBank
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObjectiveBankList getObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBanks.
In plenary mode, the returned
list contains all known objective banks or an error results.
Otherwise, the returned list may contain only those objective banks
that are accessible through this session. ObjectiveBankList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.