public interface CatalogEnablerQuerySession extends OsidSession
This session provides methods for searching among CatalogEnabler
objects. The search query is constructed using the
CatalogEnablerQuery.
This session defines views that offer differing behaviors for searching.
Catalog enablers may have a query record indicated by their respective
record types. The query record is accessed via the
CatalogEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCatalogEnablers()
Tests if this user can perform
CatalogEnabler lookups. |
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
CatalogEnablerQuery |
getCatalogEnablerQuery()
Gets a catalog enabler query.
|
CatalogEnablerList |
getCatalogEnablersByQuery(CatalogEnablerQuery catalogEnablerQuery)
Gets a list of
CatalogEnablers matching the given
search. |
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
void |
useFederatedCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogId()
Catalog
Id
associated with this
session. Catalog Id
associated with this sessionmandatory
- This method must be implemented. Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
Catalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCatalogEnablers()
CatalogEnabler
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 useFederatedCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCatalogView()
mandatory
- This method is must be implemented. CatalogEnablerQuery getCatalogEnablerQuery()
mandatory
- This method must be implemented. CatalogEnablerList getCatalogEnablersByQuery(CatalogEnablerQuery catalogEnablerQuery) throws OperationFailedException, PermissionDeniedException
CatalogEnablers
matching the given
search.catalogEnablerQuery
- the catalog enabler query CatalogEnablerList
NullArgumentException
- catalogEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogEnablerQuery
is not of this servicemandatory
- This method must be implemented.