org.osid

Interface OsidSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult

All Known Subinterfaces:

AcademySearchResults, AccountSearchResults, ActionEnablerSearchResults, ActionGroupSearchResults, ActivityBundleSearchResults, ActivityRegistrationSearchResults, ActivitySearchResults, ActivitySearchResults, ActivitySearchResults, ActivityUnitSearchResults, AddressBookSearchResults, AddressSearchResults, AgencySearchResults, AgendaSearchResults, AgentSearchResults, AntimatroidSearchResults, AppointmentSearchResults, AssessmentEntrySearchResults, AssessmentOfferedSearchResults, AssessmentPartSearchResults, AssessmentSearchResults, AssessmentTakenSearchResults, AssetSearchResults, AuctionConstrainerEnablerSearchResults, AuctionConstrainerSearchResults, AuctionHouseSearchResults, AuctionProcessorEnablerSearchResults, AuctionProcessorSearchResults, AuctionSearchResults, AuditEnablerSearchResults, AuditSearchResults, AuthorizationEnablerSearchResults, AuthorizationSearchResults, AvailabilityEnablerSearchResults, AvailabilitySearchResults, AwardEntrySearchResults, AwardSearchResults, BallotConstrainerEnablerSearchResults, BallotConstrainerSearchResults, BallotSearchResults, BankSearchResults, BidSearchResults, BillingSearchResults, BinSearchResults, BlockSearchResults, BlogSearchResults, BookSearchResults, BranchSearchResults, BrokerConstrainerEnablerSearchResults, BrokerConstrainerSearchResults, BrokerProcessorEnablerSearchResults, BrokerProcessorSearchResults, BrokerSearchResults, BudgetEntrySearchResults, BudgetSearchResults, BuildingSearchResults, BusinessSearchResults, BusinessSearchResults, CalendarSearchResults, CampusSearchResults, CandidateSearchResults, CanonicalUnitEnablerSearchResults, CanonicalUnitProcessorEnablerSearchResults, CanonicalUnitProcessorSearchResults, CanonicalUnitSearchResults, CatalogEnablerSearchResults, CatalogSearchResults, CatalogueSearchResults, CategorySearchResults, ChainSearchResults, ChecklistSearchResults, CheckSearchResults, CommentSearchResults, CommissionEnablerSearchResults, CommissionSearchResults, CommitmentEnablerSearchResults, CommitmentSearchResults, CompetencySearchResults, CompositionEnablerSearchResults, CompositionSearchResults, ConferralSearchResults, ConfigurationSearchResults, ContactEnablerSearchResults, ContactSearchResults, ControllerSearchResults, ConvocationSearchResults, CookbookSearchResults, CourseCatalogSearchResults, CourseEntrySearchResults, CourseOfferingSearchResults, CourseSearchResults, CredentialEntrySearchResults, CredentialSearchResults, CreditSearchResults, CustomerSearchResults, CyclicEventSearchResults, CyclicTimePeriodSearchResults, DeedSearchResults, DemographicEnablerSearchResults, DemographicSearchResults, DepotSearchResults, DeviceEnablerSearchResults, DeviceSearchResults, DictionarySearchResults, DirectionSearchResults, DirectorySearchResults, DispatchSearchResults, DistributorSearchResults, DocetSearchResults, EdgeEnablerSearchResults, EdgeSearchResults, EffortSearchResults, EngineSearchResults, EngineSearchResults, EnrollmentSearchResults, EntrySearchResults, EntrySearchResults, EntrySearchResults, EntrySearchResults, EventSearchResults, FamilySearchResults, FileSearchResults, FiscalPeriodSearchResults, FloorSearchResults, ForumSearchResults, FoundrySearchResults, FrontOfficeSearchResults, FunctionSearchResults, GradebookColumnSearchResults, GradebookSearchResults, GradeEntrySearchResults, GradeSystemSearchResults, GraphSearchResults, HierarchySearchResults, HoldEnablerSearchResults, HoldSearchResults, InputEnablerSearchResults, InputSearchResults, InquestSearchResults, InquiryEnablerSearchResults, InquirySearchResults, InstallationSearchResults, InstructionSearchResults, IntersectionSearchResults, InventorySearchResults, IssueSearchResults, IssueSearchResults, ItemSearchResults, ItemSearchResults, ItemSearchResults, JobConstrainerEnablerSearchResults, JobConstrainerSearchResults, JobProcessorEnablerSearchResults, JobProcessorSearchResults, JobSearchResults, JournalEntrySearchResults, JournalSearchResults, KeySearchResults, LeaseSearchResults, LessonSearchResults, LocationSearchResults, LogEntrySearchResults, LogSearchResults, MailboxSearchResults, MapSearchResults, MessageSearchResults, MeterSearchResults, ModelSearchResults, ModuleSearchResults, NodeSearchResults, ObjectiveBankSearchResults, ObjectiveSearchResults, ObstacleEnablerSearchResults, ObstacleSearchResults, OfferingConstrainerEnablerSearchResults, OfferingConstrainerSearchResults, OfferingSearchResults, OfficeSearchResults, OffsetEventEnablerSearchResults, OffsetEventSearchResults, OntologySearchResults, OrderSearchResults, OrganizationSearchResults, OublietteSearchResults, PackageSearchResults, ParameterProcessorEnablerSearchResults, ParameterProcessorSearchResults, ParameterSearchResults, ParticipantSearchResults, PathSearchResults, PathSearchResults, PayerSearchResults, PaymentSearchResults, PeriodSearchResults, PersonSearchResults, PlanSearchResults, PollsSearchResults, PoolConstrainerEnablerSearchResults, PoolConstrainerSearchResults, PoolProcessorEnablerSearchResults, PoolProcessorSearchResults, PoolSearchResults, PositionSearchResults, PostEntrySearchResults, PostSearchResults, PostSearchResults, PriceEnablerSearchResults, PriceScheduleSearchResults, ProcedureSearchResults, ProcessEnablerSearchResults, ProcessSearchResults, ProcessSearchResults, ProductSearchResults, ProficiencySearchResults, ProfileEntryEnablerSearchResults, ProfileEntrySearchResults, ProfileItemSearchResults, ProfileSearchResults, ProgramEntrySearchResults, ProgramOfferingSearchResults, ProgramSearchResults, ProjectSearchResults, ProvisionableSearchResults, ProvisionSearchResults, PublisherSearchResults, QualifierSearchResults, QueueConstrainerEnablerSearchResults, QueueConstrainerEnablerSearchResults, QueueConstrainerSearchResults, QueueConstrainerSearchResults, QueueProcessorEnablerSearchResults, QueueProcessorEnablerSearchResults, QueueProcessorSearchResults, QueueProcessorSearchResults, QueueSearchResults, QueueSearchResults, RaceConstrainerEnablerSearchResults, RaceConstrainerSearchResults, RaceProcessorEnablerSearchResults, RaceProcessorSearchResults, RaceSearchResults, RealmSearchResults, RecipeSearchResults, RecurringEventEnablerSearchResults, RecurringEventSearchResults, RegistrationSearchResults, RelationshipEnablerSearchResults, RelationshipSearchResults, RelevancyEnablerSearchResults, RelevancySearchResults, RenovationSearchResults, ReplySearchResults, RepositorySearchResults, RequestSearchResults, RequisiteSearchResults, ResourceRelationshipSearchResults, ResourceSearchResults, ResponseSearchResults, ResultSearchResults, RoomSearchResults, RouteSearchResults, RuleSearchResults, SceneSearchResults, ScheduleSearchResults, ScheduleSlotSearchResults, SearchResults, SequenceRuleEnablerSearchResults, SequenceRuleSearchResults, SettingSearchResults, ShipmentSearchResults, SignalEnablerSearchResults, SignalSearchResults, SpeedZoneEnablerSearchResults, SpeedZoneSearchResults, StateSearchResults, StatisticSearchResults, StepConstrainerEnablerSearchResults, StepConstrainerSearchResults, StepProcessorEnablerSearchResults, StepProcessorSearchResults, StepSearchResults, StockSearchResults, StoreSearchResults, SubjectSearchResults, SubscriptionEnablerSearchResults, SubscriptionSearchResults, SupersedingEventEnablerSearchResults, SupersedingEventSearchResults, SyllabusSearchResults, SystemSearchResults, TermSearchResults, TimePeriodSearchResults, TodoProducerSearchResults, TodoSearchResults, TriggerEnablerSearchResults, TriggerSearchResults, UtilitySearchResults, ValueEnablerSearchResults, ValueSearchResults, VaultSearchResults, VoteSearchResults, WarehouseSearchResults, WorkSearchResults, WorkSearchResults

public interface OsidSearchResults
extends OsidResult

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();
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
long	getResultSize() Returns the size of a result set from a search query.

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getResultSize

long getResultSize()

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.

Returns:

the result size

Compliance:

mandatory - This method must be implemented.