public interface AgendaLookupSession extends OsidSession
This session provides methods for retrieving Agenda
objects.
This session defines views that offer differing behaviors when retrieving multiple objects.
Agendas
with the AgendaAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedEngineView()
and
useIsolatedEngineView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAgendas()
Tests if this user can perform
Agenda lookups. |
Agenda |
getAgenda(Id agendaId)
Gets the
Agenda specified by its Id. |
AgendaList |
getAgendas()
Gets all
Agendas. |
AgendaList |
getAgendasByGenusType(Type agendaGenusType)
Gets an
AgendaList corresponding to the given agenda
genus Type which does not include agendas of genus
types derived from the specified Type. |
AgendaList |
getAgendasByIds(IdList agendaIds)
Gets an
AgendaList corresponding to the given
IdList. |
AgendaList |
getAgendasByParentGenusType(Type agendaGenusType)
Gets an
AgendaList corresponding to the given agenda
genus Type and include any additional agendas with
genus types derived from the specified Type. |
AgendaList |
getAgendasByRecordType(Type agendaRecordType)
Gets an
AgendaList containing the given agenda record
Type. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
void |
useComparativeAgendaView()
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 |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
void |
usePlenaryAgendaView()
A complete view of the
Agenda returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAgendas()
Agenda
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 useComparativeAgendaView()
mandatory
- This method is must be implemented. void usePlenaryAgendaView()
Agenda
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 useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. Agenda getAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Agenda
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Agenda
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Agenda
and retained for compatibility.agendaId
- Id
of the Agenda
NotFoundException
- agendaId
not foundNullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AgendaList getAgendasByIds(IdList agendaIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AgendaList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
agendas 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 Agendas
may be omitted from the list and
may present the elements in any order including returning a unique
set.agendaIds
- the list of Ids
to retrieve Agenda
listNotFoundException
- an Id was
not foundNullArgumentException
- agendaIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AgendaList getAgendasByGenusType(Type agendaGenusType) throws OperationFailedException, PermissionDeniedException
AgendaList
corresponding to the given agenda
genus Type
which does not include agendas of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known agendas or an error results.
Otherwise, the returned list may contain only those agendas that are
accessible through this session.agendaGenusType
- an agenda genus type Agenda
listNullArgumentException
- agendaGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AgendaList getAgendasByParentGenusType(Type agendaGenusType) throws OperationFailedException, PermissionDeniedException
AgendaList
corresponding to the given agenda
genus Type
and include any additional agendas with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known agendas or an error
results. Otherwise, the returned list may contain only those agendas
that are accessible through this session.agendaGenusType
- an agenda genus type Agenda
listNullArgumentException
- agendaGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AgendaList getAgendasByRecordType(Type agendaRecordType) throws OperationFailedException, PermissionDeniedException
AgendaList
containing the given agenda record
Type.
In plenary mode, the returned list contains all
known agendas or an error results. Otherwise, the returned list may
contain only those agendas that are accessible through this session.agendaRecordType
- an agenda record type Agenda
listNullArgumentException
- agendaRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AgendaList getAgendas() throws OperationFailedException, PermissionDeniedException
Agendas.
In plenary mode, the returned list
contains all known agendas or an error results. Otherwise, the
returned list may contain only those agendas that are accessible
through this session. Agendas
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.