OSID - osid.OsidEnablerQuery Service Interface Definition

Interface	osid.OsidEnablerQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidTemporalQuery`
Implemented By	`osid.repository.rules.CompositionEnablerQuery`
	`osid.assessment.authoring.SequenceRuleEnablerQuery`
	`osid.configuration.rules.ValueEnablerQuery`
	`osid.configuration.rules.ParameterProcessorEnablerQuery`
	`osid.profile.rules.ProfileEntryEnablerQuery`
	`osid.bidding.rules.AuctionConstrainerEnablerQuery`
	`osid.bidding.rules.AuctionProcessorEnablerQuery`
	`osid.bidding.rules.BidEnablerQuery`
	`osid.cataloging.rules.CatalogEnablerQuery`
	`osid.contact.rules.ContactEnablerQuery`
	`osid.voting.rules.RaceConstrainerEnablerQuery`
	`osid.voting.rules.RaceProcessorEnablerQuery`
	`osid.voting.rules.BallotConstrainerEnablerQuery`
	`osid.voting.rules.VoteEnablerQuery`
	`osid.subscription.rules.DispatchEnablerQuery`
	`osid.subscription.rules.DispatchConstrainerEnablerQuery`
	`osid.subscription.rules.DispatchProcessorEnablerQuery`
	`osid.subscription.rules.SubscriptionEnablerQuery`
	`osid.hold.rules.IssueEnablerQuery`
	`osid.hold.rules.IssueConstrainerEnablerQuery`
	`osid.hold.rules.IssueProcessorEnablerQuery`
	`osid.hold.rules.HoldEnablerQuery`
	`osid.OsidOperatorQuery`
	`osid.OsidEffectuatorQuery`
	`osid.OsidRuleApplicatorQuery`
	`osid.control.rules.DeviceEnablerQuery`
	`osid.control.rules.InputEnablerQuery`
	`osid.control.rules.TriggerEnablerQuery`
	`osid.control.rules.ActionEnablerQuery`
	`osid.resource.demographic.DemographicEnablerQuery`
	`osid.calendaring.rules.RecurringEventEnablerQuery`
	`osid.calendaring.rules.OffsetEventEnablerQuery`
	`osid.calendaring.rules.SupersedingEventEnablerQuery`
	`osid.calendaring.rules.CommitmentEnablerQuery`
	`osid.ontology.rules.RelevancyEnablerQuery`
	`osid.workflow.rules.ProcessEnablerQuery`
	`osid.workflow.rules.ProcessConstrainerEnablerQuery`
	`osid.workflow.rules.ProcessProcessorEnablerQuery`
	`osid.workflow.rules.StepEnablerQuery`
	`osid.workflow.rules.StepConstrainerEnablerQuery`
	`osid.workflow.rules.StepProcessorEnablerQuery`
	`osid.topology.rules.EdgeEnablerQuery`
	`osid.course.requisite.RequisiteQuery`
	`osid.offering.rules.CanonicalUnitEnablerQuery`
	`osid.offering.rules.CanonicalUnitProcessorEnablerQuery`
	`osid.offering.rules.OfferingConstrainerEnablerQuery`
	`osid.ordering.rules.PriceEnablerQuery`
	`osid.inquiry.rules.AuditEnablerQuery`
	`osid.inquiry.rules.AuditConstrainerEnablerQuery`
	`osid.inquiry.rules.AuditProcessorEnablerQuery`
	`osid.inquiry.rules.InquiryEnablerQuery`
	`osid.relationship.rules.RelationshipEnablerQuery`
	`osid.provisioning.rules.BrokerEnablerQuery`
	`osid.provisioning.rules.BrokerConstrainerEnablerQuery`
	`osid.provisioning.rules.BrokerProcessorEnablerQuery`
	`osid.provisioning.rules.QueueEnablerQuery`
	`osid.provisioning.rules.QueueConstrainerEnablerQuery`
	`osid.provisioning.rules.QueueProcessorEnablerQuery`
	`osid.provisioning.rules.PoolEnablerQuery`
	`osid.provisioning.rules.PoolConstrainerEnablerQuery`
	`osid.provisioning.rules.PoolProcessorEnablerQuery`
	`osid.provisioning.rules.ProvisionableEnablerQuery`
	`osid.provisioning.rules.ProvisionEnablerQuery`
	`osid.tracking.rules.QueueEnablerQuery`
`osid.tracking.rules.QueueConstrainerEnablerQuery`
`osid.tracking.rules.QueueProcessorEnablerQuery`
`osid.resourcing.rules.AvailabilityEnablerQuery`
`osid.resourcing.rules.CommissionEnablerQuery`
`osid.resourcing.rules.JobConstrainerEnablerQuery`
`osid.resourcing.rules.JobProcessorEnablerQuery`
`osid.mapping.path.rules.SpeedZoneEnablerQuery`
`osid.mapping.path.rules.SignalEnablerQuery`
`osid.mapping.path.rules.ObstacleEnablerQuery`
Description	This is the query interface for searching enablers. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRequirement
Description	Matches enablers that are requirements,
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRequirement
Description	Match `OsidEnablers` with any requirement flag set.
Parameters	`boolean`	`match`	`true` to match any requirement setting, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearRequirementTerms
Description	Clears all requirement terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScheduleId
Description	Match the `Id` of an associated schedule.
Parameters	`osid.id.Id`	`scheduleId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`scheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleIdTerms
Description	Clears all schedule `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleQuery
Description	Tests if a `ScheduleQuery` for the rule is available.
Return	`boolean`		`true` if a schedule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleQuery
Description	Gets the query for the schedule. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.calendaring.ScheduleQuery`		the schedule query
Errors	UNIMPLEMENTED		`supportsScheduleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleQuery()` is `true`.
Method	matchAnySchedule
Description	Match any associated schedule.
Parameters	`boolean`	`match`	`true` to match any schedule, `false` to match no schedules
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleTerms
Description	Clears all schedule terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEventId
Description	Match the `Id` of an associated event.
Parameters	`osid.id.Id`	`eventId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEventIdTerms
Description	Clears all event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventQuery
Description	Tests if a `EventQuery` for the rule is available.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventQuery
Description	Gets the query for the event. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventQuery()` is `true`.
Method	matchAnyEvent
Description	Match any associated event.
Parameters	`boolean`	`match`	`true` to match any event, `false` to match no events
Compliance	`mandatory`		This method must be implemented.
Method	clearEventTerms
Description	Clears all recurirng event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCyclicEventId
Description	Sets the cyclic event `Id` for this query.
Parameters	`osid.id.Id`	`cyclicEventId`	the cyclic event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventIdTerms
Description	Clears the cyclic event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventQuery
Description	Tests if a `CyclicEventQuery` is available.
Return	`boolean`		`true` if a cyclic event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventQuery
Description	Gets the query for a cyclic event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	UNIMPLEMENTED		`supportsCyclicEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventQuery()` is `true`.
Method	matchAnyCyclicEvent
Description	Matches any enabler with a cyclic event.
Parameters	`boolean`	`match`	`true` to match any enablers with a cyclic event, `false` to match enablers with no cyclic events
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventTerms
Description	Clears the cyclic event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimePeriodId
Description	Sets the time period `Id` for this query.
Parameters	`osid.id.Id`	`timePeriodId`	the time period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodIdTerms
Description	Clears the time period `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodQuery
Description	Tests if a `TimePeriod` query is available.
Return	`boolean`		`true` if a time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQuery
Description	Gets the query for a time period. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Errors	UNIMPLEMENTED		`supportsTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodQuery()` is `true`.
Method	matchAnyTimePeriod
Description	Matches any enabler with a time period.
Parameters	`boolean`	`match`	`true` to match any enablers with a time period, `false` to match enablers with no time period
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodTerms
Description	Clears the time period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCyclicTimePeriodId
Description	Sets the cyclic time period `Id` for this query.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	the cyclic time period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicTmePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicTimePeriodIdTerms
Description	Clears the cyclic time period `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodQuery
Description	Tests if a `CyclicTimePeriod` query is available.
Return	`boolean`		`true` if a cyclic time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodQuery
Description	Gets the query for a cyclic time period. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query
Errors	UNIMPLEMENTED		`supportsCyclicTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicTimePeriodQuery()` is `true`.
Method	matchAnyCyclicTimePeriod
Description	Matches any enabler with a cyclic time period.
Parameters	`boolean`	`match`	`true` to match any enablers with a cyclic time period, `false` to match enablers with no cyclic time period
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicTimePeriodTerms
Description	Clears the cyclic time period query terms.
Compliance	`mandatory`		This method must be implemented.