public interface CanonicalUnitProcessorCatalogueSession extends OsidSession
This session provides methods to retrieve CanonicalUnitProcessor
to Catalogue
mappings. A
CanonicalUnitProcessor
may appear in multiple Catalogue
objects. 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 |
canLookupCanonicalUnitProcessorCatalogueMappings()
Tests if this user can perform lookups of canonical unit
processor/catalogue mappings.
|
IdList |
getCanonicalUnitProcessorIdsByCatalogue(Id catalogueId)
Gets the list of
CanonicalUnitProcessorIds associated
with a Catalogue. |
IdList |
getCanonicalUnitProcessorIdsByCatalogues(IdList catalogueIds)
Gets the list of
CanonicalUnitProcessor Ids
corresponding to a list of Catalogues. |
CanonicalUnitProcessorList |
getCanonicalUnitProcessorsByCatalogue(Id catalogueId)
Gets the list of canonical unit processors associated with a
Catalogue. |
CanonicalUnitProcessorList |
getCanonicalUnitProcessorsByCatalogues(IdList catalogueIds)
Gets the list of canonical unit processor corresponding to a list of
Catalogues. |
IdList |
getCatalogueIdsByCanonicalUnitProcessor(Id canonicalUnitProcessorId)
Gets the
Catalogue Ids mapped to a
CanonicalUnitProcessor. |
CatalogueList |
getCataloguesByCanonicalUnitProcessor(Id canonicalUnitProcessorId)
Gets the
Catalogues mapped to a
CanonicalUnitProcessor. |
void |
useComparativeCanonicalUnitProcessorCatalogueView()
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 |
usePlenaryCanonicalUnitProcessorCatalogueView()
A complete view of the
CanonicalUnitProcessor and
Catalogue returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCanonicalUnitProcessorCatalogueMappings()
PERMISSION_DENIED.
This is intended as 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 useComparativeCanonicalUnitProcessorCatalogueView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitProcessorCatalogueView()
CanonicalUnitProcessor
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 getCanonicalUnitProcessorIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorIds
associated
with a Catalogue.
catalogueId
- Id
of the Catalogue
Ids
NotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorList getCanonicalUnitProcessorsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue.
catalogueId
- Id
of the Catalogue
NotFoundException
- catalogueId
is not
foundNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCanonicalUnitProcessorIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor Ids
corresponding to a list of Catalogues.
catalogueIds
- list of catalogue Ids
Ids
NullArgumentException
- catalogueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitProcessorList getCanonicalUnitProcessorsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
Catalogues.
catalogueIds
- list of catalogue Ids
NullArgumentException
- catalogueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCatalogueIdsByCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
Ids
mapped to a
CanonicalUnitProcessor.
canonicalUnitProcessorId
- Id
of a
CanonicalUnitProcessor
NotFoundException
- canonicalUnitProcessorId
is not foundNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogueList getCataloguesByCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogues
mapped to a
CanonicalUnitProcessor.
canonicalUnitProcessorId
- Id
of a
CanonicalUnitProcessor
NotFoundException
- canonicalUnitProcessorId
is not foundNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.