public interface CanonicalUnitEnablerQuerySession extends OsidSession
This session provides methods for searching among
CanonicalUnitEnabler
objects. The search query is constructed
using the CanonicalUnitEnablerQuery.
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
CanonicalUnitEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCanonicalUnitEnablers()
Tests if this user can perform
CanonicalUnitEnabler
lookups. |
CanonicalUnitEnablerQuery |
getCanonicalUnitEnablerQuery()
Gets a canonical unit enabler query.
|
CanonicalUnitEnablerList |
getCanonicalUnitEnablersByQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery)
Gets a list of
CanonicalUnitEnablers matching the given
search. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
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 canSearchCanonicalUnitEnablers()
CanonicalUnitEnabler
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. CanonicalUnitEnablerQuery getCanonicalUnitEnablerQuery()
mandatory
- This method must be implemented. CanonicalUnitEnablerList getCanonicalUnitEnablersByQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery) throws OperationFailedException, PermissionDeniedException
CanonicalUnitEnablers
matching the given
search.canonicalUnitEnablerQuery
- the canonical unit constraienr
enabler query CanonicalUnitEnablerList
NullArgumentException
-
canonicalUnitEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- canonicalUnitEnablerQuery
is not of this servicemandatory
- This method must be implemented.