Interface CatalogEnablerCatalogSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	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 CatalogEnablerIds 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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupCatalogEnablerCatalogMappings

boolean canLookupCatalogEnablerCatalogMappings()

Tests if this user can perform lookups of catalog enabler/catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCatalogEnablerCatalogView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCatalogEnablerCatalogView

void usePlenaryCatalogEnablerCatalogView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getCatalogEnablerIdsByCatalog

IdList getCatalogEnablerIdsByCatalog(Id catalogId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of CatalogEnablerIds associated with a Catalog .

Parameters:

catalogId - Id of the Catalog

Returns:

list of related catalog enabler Ids

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogEnablersByCatalog

CatalogEnablerList getCatalogEnablersByCatalog(Id catalogId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of catalog enablers associated with a Catalog .

Parameters:

catalogId - Id of the Catalog

Returns:

list of related catalog enablers

Throws:

NotFoundException - catalogId is not found

NullArgumentException - catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerIdsByCatalogs

IdList getCatalogEnablerIdsByCatalogs(IdList catalogIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of CatalogEnablerIds corresponding to a list of Catalogs .

Parameters:

catalogIds - list of catalog Ids

Returns:

list of catalog enabler Ids

Throws:

NullArgumentException - catalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogEnablersByCatalogs

CatalogEnablerList getCatalogEnablersByCatalogs(IdList catalogIds)
                                         throws OperationFailedException,
PermissionDeniedException

Gets the list of catalog enablers corresponding to a list of Catalogs .

Parameters:

catalogIds - list of catalog Ids

Returns:

list of catalog enablers

Throws:

NullArgumentException - catalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogIdsByCatalogEnabler

IdList getCatalogIdsByCatalogEnabler(Id catalogEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Catalog Ids mapped to a CatalogEnabler .

Parameters:

catalogEnablerId - Id of a CatalogEnabler

Returns:

list of catalogs

Throws:

NotFoundException - catalogEnablerId is not found

NullArgumentException - catalogEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogsByCatalogEnabler

CatalogList getCatalogsByCatalogEnabler(Id catalogEnablerId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Catalogs mapped to a CatalogEnabler .

Parameters:

catalogEnablerId - Id of a CatalogEnabler

Returns:

list of catalogs

Throws:

NotFoundException - catalogEnablerId is not found

NullArgumentException - catalogEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.