public interface CanonicalUnitProcessorQuerySession extends OsidSession
This session provides methods for searching among
CanonicalUnitProcessor
objects. The search query is constructed
using the CanonicalUnitProcessorQuery.
This session defines views that offer differing behaviors for searching.
CanonicalUnit processor may have a query record indicated by their
respective record types. The record is accessed via the
CanonicalUnitProcessorQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCanonicalUnitProcessors()
Tests if this user can perform
CanonicalUnitProcessor
lookups. |
CanonicalUnitProcessorQuery |
getCanonicalUnitProcessorQuery()
Gets a canonical unit processor query.
|
CanonicalUnitProcessorList |
getCanonicalUnitProcessorsByQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery)
Gets a list of
CanonicalUnitProcessors 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 canSearchCanonicalUnitProcessors()
CanonicalUnitProcessor
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. CanonicalUnitProcessorQuery getCanonicalUnitProcessorQuery()
mandatory
- This method must be implemented. CanonicalUnitProcessorList getCanonicalUnitProcessorsByQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessors
matching the
given search.canonicalUnitProcessorQuery
- the canonical unit processor query CanonicalUnitProcessorList
NullArgumentException
-
canonicalUnitProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorQuery
is not of this servicemandatory
- This method must be implemented.