org.osid.resourcing

Interface EffortSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EffortQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.resourcing.EffortQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.