org.osid.relationship

Interface RelationshipSearchSession

All Superinterfaces:

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

Methods

Modifier and Type	Method and 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 org.osid.relationship.RelationshipQuerySession

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

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

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.