public interface CategorySmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CategoryQuery
can be retrieved from this
session and mapped to this CoursOfferingeCatalog
to create
a virtual collection of Categories.
The categories may be
sequenced using the CategorySearchOrder
from this session.
This Business
has a default query that matches any
category and a default search order that specifies no sequencing. The
queries may be examined using a CategoryQueryInspector.
The
query may be modified by converting the inspector back to a
CategoryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCategoryQuery(CategoryQuery categoryQuery)
Applies a category query to this business.
|
void |
applyCategorySequencing(CategorySearchOrder categorySearchOrder)
Applies a category search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
CategoryQuery |
getCategoryQuery()
Gets a category query.
|
CategoryQuery |
getCategoryQueryFromInspector(CategoryQueryInspector categoryQueryInspector)
Gets a category query from an inspector.
|
CategorySearchOrder |
getCategorySearchOrder()
Gets a category search order.
|
CategoryQueryInspector |
inspectCategoryQuery()
Gets a category query inspector for this business.
|
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 canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. CategoryQuery getCategoryQuery()
mandatory
- This method must be implemented. CategorySearchOrder getCategorySearchOrder()
mandatory
- This method must be implemented. void applyCategoryQuery(CategoryQuery categoryQuery) throws OperationFailedException, PermissionDeniedException
categoryQuery
- the category queryNullArgumentException
- categoryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- categoryQuery
not
of this servicemandatory
- This method must be implemented. CategoryQueryInspector inspectCategoryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCategorySequencing(CategorySearchOrder categorySearchOrder) throws OperationFailedException, PermissionDeniedException
categorySearchOrder
- the category search orderNullArgumentException
- categorySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- categorySearchOrder
not of this servicemandatory
- This method must be implemented. CategoryQuery getCategoryQueryFromInspector(CategoryQueryInspector categoryQueryInspector)
categoryQueryInspector
- a query inspectorNullArgumentException
- categoryQueryInspector
is null
UnsupportedException
- categoryQueryInspector
is not of this servicemandatory
- This method must be implemented.