org.osid.offering

Interface CanonicalUnitCatalogueSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CanonicalUnitCatalogueSession
extends OsidSession

This session provides methods to retrieve CanonicalUnit to Catalogue mappings. A CanonicalUnit 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

Methods

Modifier and Type	Method and Description
boolean	canLookupCanonicalUnitCatalogueMappings() Tests if this user can perform lookups of canonical unit/catalogue mappings.
IdList	getCanonicalUnitIdsByCatalogue(Id catalogueId) Gets the list of CanonicalUnit Ids associated with a Catalogue.
IdList	getCanonicalUnitIdsByCatalogues(IdList catalogueIds) Gets the list of CanonicalUnit Ids corresponding to a list of Catalogue objects.
CanonicalUnitList	getCanonicalUnitsByCatalogue(Id catalogueId) Gets the list of CanonicalUnits associated with a Catalogue.
CanonicalUnitList	getCanonicalUnitsByCatalogues(IdList catalogueIds) Gets the list of CanonicalUnits corresponding to a list of Catalogues.
IdList	getCatalogueIdsByCanonicalUnit(Id canonicalUnitId) Gets the list of Catalogue Ids mapped to a CanonicalUnit.
CatalogueList	getCataloguesByCanonicalUnit(Id canonicalUnitId) Gets the list of Catalogue objects mapped to a CanonicalUnit.
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 CanonicalUnit and Catalogue returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupCanonicalUnitCatalogueMappings

boolean canLookupCanonicalUnitCatalogueMappings()

Tests if this user can perform lookups of canonical unit/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 CanonicalUnit 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.

getCanonicalUnitIdsByCatalogue

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

Gets the list of CanonicalUnit Ids associated with a Catalogue.

Parameters:

catalogueId - Id of a Catalogues.

Returns:

list of related canonical unit 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.

getCanonicalUnitsByCatalogue

CanonicalUnitList getCanonicalUnitsByCatalogue(Id catalogueId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the list of CanonicalUnits associated with a Catalogue.

Parameters:

catalogueId - Id of a Catalogue

Returns:

list of related canonical units

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.

getCanonicalUnitIdsByCatalogues

IdList getCanonicalUnitIdsByCatalogues(IdList catalogueIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical unit Ids

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitsByCatalogues

CanonicalUnitList getCanonicalUnitsByCatalogues(IdList catalogueIds)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical units

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueIdsByCanonicalUnit

IdList getCatalogueIdsByCanonicalUnit(Id canonicalUnitId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the list of Catalogue Ids mapped to a CanonicalUnit.

Parameters:

canonicalUnitId - Id of a CanonicalUnit

Returns:

list of catalogue Ids

Throws:

NotFoundException - canonicalUnitId is not found

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCataloguesByCanonicalUnit

CatalogueList getCataloguesByCanonicalUnit(Id canonicalUnitId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the list of Catalogue objects mapped to a CanonicalUnit.

Parameters:

canonicalUnitId - Id of a CanonicalUnit

Returns:

list of catalogues

Throws:

NotFoundException - canonicalUnitId is not found

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.