org.osid.offering.rules

Interface CanonicalUnitEnablerCatalogueSession

All Superinterfaces:

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

public interface CanonicalUnitEnablerCatalogueSession
extends OsidSession

This session provides methods to retrieve CanonicalUnitEnabler to Catalogue mappings. A CanonicalUnitEnabler 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	canLookupCanonicalUnitEnablerCatalogueMappings() Tests if this user can perform lookups of canonical unit enabler/catalogue mappings.
IdList	getCanonicalUnitEnablerIdsByCatalogue(Id catalogueId) Gets the list of CanonicalUnitEnablerIds associated with a Catalogue.
IdList	getCanonicalUnitEnablerIdsByCatalogues(IdList catalogueIds) Gets the list of CanonicalUnitEnabler Ids corresponding to a list of Catalogues.
CanonicalUnitEnablerList	getCanonicalUnitEnablersByCatalogue(Id catalogueId) Gets the list of canonical unit enablers associated with a Catalogue.
CanonicalUnitEnablerList	getCanonicalUnitEnablersByCatalogues(IdList catalogueIds) Gets the list of canonical unit enablers corresponding to a list of Catalogues.
IdList	getCatalogueIdsByCanonicalUnitEnabler(Id canonicalUnitEnablerId) Gets the Catalogue Ids mapped to a CanonicalUnitEnabler.
CatalogueList	getCataloguesByCanonicalUnitEnabler(Id canonicalUnitEnablerId) Gets the Catalogues mapped to a CanonicalUnitEnabler.
void	useComparativeCanonicalUnitEnablerCatalogueView() 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	usePlenaryCanonicalUnitEnablerCatalogueView() A complete view of the CanonicalUnitEnabler 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

canLookupCanonicalUnitEnablerCatalogueMappings

boolean canLookupCanonicalUnitEnablerCatalogueMappings()

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

useComparativeCanonicalUnitEnablerCatalogueView

void useComparativeCanonicalUnitEnablerCatalogueView()

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.

usePlenaryCanonicalUnitEnablerCatalogueView

void usePlenaryCanonicalUnitEnablerCatalogueView()

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

getCanonicalUnitEnablerIdsByCatalogue

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

Gets the list of CanonicalUnitEnablerIds associated with a Catalogue.

Parameters:

catalogueId - Id of the Catalogue

Returns:

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

getCanonicalUnitEnablersByCatalogue

CanonicalUnitEnablerList getCanonicalUnitEnablersByCatalogue(Id catalogueId)
                                                             throws NotFoundException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

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

Parameters:

catalogueId - Id of the Catalogue

Returns:

list of related canonical unit enablers

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.

getCanonicalUnitEnablerIdsByCatalogues

IdList getCanonicalUnitEnablerIdsByCatalogues(IdList catalogueIds)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical unit enabler Ids

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablersByCatalogues

CanonicalUnitEnablerList getCanonicalUnitEnablersByCatalogues(IdList catalogueIds)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

catalogueIds - list of catalogue Ids

Returns:

list of canonical unit enablers

Throws:

NullArgumentException - catalogueIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCatalogueIdsByCanonicalUnitEnabler

IdList getCatalogueIdsByCanonicalUnitEnabler(Id canonicalUnitEnablerId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the Catalogue Ids mapped to a CanonicalUnitEnabler.

Parameters:

canonicalUnitEnablerId - Id of a CanonicalUnitEnabler

Returns:

list of catalogues

Throws:

NotFoundException - canonicalUnitEnablerId is not found

NullArgumentException - canonicalUnitEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCataloguesByCanonicalUnitEnabler

CatalogueList getCataloguesByCanonicalUnitEnabler(Id canonicalUnitEnablerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the Catalogues mapped to a CanonicalUnitEnabler.

Parameters:

canonicalUnitEnablerId - Id of a CanonicalUnitEnabler

Returns:

list of catalogues

Throws:

NotFoundException - canonicalUnitEnablerId is not found

NullArgumentException - canonicalUnitEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.