Interface PostEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PostEntryQuerySession

public interface PostEntrySearchSession
extends PostEntryQuerySession

This session provides methods for searching among PostEntries . The search query is constructed using the PostEntryQuery .

getPostEntriesByQuery() is the basic search method and returns a list of PostEntries . A more advanced search may be performed with getPostEntriesBySearch() .It accepts a PostEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPostEntriesBySearch() returns a PostEntrySearchResults that can be used to access the resulting PostEntryList or be used to perform a search within the result set through PostEntrySearch .

This session defines views that offer differing behaviors for searching.

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

Post entries may have a query record indicated by their respective record types. The query record is accessed via the PostEntryQuery .

Method Summary

Modifier and Type	Method	Description
PostEntrySearchResults	getPostEntriesBySearch(PostEntryQuery postEntryQuery, PostEntrySearch postEntrySearch)	Gets the search results matching the given search query using the given search.
PostEntryQuery	getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)	Gets a post entry query from an inspector.
PostEntrySearch	getPostEntrySearch()	Gets a post entry search.
PostEntrySearchOrder	getPostEntrySearchOrder()	Gets a post entry search order.

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.

Methods inherited from interface PostEntryQuerySession

canSearchPostEntries, getBusiness, getBusinessId, getPostEntriesByQuery, getPostEntryQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchPostEntries()	Tests if this user can perform PostEntry lookups.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
PostEntryList	getPostEntriesByQuery(PostEntryQuery postEntryQuery)	Gets a list of PostEntries matching the given post entry query.
PostEntryQuery	getPostEntryQuery()	Gets a post entry query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

Method Details

getPostEntrySearch

PostEntrySearch getPostEntrySearch()

Gets a post entry search.

Returns:

the post entry search

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchOrder

PostEntrySearchOrder getPostEntrySearchOrder()

Gets a post entry search order. The PostEntrySearchOrder is supplied to a PostEntrySearch to specify the ordering of results.

Returns:

the post entry search order

Compliance:

mandatory - This method must be implemented.

getPostEntriesBySearch

PostEntrySearchResults getPostEntriesBySearch(PostEntryQuery postEntryQuery,
 PostEntrySearch postEntrySearch)
                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

postEntryQuery - the post entry query

postEntrySearch - the post entry search

Returns:

the post entry search results

Throws:

NullArgumentException - postEntryQuery or postEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - postEntryQuery or postEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPostEntryQueryFromInspector

PostEntryQuery getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)

Gets a post entry query from an inspector. The inspector is available from a PostEntrySearchResults .

Parameters:

postEntryQueryInspector - a post entry query inspector

Returns:

the post entry query

Throws:

NullArgumentException - postEntryQueryInspector is null

UnsupportedException - postEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.