OSID - osid.OsidRelationshipQuery Service Interface Definition

Interface	osid.OsidRelationshipQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidTemporalQuery`
Implemented By	`osid.course.CourseOfferingQuery`
	`osid.course.ActivityQuery`
	`osid.ordering.ItemQuery`
	`osid.topology.EdgeQuery`
	`osid.relationship.RelationshipQuery`
	`osid.contact.ContactQuery`
	`osid.provisioning.ProvisionQuery`
	`osid.provisioning.RequestQuery`
	`osid.provisioning.RequestTransactionQuery`
	`osid.provisioning.ProvisionableQuery`
	`osid.hold.HoldQuery`
	`osid.subscription.SubscriptionQuery`
	`osid.authorization.AuthorizationQuery`
	`osid.learning.ProficiencyQuery`
	`osid.recognition.ConferralQuery`
	`osid.grading.GradeEntryQuery`
	`osid.room.squatting.LeaseQuery`
	`osid.room.squatting.DeedQuery`
	`osid.resourcing.AvailabilityQuery`
	`osid.resourcing.CommissionQuery`
	`osid.resourcing.EffortQuery`
	`osid.financials.budgeting.BudgetQuery`
	`osid.financials.budgeting.BudgetEntryQuery`
	`osid.rules.check.InstructionQuery`
	`osid.course.plan.PlanQuery`
	`osid.course.plan.LessonQuery`
	`osid.bidding.BidQuery`
	`osid.profile.ProfileEntryQuery`
	`osid.course.registration.RegistrationQuery`
	`osid.course.registration.CourseRegistrationQuery`
	`osid.course.registration.ActivityRegistrationQuery`
	`osid.tracking.IssueQuery`
	`osid.mapping.route.RouteQuery`
	`osid.offering.OfferingQuery`
	`osid.offering.ParticipantQuery`
	`osid.voting.VoteQuery`
	`osid.voting.CandidateQuery`
	`osid.calendaring.CommitmentQuery`
	`osid.commenting.CommentQuery`
	`osid.resource.ResourceRelationshipQuery`
	`osid.personnel.AppointmentQuery`
	`osid.course.program.ProgramOfferingQuery`
	`osid.course.program.EnrollmentQuery`
	`osid.billing.EntryQuery`
	`osid.inquiry.ResponseQuery`
	`osid.course.chronicle.ProgramEntryQuery`
	`osid.course.chronicle.CourseEntryQuery`
	`osid.course.chronicle.CredentialEntryQuery`
	`osid.course.chronicle.AssessmentEntryQuery`
	`osid.course.chronicle.AwardEntryQuery`
	`osid.acknowledgement.CreditQuery`
	`osid.topology.path.PathQuery`
	`osid.course.syllabus.DocetQuery`
	`osid.ontology.RelevancyQuery`
Description	This is the query interface for searching relationships. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchEndReasonId
Description	Match the `Id` of the end reason state.
Parameters	`osid.id.Id`	`stateId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ruleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEndReasonIdTerms
Description	Clears all state `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndReasonQuery
Description	Tests if a `StateQuery` for the end reason is available.
Return	`boolean`		`true` if an end reason query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndReasonQuery
Description	Gets the query for the end reason state. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.process.StateQuery`		the state query
Errors	UNIMPLEMENTED		`supportsEndReasonQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndReasonQuery()` is `true`.
Method	matchAnyEndReason
Description	Match any end reason state.
Parameters	`boolean`	`match`	`true` to match any state, `false` to match no state
Compliance	`mandatory`		This method must be implemented.
Method	clearEndReasonTerms
Description	Clears all end reason state terms.
Compliance	`mandatory`		This method must be implemented.