org.osid.offering.rules

Interface OfferingConstrainerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

OfferingConstrainerSearchSession

public interface OfferingConstrainerQuerySession
extends OsidSession

This session provides methods for searching among OfferingConstrainer objects. The search query is constructed using the OfferingConstrainerQuery.

This session defines views that offer differing behaviors for searching.

• federated catalogue view: searches include offering constrainer in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
• isolated catalogue view: searches are restricted to offering constrainer in this catalogue

CanonicalUnit constrainer may have a query record indicated by their respective record types. The query record is accessed via the OfferingConstrainerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchOfferingConstrainers() Tests if this user can perform OfferingConstrainer lookups.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
OfferingConstrainerQuery	getOfferingConstrainerQuery() Gets an offering constrainer query.
OfferingConstrainerList	getOfferingConstrainersByQuery(OfferingConstrainerQuery offeringConstrainerQuery) Gets a list of OfferingConstrainers matching the given search.
void	useFederatedCatalogueView() Federates the view for methods in this session.
void	useIsolatedCatalogueView() Isolates the view for methods in this session.

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.

canSearchOfferingConstrainers

boolean canSearchOfferingConstrainers()

Tests if this user can perform OfferingConstrainer lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method 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 broker 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.

getOfferingConstrainerQuery

OfferingConstrainerQuery getOfferingConstrainerQuery()

Gets an offering constrainer query.

Returns:

the offering constrainer query

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainersByQuery

OfferingConstrainerList getOfferingConstrainersByQuery(OfferingConstrainerQuery offeringConstrainerQuery)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a list of OfferingConstrainers matching the given search.

Parameters:

offeringConstrainerQuery - the offering constrainer query

Returns:

the returned OfferingConstrainerList

Throws:

NullArgumentException - offeringConstrainerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - offeringConstrainerQuery is not of this service

Compliance:

mandatory - This method must be implemented.