Interface | osid.relationship.rules.RelationshipEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRelationshipEnablers | ||
Description |
Gets the | ||
Return | osid.relationship.rules.RelationshipEnablerList | the relationship enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.relationship.rules.RelationshipEnablerQueryInspector | the relationship enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerSearchResultsRecord | ||
Description |
Gets the relationship enabler search results record
corresponding to the given relationship enabler search
record | ||
Parameters | osid.type.Type | relationshipEnablerSearchRecordType | a relationship enabler search record type |
Return | osid.relationship.rules.records.RelationshipEnablerSearchResultsRecord | the relationship enabler search results record | |
Errors | NULL_ARGUMENT | relationshipEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(relationshipEnablerSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |