public interface CanonicalUnitProcessorEnablerCatalogueSession extends OsidSession
This session provides methods to retrieve
CanonicalUnitProcessorEnabler
to Catalogue
mappings. A CanonicalUnitProcessorEnabler
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 |
canLookupCanonicalUnitProcessorEnablerCatalogueMappings()
Tests if this user can perform lookups of canonical unit processor
enabler/catalogue mappings.
|
IdList |
getCanonicalUnitProcessorEnablerIdsByCatalogue(Id catalogueId)
Gets the list of
CanonicalUnitProcessorEnablerIds
associated with a Catalogue. |
IdList |
getCanonicalUnitProcessorEnablerIdsByCatalogues(IdList catalogueIds)
Gets the list of
CanonicalUnitProcessorEnabler Ids
corresponding to a list of Catalogues. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByCatalogue(Id catalogueId)
Gets the list of canonical unit processor enablers associated with a
Catalogue. |
CanonicalUnitProcessorEnablerList |
getCanonicalUnitProcessorEnablersByCatalogues(IdList catalogueIds)
Gets the list of canonical unit processor enablers corresponding to a
list of
Catalogues. |
IdList |
getCatalogueIdsByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Gets the
Catalogue Ids mapped to a
CanonicalUnitProcessorEnabler. |
CatalogueList |
getCataloguesByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Gets the
Catalogues mapped to a
CanonicalUnitProcessorEnabler. |
void |
useComparativeCanonicalUnitProcessorEnablerCatalogueView()
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 |
usePlenaryCanonicalUnitProcessorEnablerCatalogueView()
A complete view of the
CanonicalUnitProcessorEnabler
and Catalogue returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCanonicalUnitProcessorEnablerCatalogueMappings()
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 useComparativeCanonicalUnitProcessorEnablerCatalogueView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitProcessorEnablerCatalogueView()
CanonicalUnitProcessorEnabler
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 getCanonicalUnitProcessorEnablerIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnablerIds
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. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByCatalogue(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 getCanonicalUnitProcessorEnablerIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler 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. CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByCatalogues(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 getCatalogueIdsByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
Ids
mapped to a
CanonicalUnitProcessorEnabler.
canonicalUnitProcessorEnablerId
- Id
of a
CanonicalUnitProcessorEnabler
NotFoundException
-
canonicalUnitProcessorEnablerId
is not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogueList getCataloguesByCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogues
mapped to a
CanonicalUnitProcessorEnabler.
canonicalUnitProcessorEnablerId
- Id
of a
CanonicalUnitProcessorEnabler
NotFoundException
-
canonicalUnitProcessorEnablerId
is not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.