Interface RelationshipSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RelationshipSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RelationshipQueryInspector	getRelationshipQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RelationshipList	getRelationships()	Gets the relationship list resulting from a search.
RelationshipSearchResultsRecord	getRelationshipSearchResultsRecord(Type relationshipSearchRecordType)	Gets the relationship search results record corresponding to the given relationship search record Type .This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRelationships

RelationshipList getRelationships()

Gets the relationship list resulting from a search.

Returns:

the relationship list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRelationshipQueryInspector

RelationshipQueryInspector getRelationshipQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the relationship query inspector

Compliance:

mandatory - This method must be implemented.

getRelationshipSearchResultsRecord

RelationshipSearchResultsRecord getRelationshipSearchResultsRecord(Type relationshipSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets the relationship search results record corresponding to the given relationship search record Type .This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parameters:

relationshipSearchRecordType - a relationship search record type

Returns:

the relationship search results record

Throws:

NullArgumentException - relationshipSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.