public interface CanonicalUnitEnablerCatalogueSession extends OsidSession
This session provides methods to retrieve CanonicalUnitEnabler
to Catalogue
mappings. A
CanonicalUnitEnabler
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 |
canLookupCanonicalUnitEnablerCatalogueMappings()
Tests if this user can perform lookups of canonical unit
enabler/catalogue mappings.
|
IdList |
getCanonicalUnitEnablerIdsByCatalogue(Id catalogueId)
Gets the list of
CanonicalUnitEnablerIds associated
with a Catalogue. |
IdList |
getCanonicalUnitEnablerIdsByCatalogues(IdList catalogueIds)
Gets the list of
CanonicalUnitEnabler Ids corresponding
to a list of Catalogues. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByCatalogue(Id catalogueId)
Gets the list of canonical unit enablers associated with a
Catalogue. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByCatalogues(IdList catalogueIds)
Gets the list of canonical unit enablers corresponding to a list of
Catalogues. |
IdList |
getCatalogueIdsByCanonicalUnitEnabler(Id canonicalUnitEnablerId)
Gets the
Catalogue Ids mapped to a
CanonicalUnitEnabler. |
CatalogueList |
getCataloguesByCanonicalUnitEnabler(Id canonicalUnitEnablerId)
Gets the
Catalogues mapped to a
CanonicalUnitEnabler. |
void |
useComparativeCanonicalUnitEnablerCatalogueView()
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 |
usePlenaryCanonicalUnitEnablerCatalogueView()
A complete view of the
CanonicalUnitEnabler and
Catalogue returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCanonicalUnitEnablerCatalogueMappings()
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 useComparativeCanonicalUnitEnablerCatalogueView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitEnablerCatalogueView()
CanonicalUnitEnabler
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 getCanonicalUnitEnablerIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitEnablerIds
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. CanonicalUnitEnablerList getCanonicalUnitEnablersByCatalogue(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 getCanonicalUnitEnablerIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnabler 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. CanonicalUnitEnablerList getCanonicalUnitEnablersByCatalogues(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 getCatalogueIdsByCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
Ids
mapped to a
CanonicalUnitEnabler.
canonicalUnitEnablerId
- Id
of a
CanonicalUnitEnabler
NotFoundException
- canonicalUnitEnablerId
is not foundNullArgumentException
- canonicalUnitEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogueList getCataloguesByCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogues
mapped to a
CanonicalUnitEnabler.
canonicalUnitEnablerId
- Id
of a
CanonicalUnitEnabler
NotFoundException
- canonicalUnitEnablerId
is not foundNullArgumentException
- canonicalUnitEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.