org.osid.offering.rules

Interface OfferingConstrainerEnablerRuleLookupSession

All Superinterfaces:

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

public interface OfferingConstrainerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve OfferingConstrainerEnabler to OfferingConstrainer mappings. A CanonicalUnit with multiple OfferingConstrainerEnablers means any positive rule evaluation across the enablers 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 enablers defined explicitly in the current catalogue
• federated catalogue view: All methods in this session operate, retrieve and pertain to all offering constrainer enablers defined in this catalogue and any other offering constrainer enablers implicitly available in this catalogue through catalogue inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOfferingConstrainerEnablerRules() Tests if this user can perform lookups of offering constrainer enabler/offering constrainer mappings.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
IdList	getOfferingConstrainerEnablerIdsForOfferingConstrainer(Id offeringConstrainerId) Gets the OfferingConstrainerEnabler Id associated with an OfferingConstrainer.
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersForOfferingConstrainer(Id offeringConstrainerId) Gets the OfferingConstrainerEnablers associated with an OfferingConstrainer.
IdList	getOfferingConstrainerIdsForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) Gets the OfferingConstrainer Ids mapped to an OfferingConstrainerEnabler.
OfferingConstrainerList	getOfferingConstrainersForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) Gets the OfferingConstrainers mapped to an OfferingConstrainerEnabler.
void	useComparativeOfferingConstrainerEnablerRuleView() 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	usePlenaryOfferingConstrainerEnablerRuleView() A complete view of the OfferingConstrainerEnabler and OfferingConstrainer 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.

canLookupOfferingConstrainerEnablerRules

boolean canLookupOfferingConstrainerEnablerRules()

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

useComparativeOfferingConstrainerEnablerRuleView

void useComparativeOfferingConstrainerEnablerRuleView()

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.

usePlenaryOfferingConstrainerEnablerRuleView

void usePlenaryOfferingConstrainerEnablerRuleView()

A complete view of the OfferingConstrainerEnabler and OfferingConstrainer 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 enablers 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.

getOfferingConstrainerEnablerIdsForOfferingConstrainer

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

Gets the OfferingConstrainerEnabler Id associated with an OfferingConstrainer.

Parameters:

offeringConstrainerId - Id of the OfferingConstrainer

Returns:

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

getOfferingConstrainerEnablersForOfferingConstrainer

OfferingConstrainerEnablerList getOfferingConstrainerEnablersForOfferingConstrainer(Id offeringConstrainerId)
                                                                                    throws NotFoundException,
                                                                                           OperationFailedException,
                                                                                           PermissionDeniedException

Gets the OfferingConstrainerEnablers associated with an OfferingConstrainer.

Parameters:

offeringConstrainerId - Id of the OfferingConstrainer

Returns:

the offering constrainer enablers

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.

getOfferingConstrainerIdsForOfferingConstrainerEnabler

IdList getOfferingConstrainerIdsForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Gets the OfferingConstrainer Ids mapped to an OfferingConstrainerEnabler.

Parameters:

offeringConstrainerEnablerId - Id of an OfferingConstrainerEnabler

Returns:

list of offering constrainer Ids

Throws:

NotFoundException - offeringConstrainerEnablerId is not found

NullArgumentException - offeringConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainersForOfferingConstrainerEnabler

OfferingConstrainerList getOfferingConstrainersForOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException,
                                                                                    PermissionDeniedException

Gets the OfferingConstrainers mapped to an OfferingConstrainerEnabler.

Parameters:

offeringConstrainerEnablerId - Id of an OfferingConstrainerEnabler

Returns:

list of offering constrainers

Throws:

NotFoundException - offeringConstrainerEnablerId is not found

NullArgumentException - offeringConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.