public interface OfferingConstrainerEnablerQuerySession extends OsidSession
This session provides methods for searching among
OfferingConstrainerEnabler
objects. The search query is
constructed using the OfferingConstrainerEnablerQuery.
This session defines views that offer differing behaviors for searching.
CanonicalUnit constrainer enablers may have a query record indicated
by their respective record types. The query record is accessed via the
OfferingConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchOfferingConstrainerEnablers()
Tests if this user can perform
OfferingConstrainerEnabler
lookups. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
OfferingConstrainerEnablerQuery |
getOfferingConstrainerEnablerQuery()
Gets an offering constrainer enabler query.
|
OfferingConstrainerEnablerList |
getOfferingConstrainerEnablersByQuery(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery)
Gets a list of
OfferingConstrainerEnablers matching the
given search. |
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchOfferingConstrainerEnablers()
OfferingConstrainerEnabler
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQuery()
mandatory
- This method must be implemented. OfferingConstrainerEnablerList getOfferingConstrainerEnablersByQuery(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnablers
matching the
given search.offeringConstrainerEnablerQuery
- the canonical unit constraienr
enabler query OfferingConstrainerEnablerList
NullArgumentException
-
offeringConstrainerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
offeringConstrainerEnablerQuery
is not of this servicemandatory
- This method must be implemented.