public interface OfferingConstrainerEnablerCatalogueSession extends OsidSession
This session provides methods to retrieve
OfferingConstrainerEnabler
to Catalogue
mappings.
An OfferingConstrainerEnabler
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 |
canLookupOfferingConstrainerEnablerCatalogueMappings()
Tests if this user can perform lookups of offering constrainer
enabler/catalogue mappings.
|
IdList |
getCatalogueIdsByOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Gets the
Catalogue Ids mapped to an
OfferingConstrainerEnabler. |
CatalogueList |
getCataloguesByOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Gets the
Catalogues mapped to an
OfferingConstrainerEnabler. |
IdList |
getOfferingConstrainerEnablerIdsByCatalogue(Id catalogueId)
Gets the list of
OfferingConstrainerEnablerIds
associated with a Catalogue. |
IdList |
getOfferingConstrainerEnablerIdsByCatalogues(IdList catalogueIds)
Gets the list of
OfferingConstrainerEnabler Ids
corresponding to a list of Catalogues. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByCatalogue(Id catalogueId)
Gets the list of offering constrainer enablers associated with a
Catalogue. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByCatalogues(IdList catalogueIds)
Gets the list of offering constrainer enablers corresponding to a list
of
Catalogues. |
void |
useComparativeOfferingConstrainerEnablerCatalogueView()
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 |
usePlenaryOfferingConstrainerEnablerCatalogueView()
A complete view of the
OfferingConstrainerEnabler and
Catalogue returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupOfferingConstrainerEnablerCatalogueMappings()
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 useComparativeOfferingConstrainerEnablerCatalogueView()
mandatory
- This method is must be implemented. void usePlenaryOfferingConstrainerEnablerCatalogueView()
OfferingConstrainerEnabler
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 getOfferingConstrainerEnablerIdsByCatalogue(Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablerIds
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. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByCatalogue(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 getOfferingConstrainerEnablerIdsByCatalogues(IdList catalogueIds) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler 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. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByCatalogues(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 getCatalogueIdsByOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogue
Ids
mapped to an
OfferingConstrainerEnabler.
offeringConstrainerEnablerId
- Id
of an
OfferingConstrainerEnabler
NotFoundException
- offeringConstrainerEnablerId
is not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogueList getCataloguesByOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogues
mapped to an
OfferingConstrainerEnabler.
offeringConstrainerEnablerId
- Id
of an
OfferingConstrainerEnabler
NotFoundException
- offeringConstrainerEnablerId
is not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.