public interface CatalogEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve CatalogEnabler
to Catalog
mappings. A Catalog
with multiple
CatalogEnablers
means any positive rule evaluation across
the enablers result in an enabled Catalog.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCatalogEnablerRules()
Tests if this user can perform lookups of catalog enabler/catalog
mappings.
|
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
IdList |
getCatalogEnablerIdsForCatalog(Id catalogId)
Gets the
CatalogEnabler Id associated with a
Catalog. |
CatalogEnablerList |
getCatalogEnablersForCatalog(Id catalogId)
Gets the
CatalogEnabler associated with a
Catalog. |
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
IdList |
getCatalogIdsForCatalogEnabler(Id catalogEnablerId)
Gets the
Catalog Ids mapped to a
CatalogEnabler. |
CatalogList |
getCatalogsForCatalogEnabler(Id catalogEnablerId)
Gets the
Catalogs mapped to a CatalogEnabler. |
void |
useComparativeCatalogEnablerRuleView()
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 |
useFederatedCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryCatalogEnablerRuleView()
A complete view of the
CatalogEnabler and
Catalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogId()
Catalog
Id
associated with this
session. Catalog Id
associated with this sessionmandatory
- This method must be implemented. Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
Catalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCatalogEnablerRules()
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 useComparativeCatalogEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryCatalogEnablerRuleView()
CatalogEnabler
and
Catalog
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 useFederatedCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCatalogView()
mandatory
- This method is must be implemented. IdList getCatalogEnablerIdsForCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler Id
associated with a
Catalog.
catalogId
- Id
of the Catalog
Ids
NotFoundException
- catalogId
is not
foundNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersForCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler
associated with a
Catalog.
catalogId
- Id
of the Catalog
NotFoundException
- catalogId
is not
foundNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCatalogIdsForCatalogEnabler(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalog
Ids
mapped to a
CatalogEnabler.
catalogEnablerId
- Id
of a CatalogEnabler
Ids
NotFoundException
- catalogEnablerId
is
not foundNullArgumentException
- catalogEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogList getCatalogsForCatalogEnabler(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalogs
mapped to a CatalogEnabler.
catalogEnablerId
- Id
of a CatalogEnabler
NotFoundException
- catalogEnablerId
is
not foundNullArgumentException
- catalogEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.