org.osid.offering.rules

Interface CanonicalUnitProcessorCatalogueSession

All Superinterfaces:

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

public interface CanonicalUnitProcessorCatalogueSession
extends OsidSession

This session provides methods to retrieve CanonicalUnitProcessor to Catalogue mappings. A CanonicalUnitProcessor may appear in multiple Catalogue objects. 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	canLookupCanonicalUnitProcessorCatalogueMappings() Tests if this user can perform lookups of canonical unit processor/catalogue mappings.
IdList	getCanonicalUnitProcessorIdsByCatalogue(Id catalogueId) Gets the list of CanonicalUnitProcessorIds associated with a Catalogue.
IdList	getCanonicalUnitProcessorIdsByCatalogues(IdList catalogueIds) Gets the list of CanonicalUnitProcessor Ids corresponding to a list of Catalogues.
CanonicalUnitProcessorList	getCanonicalUnitProcessorsByCatalogue(Id catalogueId) Gets the list of canonical unit processors associated with a Catalogue.
CanonicalUnitProcessorList	getCanonicalUnitProcessorsByCatalogues(IdList catalogueIds) Gets the list of canonical unit processor corresponding to a list of Catalogues.
IdList	getCatalogueIdsByCanonicalUnitProcessor(Id canonicalUnitProcessorId) Gets the Catalogue Ids mapped to a CanonicalUnitProcessor.
CatalogueList	getCataloguesByCanonicalUnitProcessor(Id canonicalUnitProcessorId) Gets the Catalogues mapped to a CanonicalUnitProcessor.
void	useComparativeCanonicalUnitProcessorCatalogueView() 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	usePlenaryCanonicalUnitProcessorCatalogueView() A complete view of the CanonicalUnitProcessor 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

canLookupCanonicalUnitProcessorCatalogueMappings

boolean canLookupCanonicalUnitProcessorCatalogueMappings()

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

useComparativeCanonicalUnitProcessorCatalogueView

void useComparativeCanonicalUnitProcessorCatalogueView()

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.

usePlenaryCanonicalUnitProcessorCatalogueView

void usePlenaryCanonicalUnitProcessorCatalogueView()

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

getCanonicalUnitProcessorIdsByCatalogue

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

Gets the list of CanonicalUnitProcessorIds associated with a Catalogue.

Parameters:

catalogueId - Id of the Catalogue

Returns:

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

getCanonicalUnitProcessorsByCatalogue

CanonicalUnitProcessorList getCanonicalUnitProcessorsByCatalogue(Id catalogueId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Gets the list of canonical unit processors associated with a Catalogue.

Parameters:

catalogueId - Id of the Catalogue

Returns:

list of related canonical unit processors

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.

getCanonicalUnitProcessorIdsByCatalogues

IdList getCanonicalUnitProcessorIdsByCatalogues(IdList catalogueIds)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the list of CanonicalUnitProcessor Ids corresponding to a list of Catalogues.

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical unit processor Ids

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorsByCatalogues

CanonicalUnitProcessorList getCanonicalUnitProcessorsByCatalogues(IdList catalogueIds)
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets the list of canonical unit processor corresponding to a list of Catalogues.

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical unit processors

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueIdsByCanonicalUnitProcessor

IdList getCatalogueIdsByCanonicalUnitProcessor(Id canonicalUnitProcessorId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets the Catalogue Ids mapped to a CanonicalUnitProcessor.

Parameters:

canonicalUnitProcessorId - Id of a CanonicalUnitProcessor

Returns:

list of catalogues

Throws:

NotFoundException - canonicalUnitProcessorId is not found

NullArgumentException - canonicalUnitProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCataloguesByCanonicalUnitProcessor

CatalogueList getCataloguesByCanonicalUnitProcessor(Id canonicalUnitProcessorId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the Catalogues mapped to a CanonicalUnitProcessor.

Parameters:

canonicalUnitProcessorId - Id of a CanonicalUnitProcessor

Returns:

list of catalogues

Throws:

NotFoundException - canonicalUnitProcessorId is not found

NullArgumentException - canonicalUnitProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.