org.osid.offering.rules

Interface CanonicalUnitProcessorRuleLookupSession

All Superinterfaces:

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

public interface CanonicalUnitProcessorRuleLookupSession
extends OsidSession

This session provides methods to retrieve CanonicalUnitProcessor to CanonicalUnit mappings.

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
• isolated catalogue view: All methods in this session operate, retrieve and pertain canonical unit processor defined explicitly in the current catalogue
• federated catalogue view: All methods in this session operate, retrieve and pertain to all canonical unit processor defined in this catalogue and any other canonical unit processor implicitly available in this catalogue through catalogue inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCanonicalUnitProcessorRules() Tests if this user can perform lookups of canonical unit processor/canonical unit mappings.
IdList	getCanonicalUnitIdsForCanonicalUnitProcessor(Id canonicalUnitProcessorId) Gets the CanonicalUnit Ids mapped to a CanonicalUnitProcessor.
IdList	getCanonicalUnitProcessorIdsForCanonicalUnit(Id canonicalUnitId) Gets the CanonicalUnitProcessor Id associated with a CanonicalUnit.
CanonicalUnitProcessorList	getCanonicalUnitProcessorsForCanonicalUnit(Id canonicalUnitId) Gets the CanonicalUnitProcessor associated with a CanonicalUnit.
CanonicalUnitList	getCanonicalUnitsForCanonicalUnitProcessor(Id canonicalUnitProcessorId) Gets the CanonicalUnits mapped to a CanonicalUnitProcessor.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	useComparativeCanonicalUnitProcessorRuleView() 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	useFederatedCatalogueView() Federates the view for methods in this session.
void	useIsolatedCatalogueView() Isolates the view for methods in this session.
void	usePlenaryCanonicalUnitProcessorRuleView() A complete view of the CanonicalUnitProcessor and CanonicalUnit 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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupCanonicalUnitProcessorRules

boolean canLookupCanonicalUnitProcessorRules()

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

useComparativeCanonicalUnitProcessorRuleView

void useComparativeCanonicalUnitProcessorRuleView()

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.

usePlenaryCanonicalUnitProcessorRuleView

void usePlenaryCanonicalUnitProcessorRuleView()

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

useFederatedCatalogueView

void useFederatedCatalogueView()

Federates the view for methods in this session. A federated view will include canonical unit processor in catalogues which are children of this catalogue in the catalogue hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCatalogueView

void useIsolatedCatalogueView()

Isolates the view for methods in this session. An isolated view restricts lookups to this catalogue only.

Compliance:

mandatory - This method is must be implemented.

getCanonicalUnitProcessorIdsForCanonicalUnit

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

Gets the CanonicalUnitProcessor Id associated with a CanonicalUnit.

Parameters:

canonicalUnitId - Id of the CanonicalUnit

Returns:

the canonical unit processor 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.

getCanonicalUnitProcessorsForCanonicalUnit

CanonicalUnitProcessorList getCanonicalUnitProcessorsForCanonicalUnit(Id canonicalUnitId)
                                                                      throws NotFoundException,
                                                                             OperationFailedException,
                                                                             PermissionDeniedException

Gets the CanonicalUnitProcessor associated with a CanonicalUnit.

Parameters:

canonicalUnitId - Id of the CanonicalUnit

Returns:

the canonical unit processors

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.

getCanonicalUnitIdsForCanonicalUnitProcessor

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

Gets the CanonicalUnit Ids mapped to a CanonicalUnitProcessor.

Parameters:

canonicalUnitProcessorId - Id of a CanonicalUnitProcessor

Returns:

list of canonical unit Ids

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.

getCanonicalUnitsForCanonicalUnitProcessor

CanonicalUnitList getCanonicalUnitsForCanonicalUnitProcessor(Id canonicalUnitProcessorId)
                                                             throws NotFoundException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Gets the CanonicalUnits mapped to a CanonicalUnitProcessor.

Parameters:

canonicalUnitProcessorId - Id of a CanonicalUnitProcessor

Returns:

list of canonicalUnits

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.