public interface ConferralLookupSession extends OsidSession
This session defines methods for retrieving conferrals.
This lookup session defines several views:
ConferralAdminSession.
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 |
canLookupConferrals()
Tests if this user can lookup conferrals.
|
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
Conferral |
getConferral(Id conferralId)
Gets the
Conferral specified by its Id. |
ConferralList |
getConferrals()
Gets all conferrals.
|
ConferralList |
getConferralsByConvocation(Id convocationId)
Gets a list of all conferrals corresponding to a convocation
Id. |
ConferralList |
getConferralsByConvocationOnDate(Id convocationId,
DateTime from,
DateTime to)
Gets a list of all conferrals corresponding to a convocation
Id
and effective during the entire given date range inclusive but
not confined to the date range. |
ConferralList |
getConferralsByGenusType(Type conferralGenusType)
Gets a
ConferralList corresponding to the given
conferral genus Type which does not include conferrals
of genus types derived from the specified Type. |
ConferralList |
getConferralsByIds(IdList conferralIds)
Gets a
ConferralList corresponding to the given
IdList. |
ConferralList |
getConferralsByParentGenusType(Type conferralGenusType)
Gets a
ConferralList corresponding to the given
conferral genus Type and include any additional
conferrals with genus types derived from the specified Type. |
ConferralList |
getConferralsByRecordType(Type conferralRecordType)
Gets a
ConferralList containing the given conferral
record Type. |
ConferralList |
getConferralsByReference(Id referenceId)
Gets a list of conferrals corresponding to a reference
Id. |
ConferralList |
getConferralsByReferenceOnDate(Id referenceId,
DateTime from,
DateTime to)
Gets a list of all conferrals corresponding to a reference
Id
and effective during the entire given date range inclusive but
not confined to the date range. |
ConferralList |
getConferralsForAward(Id awardId)
Gets a list of all conferrals corresponding to an award
Id. |
ConferralList |
getConferralsForAwardOnDate(Id awardId,
DateTime from,
DateTime to)
Gets a list of all conferrals corresponding to an award
Id
and effective during the entire given date range inclusive but
not confined to the date range. |
ConferralList |
getConferralsForRecipient(Id resourceId)
Gets a list of conferrals corresponding to a resource
Id. |
ConferralList |
getConferralsForRecipientAndAward(Id resourceId,
Id awardid)
Gets a list of conferralsfor the given resource and award.
|
ConferralList |
getConferralsForRecipientAndAwardOnDate(Id resourceId,
Id awardid,
DateTime from,
DateTime to)
Gets a list of all conferrals for the given resource, award,
and effective during the entire given date range inclusive but
not confined to the date range. |
ConferralList |
getConferralsForRecipientOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of all conferrals corresponding to a resource
Id
and effective during the entire given date range inclusive but
not confined to the date range. |
ConferralList |
getConferralsOnDate(DateTime from,
DateTime to)
Gets a list of conferrals effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveConferralView()
All conferrals of any effective dates are returned by all methods in
this session.
|
void |
useComparativeConferralView()
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 |
useEffectiveConferralView()
Only conferrals whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedAcademyView()
Federates the view for methods in this session.
|
void |
useIsolatedAcademyView()
Isolates the view for methods in this session.
|
void |
usePlenaryConferralView()
A complete view of the
Conferral 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 canLookupConferrals()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if conferral lookup methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeConferralView()
mandatory
- This method is must be implemented. void usePlenaryConferralView()
Conferral
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 useEffectiveConferralView()
mandatory
- This method is must be implemented. void useAnyEffectiveConferralView()
mandatory
- This method is must be implemented. Conferral getConferral(Id conferralId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Conferral
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Conferral
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Conferral
and retained for compatibility.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.conferralId
- the Id
of the Conferral
to retrieve Conferral
NotFoundException
- no Conferral
found
with the given Id
NullArgumentException
- conferralId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByIds(IdList conferralIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConferralList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
conferrals 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 conferrals may be omitted from the list and may present
the elements in any order including returning a unique set.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.conferralIds
- the list of Ids
to retrieve Conferral list
NotFoundException
- an Id was
not foundNullArgumentException
- conferralIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByGenusType(Type conferralGenusType) throws OperationFailedException, PermissionDeniedException
ConferralList
corresponding to the given
conferral genus Type
which does not include conferrals
of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
conferrals or an error results. Otherwise, the returned list may
contain only those conferrals that are accessible through this
session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.conferralGenusType
- a conferral genus type Conferral
listNullArgumentException
- conferralGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByParentGenusType(Type conferralGenusType) throws OperationFailedException, PermissionDeniedException
ConferralList
corresponding to the given
conferral genus Type
and include any additional
conferrals with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
conferrals or an error results. Otherwise, the returned list may
contain only those conferrals that are accessible through this
session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.conferralGenusType
- a conferral genus type Conferral
listNullArgumentException
- conferralGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByRecordType(Type conferralRecordType) throws OperationFailedException, PermissionDeniedException
ConferralList
containing the given conferral
record Type.
In plenary mode, the returned list contains all known
conferrals or an error results. Otherwise, the returned list may
contain only those conferrals that are accessible through this
session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.conferralRecordType
- a conferral record type Conferral
listNullArgumentException
- conferralRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- the starting dateto
- the ending date ConferralList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.resourceId
- the Id
of the resource ConferralList
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForRecipientOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.resourceId
- a resource Id
from
- from dateto
- to date ConferralList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.awardId
- the Id
of the award ConferralList
NullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForAwardOnDate(Id awardId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.awardId
- an award Id
from
- from dateto
- to date ConferralList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- awardId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForRecipientAndAward(Id resourceId, Id awardid) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of the resourceawardid
- the Id of the award ConferralList
NullArgumentException
- resourceId
or
awardId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsForRecipientAndAwardOnDate(Id resourceId, Id awardid, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.resourceId
- a resource Id
awardid
- an award Id
from
- from dateto
- to date ConferralList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- resourceId, awardid,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByReference(Id referenceId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.referenceId
- the Id
of the reference ConferralList
NullArgumentException
- referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByReferenceOnDate(Id referenceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.referenceId
- a reference Id
from
- from dateto
- to date ConferralList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- referenceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.convocationId
- the Id
of the convocation ConferralList
NullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferralsByConvocationOnDate(Id convocationId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
Id
and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known conferrals or an
error results. Otherwise, the returned list may contain only those
conferrals that are accessible through this session.
In effective mode, conferrals are returned that are currently
effective. In any effective mode, effective conferrals and those
currently expired are returned.convocationId
- a convocation Id
from
- from dateto
- to date ConferralList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- convocationId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConferralList getConferrals() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.