public interface ResultCatalogueSession extends OsidSession
This session provides methods to retrieve Result
to
Catalogue
mappings. An Result
may appear in
multiple Catalogues.
Each Catalogue
may have
its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupResultCatalogueMappings()
Tests if this user can perform lookups of result/catalogue mappings.
|
IdList |
getCatalogueIdsByResult(Id resultId)
Gets the list of
Catalogue Ids mapped to
an Result. |
CatalogueList |
getCataloguesByResult(Id resultId)
Gets the list of
Catalogue objects mapped to an
Result. |
IdList |
getResultIdsByCatalogue(Id catalogueId)
Gets the list of Result Ids associated with a
Catalogue. |
IdList |
getResultIdsByCatalogues(IdList catalogueIds)
Gets the list of
Result Ids corresponding to a list of
Catalogue objects. |
ResultList |
getResultsByCatalogue(Id catalogueId)
Gets the list of
Results associated with a
Catalogue. |
ResultList |
getResultsByCatalogues(IdList catalogueIds)
Gets the list of
Results corresponding to a list of
Catalogues. |
void |
useComparativeCatalogueView()
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 |
usePlenaryCatalogueView()
A complete view of the
Result and Catalogue
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupResultCatalogueMappings()
PERMISSION_DENIED.
This is intendedas
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCatalogueView()
mandatory
- This method is must be implemented. void usePlenaryCatalogueView()
Result
and Catalogue
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. IdList getResultIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue.
catalogueId
- Id
of a Catalogues.
Ids
NotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResultList getResultsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Results
associated with a
Catalogue.
catalogueId
- Id
of a Catalogue
NotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getResultIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
Result Ids
corresponding to a list of
Catalogue
objects.catalogueIds
- list of catalogue Ids
Ids
NullArgumentException
- catalogueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResultList getResultsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
Results
corresponding to a list of
Catalogues.
catalogueIds
- list of catalogue Ids
NullArgumentException
- catalogueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCatalogueIdsByResult(Id resultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
Ids
mapped to
an Result.
resultId
- Id
of an Result
Ids
NotFoundException
- resultId
is not
foundNullArgumentException
- resultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogueList getCataloguesByResult(Id resultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
objects mapped to an
Result.
resultId
- Id
of an Result
NotFoundException
- resultId
is not
foundNullArgumentException
- resultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.