public interface CategoryQuerySession extends OsidSession
This session provides methods for searching among Category
objects. The search query is constructed using the
CategoryQuery.
This session defines views that offer differing behaviors for searching.
Categories may have a query record indicated by their respective query
record types. The query record is accessed via the CategoryQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCategories()
Tests if this user can perform
Category lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
CategoryList |
getCategoriesByQuery(CategoryQuery categoryQuery)
Gets a list of
Categories matching the given category
query. |
CategoryQuery |
getCategoryQuery()
Gets a category query.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCategories()
Category
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 useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. CategoryQuery getCategoryQuery()
mandatory
- This method must be implemented. CategoryList getCategoriesByQuery(CategoryQuery categoryQuery) throws OperationFailedException, PermissionDeniedException
Categories
matching the given category
query.categoryQuery
- the category query CategoryList
NullArgumentException
- categoryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- categoryQuery
is
not of this servicemandatory
- This method must be implemented.