Interface OfferingCatalogueSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OfferingCatalogueSession
extends OsidSession

This session provides methods to retrieve Offering to Catalogue mappings. An Offering may appear in multiple Catalogues. Each Catalogue 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	canLookupOfferingCatalogueMappings()	Tests if this user can perform lookups of offering/catalogue mappings.
IdList	getCatalogueIdsByOffering(Id offeringId)	Gets the list of Catalogue Ids mapped to an Offering.
CatalogueList	getCataloguesByOffering(Id offeringId)	Gets the list of Catalogue objects mapped to an Offering.
IdList	getOfferingIdsByCatalogue(Id catalogueId)	Gets the list of Offering Ids associated with a Catalogue.
IdList	getOfferingIdsByCatalogues(IdList catalogueIds)	Gets the list of Offering Ids corresponding to a list of Catalogue objects.
OfferingList	getOfferingsByCatalogue(Id catalogueId)	Gets the list of Offerings associated with a Catalogue .
OfferingList	getOfferingsByCatalogues(IdList catalogueIds)	Gets the list of Offerings corresponding to a list of Catalogues.
void	useComparativeCatalogueView()	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	usePlenaryCatalogueView()	A complete view of the Offering and Catalogue 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

canLookupOfferingCatalogueMappings

boolean canLookupOfferingCatalogueMappings()

Tests if this user can perform lookups of offering/catalogue 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 intendedas 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.

useComparativeCatalogueView

void useComparativeCatalogueView()

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.

usePlenaryCatalogueView

void usePlenaryCatalogueView()

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

getOfferingIdsByCatalogue

IdList getOfferingIdsByCatalogue(Id catalogueId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Offering Ids associated with a Catalogue.

Parameters:

catalogueId - Id of a Catalogues.

Returns:

list of related offering Ids

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingsByCatalogue

OfferingList getOfferingsByCatalogue(Id catalogueId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Offerings associated with a Catalogue .

Parameters:

catalogueId - Id of a Catalogue

Returns:

list of related offerings

Throws:

NotFoundException - catalogueId is not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingIdsByCatalogues

IdList getOfferingIdsByCatalogues(IdList catalogueIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of Offering Ids corresponding to a list of Catalogue objects.

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of offering Ids

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingsByCatalogues

OfferingList getOfferingsByCatalogues(IdList catalogueIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of Offerings corresponding to a list of Catalogues.

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of offerings

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueIdsByOffering

IdList getCatalogueIdsByOffering(Id offeringId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Catalogue Ids mapped to an Offering.

Parameters:

offeringId - Id of an Offering

Returns:

list of catalogue Ids

Throws:

NotFoundException - offeringId is not found

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCataloguesByOffering

CatalogueList getCataloguesByOffering(Id offeringId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Catalogue objects mapped to an Offering.

Parameters:

offeringId - Id of an Offering

Returns:

list of catalogues

Throws:

NotFoundException - offeringId is not found

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.