public interface CatalogEnablerCatalogSession extends OsidSession
This session provides methods to retrieve CatalogEnabler
to Catalog
mappings. A CatalogEnabler
may
appear in multiple Catalog
objects. Each catalog 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 |
canLookupCatalogEnablerCatalogMappings()
Tests if this user can perform lookups of catalog enabler/catalog
mappings.
|
IdList |
getCatalogEnablerIdsByCatalog(Id catalogId)
Gets the list of
CatalogEnablerIds associated with a
Catalog. |
IdList |
getCatalogEnablerIdsByCatalogs(IdList catalogIds)
Gets the list of
CatalogEnabler Ids corresponding to a
list of Catalogs. |
CatalogEnablerList |
getCatalogEnablersByCatalog(Id catalogId)
Gets the list of catalog enablers associated with a
Catalog. |
CatalogEnablerList |
getCatalogEnablersByCatalogs(IdList catalogIds)
Gets the list of catalog enablers corresponding to a list of
Catalogs. |
IdList |
getCatalogIdsByCatalogEnabler(Id catalogEnablerId)
Gets the
Catalog Ids mapped to a
CatalogEnabler. |
CatalogList |
getCatalogsByCatalogEnabler(Id catalogEnablerId)
Gets the
Catalogs mapped to a CatalogEnabler. |
void |
useComparativeCatalogEnablerCatalogView()
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 |
usePlenaryCatalogEnablerCatalogView()
A complete view of the
CatalogEnabler and
Catalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCatalogEnablerCatalogMappings()
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 useComparativeCatalogEnablerCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCatalogEnablerCatalogView()
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. IdList getCatalogEnablerIdsByCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnablerIds
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 getCatalogEnablersByCatalog(Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getCatalogEnablerIdsByCatalogs(IdList catalogIds) throws OperationFailedException, PermissionDeniedException
CatalogEnabler Ids
corresponding to a
list of Catalogs.
catalogIds
- list of catalog Ids
Ids
NullArgumentException
- catalogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersByCatalogs(IdList catalogIds) throws OperationFailedException, PermissionDeniedException
Catalogs.
catalogIds
- list of catalog Ids
NullArgumentException
- catalogIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCatalogIdsByCatalogEnabler(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Catalog
Ids
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. CatalogList getCatalogsByCatalogEnabler(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.