Interface EffortSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EffortQuerySession, OsidSession, OsidSession

public interface EffortSearchSession
extends EffortQuerySession

This session provides methods for searching among Effort objects. The search query is constructed using the EffortQuery .

getEffortsByQuery() is the basic search method and returns a list of Efforts . A more advanced search may be performed with getEffortsBySearch() .It accepts an EffortSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEffortsBySearch() returns an EffortSearchResults that can be used to access the resulting EffortList or be used to perform a search within the result set through EffortSearch .

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include efforts in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to efforts in this foundry

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

Method Summary

Modifier and Type	Method	Description
EffortQuery	getEffortQueryFromInspector(EffortQueryInspector effortQueryInspector)	Gets an effort query from an inspector.
EffortSearchResults	getEffortsBySearch(EffortQuery effortQuery, EffortSearch effortSearch)	Gets the search results matching the given search query using the given search.
EffortSearch	getEffortSearch()	Gets an effort search.
EffortSearchOrder	getEffortSearchOrder()	Gets an effort search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EffortQuerySession

canSearchEfforts, getEffortQuery, getEffortsByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchEfforts()	Tests if this user can perform Effort lookups.
EffortQuery	getEffortQuery()	Gets an effort query.
EffortList	getEffortsByQuery(EffortQuery effortQuery)	Gets a list of Efforts matching the given effort query.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	useFederatedFoundryView()	Federates the view for methods in this session.
void	useIsolatedFoundryView()	Isolates the view for methods in this session.

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

getEffortSearch

EffortSearch getEffortSearch()

Gets an effort search.

Returns:

the effort search

Compliance:

mandatory - This method must be implemented.

getEffortSearchOrder

EffortSearchOrder getEffortSearchOrder()

Gets an effort search order. The EffortSearchOrder is supplied to an EffortSearch to specify the ordering of results.

Returns:

the effort search order

Compliance:

mandatory - This method must be implemented.

getEffortsBySearch

EffortSearchResults getEffortsBySearch(EffortQuery effortQuery,
 EffortSearch effortSearch)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

effortQuery - the effort query

effortSearch - the effort search

Returns:

the returned search results

Throws:

NullArgumentException - effortQuery or effortSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - effortQuery or effortSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEffortQueryFromInspector

EffortQuery getEffortQueryFromInspector(EffortQueryInspector effortQueryInspector)

Gets an effort query from an inspector. The inspector is available from an EffortSearchResults .

Parameters:

effortQueryInspector - an effort query inspector

Returns:

the effort query

Throws:

NullArgumentException - effortQueryInspector is null

UnsupportedException - effortQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.