org.osid.relationship.rules

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

Methods

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

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.