public interface CanonicalUnitEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve CanonicalUnitEnabler
to CanonicalUnit
mappings. A CanonicalUnit
with multiple CanonicalUnitEnablers
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 |
canLookupCanonicalUnitEnablerRules()
Tests if this user can perform lookups of canonical unit
enabler/canonical unit mappings.
|
IdList |
getCanonicalUnitEnablerIdsForCanonicalUnit(Id canonicalUnitId)
Gets the
CanonicalUnitEnabler Id associated with a
CanonicalUnit. |
CanonicalUnitEnablerList |
getCanonicalUnitEnablersForCanonicalUnit(Id canonicalUnitId)
Gets the
CanonicalUnitEnablers associated with a
CanonicalUnit. |
IdList |
getCanonicalUnitIdsForCanonicalUnitEnabler(Id canonicalUnitEnablerId)
Gets the
CanonicalUnit Ids mapped to a
CanonicalUnitEnabler. |
CanonicalUnitList |
getCanonicalUnitsForCanonicalUnitEnabler(Id canonicalUnitEnablerId)
Gets the
CanonicalUnits mapped to a
CanonicalUnitEnabler. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
useComparativeCanonicalUnitEnablerRuleView()
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 |
usePlenaryCanonicalUnitEnablerRuleView()
A complete view of the
CanonicalUnitEnabler and
CanonicalUnit 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 canLookupCanonicalUnitEnablerRules()
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 useComparativeCanonicalUnitEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryCanonicalUnitEnablerRuleView()
CanonicalUnitEnabler
and
CanonicalUnit
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 getCanonicalUnitEnablerIdsForCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitEnabler Id
associated with a
CanonicalUnit.
canonicalUnitId
- Id
of the CanonicalUnit
Ids
NotFoundException
- canonicalUnitId
is
not foundNullArgumentException
- canonicalUnit
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersForCanonicalUnit(Id canonicalUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitEnablers
associated with a
CanonicalUnit.
canonicalUnitId
- Id
of the CanonicalUnit
NotFoundException
- canonicalUnitId
is
not foundNullArgumentException
- canonicalUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCanonicalUnitIdsForCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnit
Ids
mapped to a
CanonicalUnitEnabler.
canonicalUnitEnablerId
- Id
of a
CanonicalUnitEnabler
Ids
NotFoundException
- canonicalUnitEnablerId
is not foundNullArgumentException
- canonicalUnitEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CanonicalUnitList getCanonicalUnitsForCanonicalUnitEnabler(Id canonicalUnitEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnits
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.