public interface OfferingConstrainerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve
OfferingConstrainerEnabler
to OfferingConstrainer
mappings. A CanonicalUnit
with multiple
OfferingConstrainerEnablers
means any positive rule evaluation
across the enablers result in an effective CanonicalUnit.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupOfferingConstrainerEnablerRules()
Tests if this user can perform lookups of offering constrainer
enabler/offering constrainer mappings.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
IdList |
getOfferingConstrainerEnablerIdsForOfferingConstrainer(Id offeringConstrainerId)
Gets the
OfferingConstrainerEnabler Id associated with
an OfferingConstrainer. |
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersForOfferingConstrainer(Id offeringConstrainerId)
Gets the
OfferingConstrainerEnablers associated with an
OfferingConstrainer. |
IdList |
getOfferingConstrainerIdsForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Gets the
OfferingConstrainer Ids mapped
to an OfferingConstrainerEnabler. |
OfferingConstrainerList |
getOfferingConstrainersForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Gets the
OfferingConstrainers mapped to an
OfferingConstrainerEnabler. |
void |
useComparativeOfferingConstrainerEnablerRuleView()
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 |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
void |
usePlenaryOfferingConstrainerEnablerRuleView()
A complete view of the
OfferingConstrainerEnabler and
OfferingConstrainer returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupOfferingConstrainerEnablerRules()
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 useComparativeOfferingConstrainerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryOfferingConstrainerEnablerRuleView()
OfferingConstrainerEnabler
and
OfferingConstrainer
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. void useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. IdList getOfferingConstrainerEnablerIdsForOfferingConstrainer(Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler Id
associated with
an OfferingConstrainer.
offeringConstrainerId
- Id
of the
OfferingConstrainer
Ids
NotFoundException
- offeringConstrainerId
is not foundNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersForOfferingConstrainer(Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablers
associated with an
OfferingConstrainer.
offeringConstrainerId
- Id
of the
OfferingConstrainer
NotFoundException
- offeringConstrainerId
is not foundNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOfferingConstrainerIdsForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainer
Ids
mapped
to an OfferingConstrainerEnabler.
offeringConstrainerEnablerId
- Id
of an
OfferingConstrainerEnabler
Ids
NotFoundException
- offeringConstrainerEnablerId
is not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfferingConstrainerList getOfferingConstrainersForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainers
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.