OSID Logo
OSID Specifications
relationship rules package
Version 3.1.0
Interfaceosid.relationship.rules.RelationshipEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Used Byosid.relationship.rules.RelationshipEnablerSearchResults
osid.relationship.rules.RelationshipEnablerSmartFamilySession
Description

This is the query inspector for examining relationship enabler queries.

Like all OsidQueryInspectors, RelationshipEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetRuledRelationshipIdTerms
Description

Gets the relationship Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRuledRelationshipTerms
Description

Gets the relationship query terms.

Returnosid.relationship.RelationshipQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetFamilyIdTerms
Description

Gets the family Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetFamilyTerms
Description

Gets the family query terms.

Returnosid.relationship.FamilyQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRelationshipEnablerQueryInspectorRecord
Description

Gets the relationship enabler query inspector record corresponding to the given RelationshipEnabler record Type.

Parametersosid.type.TyperelationshipEnablerRecordType a relationship enabler record type
Returnosid.relationship.rules.records.RelationshipEnablerQueryInspectorRecord the relationship enabler query inspector record
ErrorsNULL_ARGUMENT relationshipEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(relationshipEnablerRecordType) is false
Compliancemandatory This method must be implemented.