Interface ActivitySearchSession

All Superinterfaces:

ActivityQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActivitySearchSession
extends ActivityQuerySession

This session provides methods for searching among Activities . The search query is constructed using the ActivityQuery .

getActivitiesByQuery() is the basic search method and returns a list of Activitys . A more advanced search may be performed with getActivitysBySearch() .It accepts an ActivitySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getActivitiesBySearch() returns an ActivitySearchResults that can be used to access the resulting ActivityList or be used to perform a search within the result set through ActivitySearch .

This session defines views that offer differing behaviors for searching.

• federated business view: searches include activities in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to activities in this business

Activities may have a query record indicated by their respective record types. The query record is accessed via the ActivityQuery .

Method Summary

Modifier and Type	Method	Description
ActivitySearchResults	getActivitiesBySearch(ActivityQuery activityQuery, ActivitySearch activitySearch)	Gets the search results matching the given search query using the given search.
ActivityQuery	getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)	Gets an activity query from an inspector.
ActivitySearch	getActivitySearch()	Gets an activity search.
ActivitySearchOrder	getActivitySearchOrder()	Gets an activity search order.

Methods inherited from interface ActivityQuerySession

canSearchActivities, getActivitiesByQuery, getActivityQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getActivitySearch

ActivitySearch getActivitySearch()

Gets an activity search.

Returns:

the activity search

Compliance:

mandatory - This method must be implemented.

getActivitySearchOrder

ActivitySearchOrder getActivitySearchOrder()

Gets an activity search order. The ActivitySearchOrder is supplied to an ActivitySearch to specify the ordering of results.

Returns:

the activity search order

Compliance:

mandatory - This method must be implemented.

getActivitiesBySearch

ActivitySearchResults getActivitiesBySearch(ActivityQuery activityQuery,
 ActivitySearch activitySearch)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

activityQuery - the activity query

activitySearch - the activity search

Returns:

the activity search results

Throws:

NullArgumentException - activityQuery or activitySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - activityQuery or activitySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getActivityQueryFromInspector

ActivityQuery getActivityQueryFromInspector(ActivityQueryInspector activityQueryInspector)

Gets an activity query from an inspector. The inspector is available from an ActivitySearchResults .

Parameters:

activityQueryInspector - an activity query inspector

Returns:

the activity query

Throws:

NullArgumentException - activityQueryInspector is null

UnsupportedException - activityQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.