public interface ActivityQuerySession extends OsidSession
This session provides methods for searching among Activity
objects. The search query is constructed using the
ActivityQuery.
This session defines views that offer differing behaviors for searching.
Activities may have a query record indicated by their respective
record types. The query record is accessed via the ActivityQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchActivities()
Tests if this user can perform
Activity lookups. |
ActivityList |
getActivitiesByQuery(ActivityQuery activityQuery)
Gets a list of
Activities matching the given activity
query. |
ActivityQuery |
getActivityQuery()
Gets an activity query.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
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 canSearchActivities()
Activity
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. ActivityQuery getActivityQuery()
mandatory
- This method must be implemented. ActivityList getActivitiesByQuery(ActivityQuery activityQuery) throws OperationFailedException, PermissionDeniedException
Activities
matching the given activity
query.activityQuery
- the activity query ActivityList
NullArgumentException
- activityQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- activityQuery
is
not of this servicemandatory
- This method must be implemented.