Interface RelationshipSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RelationshipQuerySession

public interface RelationshipSearchSession
extends RelationshipQuerySession

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

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

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

Method Summary

Modifier and Type	Method	Description
RelationshipQuery	getRelationshipQueryFromInspector(RelationshipQueryInspector relationshipQueryInspector)	Gets a relationship query from an inspector.
RelationshipSearchResults	getRelationshipsBySearch(RelationshipQuery relationshipQuery, RelationshipSearch relationshipSearch)	Gets the search results matching the given search query using the given search.
RelationshipSearch	getRelationshipSearch()	Gets a relationship search.
RelationshipSearchOrder	getRelationshipSearchOrder()	Gets a relationship 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 RelationshipQuerySession

canSearchRelationships, getFamily, getFamilyId, getRelationshipQuery, getRelationshipsByQuery, useFederatedFamilyView, useIsolatedFamilyView

Modifier and Type	Method	Description
boolean	canSearchRelationships()	Tests if this user can perform Relationship searches.
Family	getFamily()	Gets the Family associated with this session.
Id	getFamilyId()	Gets the Family Id associated with this session.
RelationshipQuery	getRelationshipQuery()	Gets a relationship query.
RelationshipList	getRelationshipsByQuery(RelationshipQuery relationshipQuery)	Gets a list of Relationships matching the given relationship query.
void	useFederatedFamilyView()	Federates the view for methods in this session.
void	useIsolatedFamilyView()	Isolates the view for methods in this session.

Method Details

getRelationshipSearch

RelationshipSearch getRelationshipSearch()

Gets a relationship search.

Returns:

the relationship search

Compliance:

mandatory - This method must be implemented.

getRelationshipSearchOrder

RelationshipSearchOrder getRelationshipSearchOrder()

Gets a relationship search order. The RelationshipSearchOrder is supplied to a RelationshipSearch to specify the ordering of results.

Returns:

the relationship search order

Compliance:

mandatory - This method must be implemented.

getRelationshipsBySearch

RelationshipSearchResults getRelationshipsBySearch(RelationshipQuery relationshipQuery,
 RelationshipSearch relationshipSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

relationshipQuery - the relationship query

relationshipSearch - the relationship search

Returns:

the returned search results

Throws:

NullArgumentException - relationshipQuery or relationshipSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - relationshipQuery or relationshipSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRelationshipQueryFromInspector

RelationshipQuery getRelationshipQueryFromInspector(RelationshipQueryInspector relationshipQueryInspector)

Gets a relationship query from an inspector. The inspector is available from a RelationshipSearchResults .

Parameters:

relationshipQueryInspector - a relationship query inspector

Returns:

the relationship query

Throws:

NullArgumentException - relationshipQueryInspector is null

UnsupportedException - relationshipQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.