public interface AcademyLookupSession extends OsidSession
This session provides methods for retrieving Academy
objects. The Academy
represents a collection of conferrals,
awards, and convocations.
This session defines views that offer differing behaviors when retrieving multiple objects.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAcademies()
Tests if this user can perform
Academy lookups. |
AcademyList |
getAcademies()
Gets all
Academies. |
AcademyList |
getAcademiesByGenusType(Type academyGenusType)
Gets an
AcademyList corresponding to the given academy
genus Type which does not include academies of genus
types derived from the specified Type. |
AcademyList |
getAcademiesByIds(IdList academyIds)
Gets an
AcademyList corresponding to the given
IdList. |
AcademyList |
getAcademiesByParentGenusType(Type academyGenusType)
Gets an
AcademyList corresponding to the given academy
genus Type and include any additional academies with
genus types derived from the specified Type. |
AcademyList |
getAcademiesByProvider(Id resourceId)
Gets an
AcademyList by the given provdier . |
AcademyList |
getAcademiesByRecordType(Type academyRecordType)
Gets an
AcademyList containing the given academy record
Type. |
Academy |
getAcademy(Id jouralId)
Gets the
Academy specified by its Id. |
void |
useComparativeAcademyView()
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 |
usePlenaryAcademyView()
A complete view of the
Academy returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAcademies()
Academy
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAcademyView()
mandatory
- This method is must be implemented. void usePlenaryAcademyView()
Academy
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. Academy getAcademy(Id jouralId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Academy
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Academy
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Academy
and retained for compatibility.jouralId
- Id
of the Academy
NotFoundException
- academyId
not foundNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AcademyList getAcademiesByIds(IdList academyIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AcademyList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
academies 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 Academies
may be omitted from the list and
may present the elements in any order including returning a unique
set.academyIds
- the list of Ids
to retrieve Academy
listNotFoundException
- an Id was
not foundNullArgumentException
- academyIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByGenusType(Type academyGenusType) throws OperationFailedException, PermissionDeniedException
AcademyList
corresponding to the given academy
genus Type
which does not include academies of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known academies or an error results.
Otherwise, the returned list may contain only those academies that are
accessible through this session.academyGenusType
- an academy genus type Academy
listNullArgumentException
- academyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByParentGenusType(Type academyGenusType) throws OperationFailedException, PermissionDeniedException
AcademyList
corresponding to the given academy
genus Type
and include any additional academies with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known academies or an error
results. Otherwise, the returned list may contain only those academies
that are accessible through this session.academyGenusType
- an academy genus type Academy
listNullArgumentException
- academyGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByRecordType(Type academyRecordType) throws OperationFailedException, PermissionDeniedException
AcademyList
containing the given academy record
Type.
In plenary mode, the returned list contains all
known academies or an error results. Otherwise, the returned list may
contain only those academies that are accessible through this session.academyRecordType
- an academy record type Academy
listNullArgumentException
- academyRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademiesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
AcademyList
by the given provdier .
In plenary mode, the returned list contains all known
academies or an error results. Otherwise, the returned list may
contain only those academies that are accessible through this session.resourceId
- a resource Id
Academy
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AcademyList getAcademies() throws OperationFailedException, PermissionDeniedException
Academies.
In plenary mode, the returned list
contains all known academies or an error results. Otherwise, the
returned list may contain only those academies that are accessible
through this session. Academies
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.