OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidSearch
Implementsosid.OsidCondition
Implemented Byosid.course.CourseSearch
osid.course.ActivityUnitSearch
osid.course.CourseOfferingSearch
osid.course.ActivitySearch
osid.course.TermSearch
osid.course.CourseCatalogSearch
osid.repository.rules.CompositionEnablerSearch
osid.assessment.authoring.AssessmentPartSearch
osid.assessment.authoring.SequenceRuleSearch
osid.assessment.authoring.SequenceRuleEnablerSearch
osid.configuration.rules.ValueEnablerSearch
osid.configuration.rules.ParameterProcessorSearch
osid.configuration.rules.ParameterProcessorEnablerSearch
osid.ordering.OrderSearch
osid.ordering.ProductSearch
osid.ordering.PriceScheduleSearch
osid.ordering.StoreSearch
osid.topology.NodeSearch
osid.topology.EdgeSearch
osid.topology.GraphSearch
osid.inventory.shipment.ShipmentSearch
osid.inventory.shipment.EntrySearch
osid.authentication.keys.KeySearch
osid.profile.rules.ProfileEntryEnablerSearch
osid.bidding.rules.AuctionConstrainerSearch
osid.bidding.rules.AuctionConstrainerEnablerSearch
osid.bidding.rules.AuctionProcessorSearch
osid.bidding.rules.AuctionProcessorEnablerSearch
osid.bidding.rules.BidEnablerSearch
osid.financials.AccountSearch
osid.financials.ActivitySearch
osid.financials.FiscalPeriodSearch
osid.financials.BusinessSearch
osid.workflow.event.WorkflowEventSearch
osid.authentication.AgentSearch
osid.authentication.AgencySearch
osid.relationship.RelationshipSearch
osid.relationship.FamilySearch
osid.contact.ContactSearch
osid.contact.AddressSearch
osid.contact.AddressBookSearch
osid.provisioning.ProvisionSearch
osid.provisioning.QueueSearch
osid.provisioning.RequestSearch
osid.provisioning.RequestTransactionSearch
osid.provisioning.PoolSearch
osid.provisioning.ProvisionableSearch
osid.provisioning.BrokerSearch
osid.provisioning.DistributorSearch
osid.cataloging.rules.CatalogEnablerSearch
osid.hold.BlockSearch
osid.hold.IssueSearch
osid.hold.HoldSearch
osid.hold.OublietteSearch
osid.contact.rules.ContactEnablerSearch
osid.voting.rules.RaceConstrainerSearch
osid.voting.rules.RaceConstrainerEnablerSearch
osid.voting.rules.RaceProcessorSearch
osid.voting.rules.RaceProcessorEnablerSearch
osid.voting.rules.BallotConstrainerSearch
osid.voting.rules.BallotConstrainerEnablerSearch
osid.voting.rules.VoteEnablerSearch
osid.subscription.SubscriptionSearch
osid.subscription.DispatchSearch
osid.subscription.PublisherSearch
osid.subscription.rules.DispatchEnablerSearch
osid.subscription.rules.DispatchConstrainerSearch
osid.subscription.rules.DispatchConstrainerEnablerSearch
osid.subscription.rules.DispatchProcessorSearch
osid.subscription.rules.DispatchProcessorEnablerSearch
osid.subscription.rules.SubscriptionEnablerSearch
osid.filing.FileSearch
osid.filing.DirectorySearch
osid.hierarchy.HierarchySearch
osid.hold.rules.IssueEnablerSearch
osid.hold.rules.IssueConstrainerSearch
osid.hold.rules.IssueConstrainerEnablerSearch
osid.hold.rules.IssueProcessorSearch
osid.hold.rules.IssueProcessorEnablerSearch
osid.hold.rules.HoldEnablerSearch
osid.forum.PostSearch
osid.forum.ReplySearch
osid.forum.ForumSearch
osid.authorization.AuthorizationSearch
osid.authorization.FunctionSearch
osid.authorization.QualifierSearch
osid.authorization.VaultSearch
osid.control.rules.DeviceEnablerSearch
osid.control.rules.InputEnablerSearch
osid.control.rules.TriggerEnablerSearch
osid.control.rules.ActionEnablerSearch
osid.resource.demographic.DemographicSearch
osid.resource.demographic.DemographicEnablerSearch
osid.lexicon.TextSearch
osid.lexicon.IdiomSearch
osid.lexicon.ParameterSearch
osid.lexicon.PressSearch
osid.inventory.ItemSearch
osid.inventory.StockSearch
osid.inventory.ModelSearch
osid.inventory.InventorySearch
osid.inventory.WarehouseSearch
osid.calendaring.cycle.CyclicEventSearch
osid.calendaring.cycle.CyclicTimePeriodSearch
osid.learning.ObjectiveSearch
osid.learning.ActivitySearch
osid.learning.ProficiencySearch
osid.learning.ObjectiveBankSearch
osid.installation.InstallationPackageSearch
osid.installation.DepotSearch
osid.installation.InstallationSearch
osid.cataloging.CatalogSearch
osid.messaging.MessageSearch
osid.messaging.MailboxSearch
osid.checklist.mason.TodoProducerSearch
osid.calendaring.rules.RecurringEventEnablerSearch
osid.calendaring.rules.OffsetEventEnablerSearch
osid.calendaring.rules.SupersedingEventEnablerSearch
osid.calendaring.rules.CommitmentEnablerSearch
osid.search.Search
osid.search.EngineSearch
osid.room.construction.RenovationSearch
osid.room.construction.ProjectSearch
osid.recognition.ConferralSearch
osid.recognition.AwardSearch
osid.recognition.ConvocationSearch
osid.recognition.AcademySearch
osid.grading.GradeSearch
osid.grading.GradeSystemSearch
osid.grading.GradeEntrySearch
osid.grading.GradebookColumnSearch
osid.grading.GradebookSearch
osid.ontology.rules.RelevancyEnablerSearch
osid.room.squatting.LeaseSearch
osid.room.squatting.DeedSearch
osid.resourcing.JobSearch
osid.resourcing.WorkSearch
osid.resourcing.CompetencySearch
osid.resourcing.AvailabilitySearch
osid.resourcing.CommissionSearch
osid.resourcing.EffortSearch
osid.resourcing.FoundrySearch
osid.financials.budgeting.BudgetSearch
osid.financials.budgeting.BudgetEntrySearch
osid.rules.check.AgendaSearch
osid.rules.check.InstructionSearch
osid.rules.check.CheckSearch
osid.course.plan.PlanSearch
osid.course.plan.LessonSearch
osid.repository.AssetSearch
osid.repository.AssetContentSearch
osid.repository.CompositionSearch
osid.repository.RepositorySearch
osid.bidding.AuctionSearch
osid.bidding.BidSearch
osid.bidding.AuctionHouseSearch
osid.workflow.rules.ProcessEnablerSearch
osid.workflow.rules.ProcessConstrainerSearch
osid.workflow.rules.ProcessConstrainerEnablerSearch
osid.workflow.rules.ProcessProcessorSearch
osid.workflow.rules.ProcessProcessorEnablerSearch
osid.workflow.rules.StepEnablerSearch
osid.workflow.rules.StepConstrainerSearch
osid.workflow.rules.StepConstrainerEnablerSearch
osid.workflow.rules.StepProcessorSearch
osid.workflow.rules.StepProcessorEnablerSearch
osid.topology.rules.EdgeEnablerSearch
osid.profile.ProfileEntrySearch
osid.profile.ProfileItemSearch
osid.profile.ProfileSearch
osid.recipe.RecipeSearch
osid.recipe.DirectionSearch
osid.recipe.ProcedureSearch
osid.recipe.CookbookSearch
osid.course.registration.RegistrationTargetSearch
osid.course.registration.RegistrationSearch
osid.course.registration.CourseRegistrationSearch
osid.course.registration.ActivityRegistrationSearch
osid.tracking.IssueSearch
osid.tracking.QueueSearch
osid.tracking.FrontOfficeSearch
osid.course.requisite.RequisiteSearch
osid.mapping.route.RouteSearch
osid.journaling.JournalEntrySearch
osid.journaling.BranchSearch
osid.journaling.JournalSearch
osid.offering.CanonicalUnitSearch
osid.offering.OfferingSearch
osid.offering.ParticipantSearch
osid.offering.ResultSearch
osid.offering.CatalogueSearch
osid.mapping.LocationSearch
osid.mapping.MapSearch
osid.assessment.ItemSearch
osid.assessment.AssessmentSearch
osid.assessment.AssessmentOfferedSearch
osid.assessment.AssessmentTakenSearch
osid.assessment.BankSearch
osid.blogging.EntrySearch
osid.blogging.BlogSearch
osid.voting.VoteSearch
osid.voting.CandidateSearch
osid.voting.RaceSearch
osid.voting.BallotSearch
osid.voting.PollsSearch
osid.calendaring.EventSearch
osid.calendaring.RecurringEventSearch
osid.calendaring.SupersedingEventSearch
osid.calendaring.OffsetEventSearch
osid.calendaring.ScheduleSearch
osid.calendaring.ScheduleSlotSearch
osid.calendaring.TimePeriodSearch
osid.calendaring.CommitmentSearch
osid.calendaring.CalendarSearch
osid.offering.rules.CanonicalUnitEnablerSearch
osid.offering.rules.CanonicalUnitProcessorSearch
osid.offering.rules.CanonicalUnitProcessorEnablerSearch
osid.offering.rules.OfferingConstrainerSearch
osid.offering.rules.OfferingConstrainerEnablerSearch
osid.ordering.rules.PriceEnablerSearch
osid.metering.StatisticSearch
osid.metering.MeterSearch
osid.metering.UtilitySearch
osid.commenting.CommentSearch
osid.commenting.BookSearch
osid.dictionary.EntrySearch
osid.dictionary.DictionarySearch
osid.inquiry.rules.AuditEnablerSearch
osid.inquiry.rules.AuditConstrainerSearch
osid.inquiry.rules.AuditConstrainerEnablerSearch
osid.inquiry.rules.AuditProcessorSearch
osid.inquiry.rules.AuditProcessorEnablerSearch
osid.inquiry.rules.InquiryEnablerSearch
osid.configuration.ParameterSearch
osid.configuration.ValueSearch
osid.configuration.ConfigurationSearch
osid.resource.ResourceSearch
osid.resource.ResourceRelationshipSearch
osid.resource.BinSearch
osid.logging.LogEntrySearch
osid.logging.LogSearch
osid.personnel.PersonSearch
osid.personnel.OrganizationSearch
osid.personnel.PositionSearch
osid.personnel.AppointmentSearch
osid.personnel.RealmSearch
osid.relationship.rules.RelationshipEnablerSearch
osid.course.program.ProgramSearch
osid.course.program.ProgramOfferingSearch
osid.course.program.CredentialSearch
osid.course.program.EnrollmentSearch
osid.process.StateSearch
osid.process.ProcessSearch
osid.provisioning.rules.BrokerEnablerSearch
osid.provisioning.rules.BrokerConstrainerSearch
osid.provisioning.rules.BrokerConstrainerEnablerSearch
osid.provisioning.rules.BrokerProcessorSearch
osid.provisioning.rules.BrokerProcessorEnablerSearch
osid.provisioning.rules.QueueEnablerSearch
osid.provisioning.rules.QueueConstrainerSearch
osid.provisioning.rules.QueueConstrainerEnablerSearch
osid.provisioning.rules.QueueProcessorSearch
osid.provisioning.rules.QueueProcessorEnablerSearch
osid.provisioning.rules.PoolEnablerSearch
osid.provisioning.rules.PoolConstrainerSearch
osid.provisioning.rules.PoolConstrainerEnablerSearch
osid.provisioning.rules.PoolProcessorSearch
osid.provisioning.rules.PoolProcessorEnablerSearch
osid.provisioning.rules.ProvisionableEnablerSearch
osid.provisioning.rules.ProvisionEnablerSearch
osid.checklist.TodoSearch
osid.checklist.ChecklistSearch
osid.sequencing.ChainSearch
osid.sequencing.AntimatroidSearch
osid.billing.CustomerSearch
osid.billing.ItemSearch
osid.billing.CategorySearch
osid.billing.EntrySearch
osid.billing.PeriodSearch
osid.billing.BusinessSearch
osid.inquiry.InquirySearch
osid.inquiry.AuditSearch
osid.inquiry.ResponseSearch
osid.inquiry.InquestSearch
osid.course.chronicle.ProgramEntrySearch
osid.course.chronicle.CourseEntrySearch
osid.course.chronicle.CredentialEntrySearch
osid.course.chronicle.AssessmentEntrySearch
osid.course.chronicle.AwardEntrySearch
osid.authorization.rules.AuthorizationEnablerSearch
osid.transport.EndpointSearch
osid.workflow.ProcessSearch
osid.workflow.StepSearch
osid.workflow.WorkSearch
osid.workflow.OfficeSearch
osid.rules.RuleSearch
osid.rules.EngineSearch
osid.acknowledgement.CreditSearch
osid.acknowledgement.BillingSearch
osid.tracking.rules.QueueEnablerSearch
osid.tracking.rules.QueueConstrainerSearch
osid.tracking.rules.QueueConstrainerEnablerSearch
osid.tracking.rules.QueueProcessorSearch
osid.tracking.rules.QueueProcessorEnablerSearch
osid.resourcing.rules.AvailabilityEnablerSearch
osid.resourcing.rules.CommissionEnablerSearch
osid.resourcing.rules.JobConstrainerSearch
osid.resourcing.rules.JobConstrainerEnablerSearch
osid.resourcing.rules.JobProcessorSearch
osid.resourcing.rules.JobProcessorEnablerSearch
osid.billing.payment.PayerSearch
osid.billing.payment.PaymentSearch
osid.room.RoomSearch
osid.room.FloorSearch
osid.room.BuildingSearch
osid.room.CampusSearch
osid.mapping.path.PathSearch
osid.mapping.path.IntersectionSearch
osid.mapping.path.SpeedZoneSearch
osid.mapping.path.SignalSearch
osid.mapping.path.ObstacleSearch
osid.mapping.path.rules.SpeedZoneEnablerSearch
osid.mapping.path.rules.SignalEnablerSearch
osid.mapping.path.rules.ObstacleEnablerSearch
osid.topology.path.PathSearch
osid.course.syllabus.SyllabusSearch
osid.course.syllabus.ModuleSearch
osid.course.syllabus.DocetSearch
osid.financials.posting.PostSearch
osid.financials.posting.PostEntrySearch
osid.course.registration.request.RegistrationRequestSearch
osid.course.registration.request.RegistrationRequestItemSearch
osid.ontology.SubjectSearch
osid.ontology.RelevancySearch
osid.ontology.OntologySearch
osid.control.DeviceSearch
osid.control.ControllerSearch
osid.control.InputSearch
osid.control.SettingSearch
osid.control.SceneSearch
osid.control.TriggerSearch
osid.control.ActionGroupSearch
osid.control.SystemSearch
Description

OsidSearch specifies search options used to perform OSID searches. An OsidSearch is available from an OsidSession and defines methods to govern the overall search of terms supplied in one or more OsidQuery interfaces.

This interface is available from a search session.Example using the search interface to retrieve the first 25 results:

OsidSearch os = session.getObjectSearch();
os.limitResultSet(1, 25);

OsidQuery query;
query = session.getObjectQuery();
query.addDescriptionMatch("*food*", wildcardStringMatchType, true);

ObjectSearchResults results = session.getObjectsBySearch(query, os);
ObjectList list = results.getObjectList();
                
MethodlimitResultSet
Description

By default, searches return all matching results. This method restricts the number of results by setting the start and end of the result set, starting from 1. The starting and ending results can be used for paging results when a certain ordering is requested. The ending position must be greater than the starting position.

Parameterscardinalstart the start of the result set
cardinalend the end of the result set
ErrorsINVALID_ARGUMENT end is less than or equal to start
Compliancemandatory This method must be implemented.