public interface ConvocationLookupSession extends OsidSession
This session defines methods for retrieving convocations.
This lookup session defines several views:
ConvocationAdminSession.
The methods useFederatedAcademyView()
and
useIsolatedAcademyView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupConvocations()
Tests if this user can lookup convocations.
|
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
Convocation |
getConvocation(Id convocationId)
Gets the
Convocation specified by its Id. |
ConvocationList |
getConvocations()
Gets all convocations.
|
ConvocationList |
getConvocationsByAward(Id awardId)
Gets a list of all convocations corresponding to an award
Id. |
ConvocationList |
getConvocationsByDate(DateTime from,
DateTime to)
Gets a list of convocations with a date within the given date range
inclusive.
|
ConvocationList |
getConvocationsByGenusType(Type convocationGenusType)
Gets a
ConvocationList corresponding to the given
convocation genus Type which does not include
convocations of genus types derived from the specified Type. |
ConvocationList |
getConvocationsByIds(IdList convocationIds)
Gets a
ConvocationList corresponding to the given
IdList. |
ConvocationList |
getConvocationsByParentGenusType(Type convocationGenusType)
Gets a
ConvocationList corresponding to the given
convocation genus Type and include any additional
convocations with genus types derived from the specified Type. |
ConvocationList |
getConvocationsByProvider(Id resourceId)
Gets a list of all convocations for a given provider.
|
ConvocationList |
getConvocationsByRecordType(Type convocationRecordType)
Gets a
ConvocationList containing the given convocation
record Type. |
ConvocationList |
getConvocationsByTimePeriod(Id timePeriodId)
Gets a list of all convocations corresponding to a time period
Id. |
void |
useActiveConvocationView()
Only active convocations are returned by methods in this session.
|
void |
useAnyStatusConvocationView()
All convocations of any status are returned by all methods in this
session.
|
void |
useComparativeConvocationView()
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 |
useFederatedAcademyView()
Federates the view for methods in this session.
|
void |
useIsolatedAcademyView()
Isolates the view for methods in this session.
|
void |
usePlenaryConvocationView()
A complete view of the
Convocation returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAcademyId()
Academy
Id
associated with this
session. Academy Id
associated with this sessionmandatory
- This method must be implemented. Academy getAcademy() throws OperationFailedException, PermissionDeniedException
Academy
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupConvocations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if convocation lookup methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeConvocationView()
mandatory
- This method is must be implemented. void usePlenaryConvocationView()
Convocation
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 useFederatedAcademyView()
mandatory
- This method is must be implemented. void useIsolatedAcademyView()
mandatory
- This method is must be implemented. void useActiveConvocationView()
mandatory
- This method is must be implemented. void useAnyStatusConvocationView()
mandatory
- This method is must be implemented. Convocation getConvocation(Id convocationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Convocation
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
Convocation
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Convocation
and retained for
compatibility.convocationId
- the Id
of the Convocation
to retrieve Convocation
NotFoundException
- no Convocation
found
with the given Id
NullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByIds(IdList convocationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConvocationList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the convocations 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 convocations may be omitted from the list and
may present the elements in any order including returning a unique
set.convocationIds
- the list of Ids
to retrieve Convocation list
NotFoundException
- an Id was
not foundNullArgumentException
- convocationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByGenusType(Type convocationGenusType) throws OperationFailedException, PermissionDeniedException
ConvocationList
corresponding to the given
convocation genus Type
which does not include
convocations of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
convocations or an error results. Otherwise, the returned list may
contain only those convocations that are accessible through this
session.convocationGenusType
- a convocation genus type Convocation
listNullArgumentException
- convocationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByParentGenusType(Type convocationGenusType) throws OperationFailedException, PermissionDeniedException
ConvocationList
corresponding to the given
convocation genus Type
and include any additional
convocations with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
convocations or an error results. Otherwise, the returned list may
contain only those convocations that are accessible through this
session.convocationGenusType
- a convocation genus type Convocation
listNullArgumentException
- convocationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByRecordType(Type convocationRecordType) throws OperationFailedException, PermissionDeniedException
ConvocationList
containing the given convocation
record Type.
In plenary mode, the returned list
contains all known convocations or an error results. Otherwise, the
returned list may contain only those convocations that are accessible
through this session.convocationRecordType
- a convocation record type Convocation
listNullArgumentException
- convocationRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- the starting dateto
- the ending date ConvocationList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByAward(Id awardId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known
convocations or an error results. Otherwise, the returned list may
contain only those convocations that are accessible through this
session.awardId
- the Id
of the award ConvocationList
NullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known
convocations or an error results. Otherwise, the returned list may
contain only those convocations that are accessible through this
session.timePeriodId
- the Id
of the time period ConvocationList
NullArgumentException
- timePeriod
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocationsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of the resource ConvocationList
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConvocationList getConvocations() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.