OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidSearchResults
Implementsosid.OsidResult
Implemented Byosid.course.CourseSearchResults
osid.course.ActivityUnitSearchResults
osid.course.CourseOfferingSearchResults
osid.course.ActivitySearchResults
osid.course.TermSearchResults
osid.course.CourseCatalogSearchResults
osid.repository.rules.CompositionEnablerSearchResults
osid.assessment.authoring.AssessmentPartSearchResults
osid.assessment.authoring.SequenceRuleSearchResults
osid.assessment.authoring.SequenceRuleEnablerSearchResults
osid.configuration.rules.ValueEnablerSearchResults
osid.configuration.rules.ParameterProcessorSearchResults
osid.configuration.rules.ParameterProcessorEnablerSearchResults
osid.ordering.OrderSearchResults
osid.ordering.ProductSearchResults
osid.ordering.PriceScheduleSearchResults
osid.ordering.StoreSearchResults
osid.topology.NodeSearchResults
osid.topology.EdgeSearchResults
osid.topology.GraphSearchResults
osid.inventory.shipment.ShipmentSearchResults
osid.inventory.shipment.EntrySearchResults
osid.authentication.keys.KeySearchResults
osid.profile.rules.ProfileEntryEnablerSearchResults
osid.bidding.rules.AuctionConstrainerSearchResults
osid.bidding.rules.AuctionConstrainerEnablerSearchResults
osid.bidding.rules.AuctionProcessorSearchResults
osid.bidding.rules.AuctionProcessorEnablerSearchResults
osid.bidding.rules.BidEnablerSearchResults
osid.financials.AccountSearchResults
osid.financials.ActivitySearchResults
osid.financials.FiscalPeriodSearchResults
osid.financials.BusinessSearchResults
osid.workflow.event.WorkflowEventSearchResults
osid.authentication.AgentSearchResults
osid.authentication.AgencySearchResults
osid.relationship.RelationshipSearchResults
osid.relationship.FamilySearchResults
osid.contact.ContactSearchResults
osid.contact.AddressSearchResults
osid.contact.AddressBookSearchResults
osid.provisioning.ProvisionSearchResults
osid.provisioning.QueueSearchResults
osid.provisioning.RequestSearchResults
osid.provisioning.RequestTransactionSearchResults
osid.provisioning.PoolSearchResults
osid.provisioning.ProvisionableSearchResults
osid.provisioning.BrokerSearchResults
osid.provisioning.DistributorSearchResults
osid.cataloging.rules.CatalogEnablerSearchResults
osid.hold.BlockSearchResults
osid.hold.IssueSearchResults
osid.hold.HoldSearchResults
osid.hold.OublietteSearchResults
osid.contact.rules.ContactEnablerSearchResults
osid.voting.rules.RaceConstrainerSearchResults
osid.voting.rules.RaceConstrainerEnablerSearchResults
osid.voting.rules.RaceProcessorSearchResults
osid.voting.rules.RaceProcessorEnablerSearchResults
osid.voting.rules.BallotConstrainerSearchResults
osid.voting.rules.BallotConstrainerEnablerSearchResults
osid.voting.rules.VoteEnablerSearchResults
osid.subscription.SubscriptionSearchResults
osid.subscription.DispatchSearchResults
osid.subscription.PublisherSearchResults
osid.subscription.rules.DispatchEnablerSearchResults
osid.subscription.rules.DispatchConstrainerSearchResults
osid.subscription.rules.DispatchConstrainerEnablerSearchResults
osid.subscription.rules.DispatchProcessorSearchResults
osid.subscription.rules.DispatchProcessorEnablerSearchResults
osid.subscription.rules.SubscriptionEnablerSearchResults
osid.filing.FileSearchResults
osid.filing.DirectorySearchResults
osid.hierarchy.HierarchySearchResults
osid.hold.rules.IssueEnablerSearchResults
osid.hold.rules.IssueConstrainerSearchResults
osid.hold.rules.IssueConstrainerEnablerSearchResults
osid.hold.rules.IssueProcessorSearchResults
osid.hold.rules.IssueProcessorEnablerSearchResults
osid.hold.rules.HoldEnablerSearchResults
osid.forum.PostSearchResults
osid.forum.ReplySearchResults
osid.forum.ForumSearchResults
osid.authorization.AuthorizationSearchResults
osid.authorization.FunctionSearchResults
osid.authorization.QualifierSearchResults
osid.authorization.VaultSearchResults
osid.control.rules.DeviceEnablerSearchResults
osid.control.rules.InputEnablerSearchResults
osid.control.rules.TriggerEnablerSearchResults
osid.control.rules.ActionEnablerSearchResults
osid.resource.demographic.DemographicSearchResults
osid.resource.demographic.DemographicEnablerSearchResults
osid.lexicon.TextSearchResults
osid.lexicon.IdiomSearchResults
osid.lexicon.ParameterSearchResults
osid.lexicon.PressSearchResults
osid.inventory.ItemSearchResults
osid.inventory.StockSearchResults
osid.inventory.ModelSearchResults
osid.inventory.InventorySearchResults
osid.inventory.WarehouseSearchResults
osid.calendaring.cycle.CyclicEventSearchResults
osid.calendaring.cycle.CyclicTimePeriodSearchResults
osid.learning.ObjectiveSearchResults
osid.learning.ActivitySearchResults
osid.learning.ProficiencySearchResults
osid.learning.ObjectiveBankSearchResults
osid.installation.InstallationPackageSearchResults
osid.installation.DepotSearchResults
osid.installation.InstallationSearchResults
osid.cataloging.CatalogSearchResults
osid.messaging.MessageSearchResults
osid.messaging.MailboxSearchResults
osid.checklist.mason.TodoProducerSearchResults
osid.calendaring.rules.RecurringEventEnablerSearchResults
osid.calendaring.rules.OffsetEventEnablerSearchResults
osid.calendaring.rules.SupersedingEventEnablerSearchResults
osid.calendaring.rules.CommitmentEnablerSearchResults
osid.search.SearchResults
osid.search.EngineSearchResults
osid.room.construction.RenovationSearchResults
osid.room.construction.ProjectSearchResults
osid.recognition.ConferralSearchResults
osid.recognition.AwardSearchResults
osid.recognition.ConvocationSearchResults
osid.recognition.AcademySearchResults
osid.grading.GradeSearchResults
osid.grading.GradeSystemSearchResults
osid.grading.GradeEntrySearchResults
osid.grading.GradebookColumnSearchResults
osid.grading.GradebookSearchResults
osid.ontology.rules.RelevancyEnablerSearchResults
osid.room.squatting.LeaseSearchResults
osid.room.squatting.DeedSearchResults
osid.resourcing.JobSearchResults
osid.resourcing.WorkSearchResults
osid.resourcing.CompetencySearchResults
osid.resourcing.AvailabilitySearchResults
osid.resourcing.CommissionSearchResults
osid.resourcing.EffortSearchResults
osid.resourcing.FoundrySearchResults
osid.financials.budgeting.BudgetSearchResults
osid.financials.budgeting.BudgetEntrySearchResults
osid.rules.check.AgendaSearchResults
osid.rules.check.InstructionSearchResults
osid.rules.check.CheckSearchResults
osid.course.plan.PlanSearchResults
osid.course.plan.LessonSearchResults
osid.repository.AssetSearchResults
osid.repository.AssetContentSearchResults
osid.repository.CompositionSearchResults
osid.repository.RepositorySearchResults
osid.bidding.AuctionSearchResults
osid.bidding.BidSearchResults
osid.bidding.AuctionHouseSearchResults
osid.workflow.rules.ProcessEnablerSearchResults
osid.workflow.rules.ProcessConstrainerSearchResults
osid.workflow.rules.ProcessConstrainerEnablerSearchResults
osid.workflow.rules.ProcessProcessorSearchResults
osid.workflow.rules.ProcessProcessorEnablerSearchResults
osid.workflow.rules.StepEnablerSearchResults
osid.workflow.rules.StepConstrainerSearchResults
osid.workflow.rules.StepConstrainerEnablerSearchResults
osid.workflow.rules.StepProcessorSearchResults
osid.workflow.rules.StepProcessorEnablerSearchResults
osid.topology.rules.EdgeEnablerSearchResults
osid.profile.ProfileEntrySearchResults
osid.profile.ProfileItemSearchResults
osid.profile.ProfileSearchResults
osid.recipe.RecipeSearchResults
osid.recipe.DirectionSearchResults
osid.recipe.ProcedureSearchResults
osid.recipe.CookbookSearchResults
osid.course.registration.RegistrationTargetSearchResults
osid.course.registration.RegistrationSearchResults
osid.course.registration.CourseRegistrationSearchResults
osid.course.registration.ActivityRegistrationSearchResults
osid.tracking.IssueSearchResults
osid.tracking.QueueSearchResults
osid.tracking.FrontOfficeSearchResults
osid.course.requisite.RequisiteSearchResults
osid.mapping.route.RouteSearchResults
osid.journaling.JournalEntrySearchResults
osid.journaling.BranchSearchResults
osid.journaling.JournalSearchResults
osid.offering.CanonicalUnitSearchResults
osid.offering.OfferingSearchResults
osid.offering.ParticipantSearchResults
osid.offering.ResultSearchResults
osid.offering.CatalogueSearchResults
osid.mapping.LocationSearchResults
osid.mapping.MapSearchResults
osid.assessment.ItemSearchResults
osid.assessment.AssessmentSearchResults
osid.assessment.AssessmentOfferedSearchResults
osid.assessment.AssessmentTakenSearchResults
osid.assessment.BankSearchResults
osid.blogging.EntrySearchResults
osid.blogging.BlogSearchResults
osid.voting.VoteSearchResults
osid.voting.CandidateSearchResults
osid.voting.RaceSearchResults
osid.voting.BallotSearchResults
osid.voting.PollsSearchResults
osid.calendaring.EventSearchResults
osid.calendaring.RecurringEventSearchResults
osid.calendaring.SupersedingEventSearchResults
osid.calendaring.OffsetEventSearchResults
osid.calendaring.ScheduleSearchResults
osid.calendaring.ScheduleSlotSearchResults
osid.calendaring.TimePeriodSearchResults
osid.calendaring.CommitmentSearchResults
osid.calendaring.CalendarSearchResults
osid.offering.rules.CanonicalUnitEnablerSearchResults
osid.offering.rules.CanonicalUnitProcessorSearchResults
osid.offering.rules.CanonicalUnitProcessorEnablerSearchResults
osid.offering.rules.OfferingConstrainerSearchResults
osid.offering.rules.OfferingConstrainerEnablerSearchResults
osid.ordering.rules.PriceEnablerSearchResults
osid.metering.StatisticSearchResults
osid.metering.MeterSearchResults
osid.metering.UtilitySearchResults
osid.commenting.CommentSearchResults
osid.commenting.BookSearchResults
osid.dictionary.EntrySearchResults
osid.dictionary.DictionarySearchResults
osid.inquiry.rules.AuditEnablerSearchResults
osid.inquiry.rules.AuditConstrainerSearchResults
osid.inquiry.rules.AuditConstrainerEnablerSearchResults
osid.inquiry.rules.AuditProcessorSearchResults
osid.inquiry.rules.AuditProcessorEnablerSearchResults
osid.inquiry.rules.InquiryEnablerSearchResults
osid.configuration.ParameterSearchResults
osid.configuration.ValueSearchResults
osid.configuration.ConfigurationSearchResults
osid.resource.ResourceSearchResults
osid.resource.ResourceRelationshipSearchResults
osid.resource.BinSearchResults
osid.logging.LogEntrySearchResults
osid.logging.LogSearchResults
osid.personnel.PersonSearchResults
osid.personnel.OrganizationSearchResults
osid.personnel.PositionSearchResults
osid.personnel.AppointmentSearchResults
osid.personnel.RealmSearchResults
osid.relationship.rules.RelationshipEnablerSearchResults
osid.course.program.ProgramSearchResults
osid.course.program.ProgramOfferingSearchResults
osid.course.program.CredentialSearchResults
osid.course.program.EnrollmentSearchResults
osid.process.StateSearchResults
osid.process.ProcessSearchResults
osid.provisioning.rules.BrokerEnablerSearchResults
osid.provisioning.rules.BrokerConstrainerSearchResults
osid.provisioning.rules.BrokerConstrainerEnablerSearchResults
osid.provisioning.rules.BrokerProcessorSearchResults
osid.provisioning.rules.BrokerProcessorEnablerSearchResults
osid.provisioning.rules.QueueEnablerSearchResults
osid.provisioning.rules.QueueConstrainerSearchResults
osid.provisioning.rules.QueueConstrainerEnablerSearchResults
osid.provisioning.rules.QueueProcessorSearchResults
osid.provisioning.rules.QueueProcessorEnablerSearchResults
osid.provisioning.rules.PoolEnablerSearchResults
osid.provisioning.rules.PoolConstrainerSearchResults
osid.provisioning.rules.PoolConstrainerEnablerSearchResults
osid.provisioning.rules.PoolProcessorSearchResults
osid.provisioning.rules.PoolProcessorEnablerSearchResults
osid.provisioning.rules.ProvisionableEnablerSearchResults
osid.provisioning.rules.ProvisionEnablerSearchResults
osid.checklist.TodoSearchResults
osid.checklist.ChecklistSearchResults
osid.sequencing.ChainSearchResults
osid.sequencing.AntimatroidSearchResults
osid.billing.CustomerSearchResults
osid.billing.ItemSearchResults
osid.billing.CategorySearchResults
osid.billing.EntrySearchResults
osid.billing.PeriodSearchResults
osid.billing.BusinessSearchResults
osid.inquiry.InquirySearchResults
osid.inquiry.AuditSearchResults
osid.inquiry.ResponseSearchResults
osid.inquiry.InquestSearchResults
osid.course.chronicle.ProgramEntrySearchResults
osid.course.chronicle.CourseEntrySearchResults
osid.course.chronicle.CredentialEntrySearchResults
osid.course.chronicle.AssessmentEntrySearchResults
osid.course.chronicle.AwardEntrySearchResults
osid.authorization.rules.AuthorizationEnablerSearchResults
osid.transport.EndpointSearchResults
osid.workflow.ProcessSearchResults
osid.workflow.StepSearchResults
osid.workflow.WorkSearchResults
osid.workflow.OfficeSearchResults
osid.rules.RuleSearchResults
osid.rules.EngineSearchResults
osid.acknowledgement.CreditSearchResults
osid.acknowledgement.BillingSearchResults
osid.tracking.rules.QueueEnablerSearchResults
osid.tracking.rules.QueueConstrainerSearchResults
osid.tracking.rules.QueueConstrainerEnablerSearchResults
osid.tracking.rules.QueueProcessorSearchResults
osid.tracking.rules.QueueProcessorEnablerSearchResults
osid.resourcing.rules.AvailabilityEnablerSearchResults
osid.resourcing.rules.CommissionEnablerSearchResults
osid.resourcing.rules.JobConstrainerSearchResults
osid.resourcing.rules.JobConstrainerEnablerSearchResults
osid.resourcing.rules.JobProcessorSearchResults
osid.resourcing.rules.JobProcessorEnablerSearchResults
osid.billing.payment.PayerSearchResults
osid.billing.payment.PaymentSearchResults
osid.room.RoomSearchResults
osid.room.FloorSearchResults
osid.room.BuildingSearchResults
osid.room.CampusSearchResults
osid.mapping.path.PathSearchResults
osid.mapping.path.IntersectionSearchResults
osid.mapping.path.SpeedZoneSearchResults
osid.mapping.path.SignalSearchResults
osid.mapping.path.ObstacleSearchResults
osid.mapping.path.rules.SpeedZoneEnablerSearchResults
osid.mapping.path.rules.SignalEnablerSearchResults
osid.mapping.path.rules.ObstacleEnablerSearchResults
osid.topology.path.PathSearchResults
osid.course.syllabus.SyllabusSearchResults
osid.course.syllabus.ModuleSearchResults
osid.course.syllabus.DocetSearchResults
osid.financials.posting.PostSearchResults
osid.financials.posting.PostEntrySearchResults
osid.course.registration.request.RegistrationRequestSearchResults
osid.course.registration.request.RegistrationRequestItemSearchResults
osid.ontology.SubjectSearchResults
osid.ontology.RelevancySearchResults
osid.ontology.OntologySearchResults
osid.control.DeviceSearchResults
osid.control.ControllerSearchResults
osid.control.InputSearchResults
osid.control.SettingSearchResults
osid.control.SceneSearchResults
osid.control.TriggerSearchResults
osid.control.ActionGroupSearchResults
osid.control.SystemSearchResults
Description

This interface provides a means to capture results of a search. An example of searching withina result set:

OsidSearch os = session.getObjectSearch();

OsidQuery query;
query = session.getObjectQuery();
query.matchDescription("*food*", wildcardStringMatchType, true);
ObjectSearchResults results = session.getObjectBySearch(query, os);

// get information about search
ObjectList objects = results.getObjects();
int size = results.getResultSize();

SearchPerformanceRecord record = (SearchPerformanceRecord) results.getObjectSearchResultsRecord(performanceRecodType);
Duration duration = record.getTimeForSearch();
                
MethodgetResultSize
Description

Returns the size of a result set from a search query. This number serves as an estimate to provide feedback for refining search queries and may not be the number of elements available through an OsidList.

Returncardinal the result size
Compliancemandatory This method must be implemented.