public interface ActivitySmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ActivityQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of Activities.
The activities may be sequenced
using the ActivitySearchOrder
from this session.
This Business
has a default query that matches any
activity and a default search order that specifies no sequencing. The
queries may be examined using an ActivityQueryInspector.
The query may be modified by converting the inspector back to an
ActivityQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyActivityQuery(ActivityQuery activityQuery)
Applies an activity query to this business.
|
void |
applyActivitySequencing(ActivitySearchOrder activitySearchOrder)
Applies an activity search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
ActivityQuery |
getActivityQuery()
Gets an activity query.
|
ActivityQuery |
getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)
Gets an activity query from an inspector.
|
ActivitySearchOrder |
getActivitySearchOrder()
Gets an activity search order.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
ActivityQueryInspector |
inspectActivityQuery()
Gets an activity 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. ActivityQuery getActivityQuery()
mandatory
- This method must be implemented. ActivitySearchOrder getActivitySearchOrder()
mandatory
- This method must be implemented. void applyActivityQuery(ActivityQuery activityQuery) throws OperationFailedException, PermissionDeniedException
activityQuery
- the activity queryNullArgumentException
- activityQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activityQuery
not
of this servicemandatory
- This method must be implemented. ActivityQueryInspector inspectActivityQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyActivitySequencing(ActivitySearchOrder activitySearchOrder) throws OperationFailedException, PermissionDeniedException
activitySearchOrder
- the activity search orderNullArgumentException
- activitySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activitySearchOrder
not of this servicemandatory
- This method must be implemented. ActivityQuery getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)
activityQueryInspector
- a query inspectorNullArgumentException
- activityQueryInspector
is null
UnsupportedException
- activityQueryInspector
is not of this servicemandatory
- This method must be implemented.