Interface OsidExtensibleQuery

All Superinterfaces:

Extensible, OsidQuery, Suppliable

All Known Subinterfaces:

AcademyQuery, AccountQuery, ActionEnablerQuery, ActionGroupQuery, ActionQuery, ActivityQuery, ActivityQuery, ActivityQuery, ActivityRegistrationQuery, ActivityUnitQuery, AddressBookQuery, AddressQuery, AgencyQuery, AgendaQuery, AgentQuery, AnswerQuery, AntimatroidQuery, AppointmentQuery, AssessmentEntryQuery, AssessmentOfferedQuery, AssessmentPartQuery, AssessmentQuery, AssessmentTakenQuery, AssetContentQuery, AssetQuery, AuctionConstrainerEnablerQuery, AuctionConstrainerQuery, AuctionHouseQuery, AuctionProcessorEnablerQuery, AuctionProcessorQuery, AuctionQuery, AuditConstrainerEnablerQuery, AuditConstrainerQuery, AuditEnablerQuery, AuditProcessorEnablerQuery, AuditProcessorQuery, AuditQuery, AuthorizationEnablerQuery, AuthorizationQuery, AvailabilityEnablerQuery, AvailabilityQuery, AwardEntryQuery, AwardQuery, BallotConstrainerEnablerQuery, BallotConstrainerQuery, BallotQuery, BankQuery, BidEnablerQuery, BidQuery, BillingQuery, BinQuery, BlockQuery, BlogQuery, BookQuery, BranchQuery, BrokerConstrainerEnablerQuery, BrokerConstrainerQuery, BrokerEnablerQuery, BrokerProcessorEnablerQuery, BrokerProcessorQuery, BrokerQuery, BudgetEntryQuery, BudgetQuery, BuildingQuery, BusinessQuery, BusinessQuery, CalendarQuery, CampusQuery, CandidateQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorQuery, CanonicalUnitQuery, CatalogEnablerQuery, CatalogQuery, CatalogueQuery, CategoryQuery, ChainQuery, ChecklistQuery, CheckQuery, CommentQuery, CommissionEnablerQuery, CommissionQuery, CommitmentEnablerQuery, CommitmentQuery, CompetencyQuery, CompositionEnablerQuery, CompositionQuery, ConferralQuery, ConfigurationQuery, ContactEnablerQuery, ContactQuery, ControllerQuery, ConvocationQuery, CookbookQuery, CourseCatalogQuery, CourseEntryQuery, CourseOfferingQuery, CourseQuery, CourseRegistrationQuery, CourseRequirementQuery, CredentialEntryQuery, CredentialQuery, CreditQuery, CustomerQuery, CyclicEventQuery, CyclicTimePeriodQuery, DeedQuery, DemographicEnablerQuery, DemographicQuery, DepotQuery, DeviceEnablerQuery, DeviceQuery, DictionaryQuery, DirectionQuery, DirectoryEntryQuery, DirectoryQuery, DispatchConstrainerEnablerQuery, DispatchConstrainerQuery, DispatchEnablerQuery, DispatchProcessorEnablerQuery, DispatchProcessorQuery, DispatchQuery, DistributorQuery, DocetQuery, EdgeEnablerQuery, EdgeQuery, EffortQuery, EngineQuery, EngineQuery, EnrollmentQuery, EntryQuery, EntryQuery, EntryQuery, EntryQuery, EventQuery, FamilyQuery, FileQuery, FiscalPeriodQuery, FloorQuery, ForumQuery, FoundryQuery, FrontOfficeQuery, FunctionQuery, GradebookColumnQuery, GradebookColumnSummaryQuery, GradebookQuery, GradeEntryQuery, GradeQuery, GradeSystemQuery, GraphQuery, HierarchyQuery, HoldEnablerQuery, HoldQuery, IdiomQuery, IngredientQuery, InputEnablerQuery, InputQuery, InquestQuery, InquiryEnablerQuery, InquiryQuery, InstallationContentQuery, InstallationQuery, InstructionQuery, IntersectionQuery, InventoryQuery, IssueConstrainerEnablerQuery, IssueConstrainerQuery, IssueEnablerQuery, IssueProcessorEnablerQuery, IssueProcessorQuery, IssueQuery, IssueQuery, ItemQuery, ItemQuery, ItemQuery, ItemQuery, JobConstrainerEnablerQuery, JobConstrainerQuery, JobProcessorEnablerQuery, JobProcessorQuery, JobQuery, JournalEntryQuery, JournalQuery, KeyQuery, LeaseQuery, LessonQuery, LocationQuery, LogEntryQuery, LogEntryQuery, LogQuery, MailboxQuery, MapQuery, MessageQuery, MeterQuery, ModelQuery, ModuleQuery, NodeQuery, ObjectiveBankQuery, ObjectiveQuery, ObstacleEnablerQuery, ObstacleQuery, OfferingConstrainerEnablerQuery, OfferingConstrainerQuery, OfferingQuery, OfficeQuery, OffsetEventEnablerQuery, OffsetEventQuery, OntologyQuery, OrderQuery, OrganizationQuery, OsidCatalogQuery, OsidCompendiumQuery, OsidConstrainerQuery, OsidEffectuatorQuery, OsidEnablerQuery, OsidGovernatorQuery, OsidObjectQuery, OsidOperatorQuery, OsidProcessorQuery, OsidRelationshipQuery, OsidRequestQuery, OsidRuleApplicatorQuery, OsidRuleQuery, OublietteQuery, PackageQuery, ParameterProcessorEnablerQuery, ParameterProcessorQuery, ParameterQuery, ParameterQuery, ParticipantQuery, PathQuery, PathQuery, PayerQuery, PaymentQuery, PeriodQuery, PersonQuery, PlanQuery, PollsQuery, PoolConstrainerEnablerQuery, PoolConstrainerQuery, PoolEnablerQuery, PoolProcessorEnablerQuery, PoolProcessorQuery, PoolQuery, PositionQuery, PostEntryQuery, PostQuery, PostQuery, PressQuery, PriceEnablerQuery, PriceQuery, PriceScheduleQuery, ProcedureQuery, ProcessConstrainerEnablerQuery, ProcessConstrainerQuery, ProcessEnablerQuery, ProcessProcessorEnablerQuery, ProcessProcessorQuery, ProcessQuery, ProcessQuery, ProductQuery, ProficiencyQuery, ProfileEntryEnablerQuery, ProfileEntryQuery, ProfileItemQuery, ProfileQuery, ProgramEntryQuery, ProgramOfferingQuery, ProgramQuery, ProjectQuery, ProvisionableEnablerQuery, ProvisionableQuery, ProvisionEnablerQuery, ProvisionQuery, ProvisionReturnQuery, PublisherQuery, QualifierQuery, QuestionQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerQuery, QueueConstrainerQuery, QueueEnablerQuery, QueueEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorQuery, QueueProcessorQuery, QueueQuery, QueueQuery, RaceConstrainerEnablerQuery, RaceConstrainerQuery, RaceProcessorEnablerQuery, RaceProcessorQuery, RaceQuery, RealmQuery, ReceiptQuery, RecipeQuery, RecurringEventEnablerQuery, RecurringEventQuery, RegistrationQuery, RegistrationRequestItemQuery, RegistrationRequestQuery, RegistrationTargetQuery, RelationshipEnablerQuery, RelationshipQuery, RelevancyEnablerQuery, RelevancyQuery, RenovationQuery, ReplyQuery, RepositoryQuery, RequestQuery, RequestTransactionQuery, RequisiteQuery, ResourceQuery, ResourceRelationshipQuery, ResponseQuery, ResultQuery, RoomQuery, RouteQuery, RouteSegmentQuery, RuleQuery, SceneQuery, ScheduleQuery, ScheduleSlotQuery, SequenceRuleEnablerQuery, SequenceRuleQuery, SettingQuery, ShipmentQuery, SignalEnablerQuery, SignalQuery, SiteQuery, SpeedZoneEnablerQuery, SpeedZoneQuery, StateQuery, StatisticQuery, StepConstrainerEnablerQuery, StepConstrainerQuery, StepEnablerQuery, StepProcessorEnablerQuery, StepProcessorQuery, StepQuery, StockQuery, StoreQuery, SubjectQuery, SubscriptionEnablerQuery, SubscriptionQuery, SummaryQuery, SupersedingEventEnablerQuery, SupersedingEventQuery, SyllabusQuery, SystemQuery, TermQuery, TextQuery, TimePeriodQuery, TodoProducerQuery, TodoQuery, TriggerEnablerQuery, TriggerQuery, UtilityQuery, ValueEnablerQuery, ValueQuery, VaultQuery, VoteEnablerQuery, VoteQuery, WarehouseQuery, WorkflowEventQuery, WorkQuery, WorkQuery

public interface OsidExtensibleQuery
extends OsidQuery, Extensible

The OsidExtensibleQuery is used to assemble search queries for Extensible objects. An OsidExtensibleQuery is available from an OsidQuerySession and defines methods to match objects. Once the desired parameters are set, the OsidExtensibleQuery is given to the designated search method. The same OsidExtensibleQuery returned from the session must be used in the search as the provider may utilize implementation-specific data wiithin the object.

If multiple data elements are set in this interface, the results matching all the given data (eg: AND) are returned.

Method Summary

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchRecordType

void matchRecordType(Type recordType,
 boolean match)

Sets a Type for querying objects having records implementing a given record type.

Parameters:

recordType - a record type

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - recordType is null

Compliance:

mandatory - This method must be implemented.

matchAnyRecord

void matchAnyRecord(boolean match)

Matches an object that has any record.

Parameters:

match - true to match any record, false to match objects with no records

Compliance:

mandatory - This method must be implemented.

clearRecordTerms

void clearRecordTerms()

Clears all record Type terms.

Compliance:

mandatory - This method must be implemented.