OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipEnablerSearchSession
Implementsosid.relationship.rules.RelationshipEnablerQuerySession
Description

This session provides methods for searching among RelationshipEnabler objects. The search query is constructed using the RelationshipEnableryQuery.

getRelationshipEnablersByQuery() is the basic search method and returns a list of RelationshipEnablers. A more advanced search may be performed with getRelationshipEnablersBySearch(). It accepts a RelationshipEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRelationshipEnablersBySearch() returns a RelationshipEnablerSearchResults that can be used to access the resulting RelationshipEnablerList or be used to perform a search within the result set through RelationshipEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated relationship view: searches include relationship enablers in relationships of which this relationship is an ancestor in the relationship hierarchy
  • isolated relationship view: searches are restricted to relationship enablers in this relationship

RelationshipEnablers may have a query record indicated by their respective record types. The query record is accessed via the RelationshipEnablerQuery.

MethodgetRelationshipEnablerSearch
Description

Gets a relationship enabler search.

Returnosid.relationship.rules.RelationshipEnablerSearchthe relationship enabler search
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerSearchOrder
Description

Gets a relationship enabler search order. The RelationshipEnablerSearchOrder is supplied to a RelationshipEnablerSearch to specify the ordering of results.

Returnosid.relationship.rules.RelationshipEnablerSearchOrderthe relationship enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.relationship.rules.RelationshipEnablerQueryrelationshipEnablerQuerythe relationship enabler query
osid.relationship.rules.RelationshipEnablerSearchrelationshipEnablerSearchthe relationship enabler search
Returnosid.relationship.rules.RelationshipEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT relationshipEnablerQuery or relationshipEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED relationshipEnablerQuery or relationshipEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelationshipEnablerQueryFromInspector
Description

Gets a relationship enabler query from an inspector. The inspector is available from a RelationshipEnablerSearchResults.

Parametersosid.relationship.rules.RelationshipEnablerQueryInspectorrelationshipEnablerQueryInspectora relationship enabler query inspector
Returnosid.relationship.rules.RelationshipEnablerQuerythe relationship enabler query
ErrorsNULL_ARGUMENT relationshipEnablerQueryInspector is null
UNSUPPORTED relationshipEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.