Interface ResourceRelationshipSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ResourceRelationshipSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ResourceRelationshipQueryInspector	getResourceRelationshipQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ResourceRelationshipList	getResourceRelationships()	Gets the resource relationship list resulting from the search.
ResourceRelationshipSearchResultsRecord	getResourceRelationshipSearchResultsRecord(Type resourceRelationshipSearchRecordType)	Gets the resource relationship search results record corresponding to the given resource relationship search record Type .

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

getResourceRelationships

ResourceRelationshipList getResourceRelationships()

Gets the resource relationship list resulting from the search.

Returns:

the resource relationship list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipQueryInspector

ResourceRelationshipQueryInspector getResourceRelationshipQueryInspector()

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

Returns:

the resource relationship query inspector

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipSearchResultsRecord

ResourceRelationshipSearchResultsRecord getResourceRelationshipSearchResultsRecord(Type resourceRelationshipSearchRecordType)
                                                                            throws OperationFailedException

Gets the resource relationship search results record corresponding to the given resource relationship search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

resourceRelationshipSearchRecordType - a resource relationship search record type

Returns:

the resource relationship search results record

Throws:

NullArgumentException - resourceRelationshipSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.