org.osid.offering.rules

Interface OfferingConstrainerRuleLookupSession

All Superinterfaces:

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

public interface OfferingConstrainerRuleLookupSession
extends OsidSession

This session provides methods to retrieve OfferingConstrainer to CanonicalUnit mappings. A CanonicalUnit with multiple OfferingConstrainers means any positive rule evaluation across the result in an effective CanonicalUnit.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOfferingConstrainerRules() Tests if this user can perform lookups of offering constrainer/canonical unit mappings.
IdList	getCanonicalUnitIdsForOfferingConstrainer(Id offeringConstrainerId) Gets the CanonicalUnit Ids mapped to an OfferingConstrainer.
CanonicalUnitList	getCanonicalUnitsForOfferingConstrainer(Id offeringConstrainerId) Gets the CanonicalUnits mapped to an OfferingConstrainer.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
IdList	getOfferingConstrainerIdsForCanonicalUnit(Id canonicalUnitId) Gets the OfferingConstrainer Id associated with a CanonicalUnit.
OfferingConstrainerList	getOfferingConstrainersForCanonicalUnit(Id canonicalUnitId) Gets the OfferingConstrainer associated with a CanonicalUnit.
void	useComparativeOfferingConstrainerRuleView() 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	usePlenaryOfferingConstrainerRuleView() A complete view of the OfferingConstrainer 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.

canLookupOfferingConstrainerRules

boolean canLookupOfferingConstrainerRules()

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

useComparativeOfferingConstrainerRuleView

void useComparativeOfferingConstrainerRuleView()

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.

usePlenaryOfferingConstrainerRuleView

void usePlenaryOfferingConstrainerRuleView()

A complete view of the OfferingConstrainer 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 offering constrainer 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.

getOfferingConstrainerIdsForCanonicalUnit

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

Gets the OfferingConstrainer Id associated with a CanonicalUnit.

Parameters:

canonicalUnitId - Id of the CanonicalUnit

Returns:

the offering constrainer 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.

getOfferingConstrainersForCanonicalUnit

OfferingConstrainerList getOfferingConstrainersForCanonicalUnit(Id canonicalUnitId)
                                                                throws NotFoundException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Gets the OfferingConstrainer associated with a CanonicalUnit.

Parameters:

canonicalUnitId - Id of the CanonicalUnit

Returns:

the offering constrainers

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.

getCanonicalUnitIdsForOfferingConstrainer

IdList getCanonicalUnitIdsForOfferingConstrainer(Id offeringConstrainerId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Gets the CanonicalUnit Ids mapped to an OfferingConstrainer.

Parameters:

offeringConstrainerId - Id of an OfferingConstrainer

Returns:

list of canonical unit Ids

Throws:

NotFoundException - offeringConstrainerId is not found

NullArgumentException - offeringConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitsForOfferingConstrainer

CanonicalUnitList getCanonicalUnitsForOfferingConstrainer(Id offeringConstrainerId)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the CanonicalUnits mapped to an OfferingConstrainer.

Parameters:

offeringConstrainerId - Id of an OfferingConstrainer

Returns:

list of canonicalUnits

Throws:

NotFoundException - offeringConstrainerId is not found

NullArgumentException - offeringConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.