Interface RelationshipEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RelationshipEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RelationshipEnablerQueryInspector	getRelationshipEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RelationshipEnablerList	getRelationshipEnablers()	Gets the RelationshipEnablerList resulting from a search.
RelationshipEnablerSearchResultsRecord	getRelationshipEnablerSearchResultsRecord(Type relationshipEnablerSearchRecordType)	Gets the relationship enabler search results record corresponding to the given relationship enabler 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

getRelationshipEnablers

RelationshipEnablerList getRelationshipEnablers()

Gets the RelationshipEnablerList resulting from a search.

Returns:

the relationship enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerQueryInspector

RelationshipEnablerQueryInspector getRelationshipEnablerQueryInspector()

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

Returns:

the relationship enabler query inspector

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerSearchResultsRecord

RelationshipEnablerSearchResultsRecord getRelationshipEnablerSearchResultsRecord(Type relationshipEnablerSearchRecordType)
                                                                          throws OperationFailedException,
PermissionDeniedException

Gets the relationship enabler search results record corresponding to the given relationship enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

relationshipEnablerSearchRecordType - a relationship enabler search record type

Returns:

the relationship enabler search results record

Throws:

NullArgumentException - relationshipEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.