Interface OsidSearch

All Superinterfaces:

Extensible, OsidCondition, Suppliable

All Known Subinterfaces:

AcademySearch, AccountSearch, ActionEnablerSearch, ActionGroupSearch, ActivityRegistrationSearch, ActivitySearch, ActivitySearch, ActivitySearch, ActivityUnitSearch, AddressBookSearch, AddressSearch, AgencySearch, AgendaSearch, AgentSearch, AntimatroidSearch, AppointmentSearch, AssessmentEntrySearch, AssessmentOfferedSearch, AssessmentPartSearch, AssessmentSearch, AssessmentTakenSearch, AssetContentSearch, AssetSearch, AuctionConstrainerEnablerSearch, AuctionConstrainerSearch, AuctionHouseSearch, AuctionProcessorEnablerSearch, AuctionProcessorSearch, AuctionSearch, AuditConstrainerEnablerSearch, AuditConstrainerSearch, AuditEnablerSearch, AuditProcessorEnablerSearch, AuditProcessorSearch, AuditSearch, AuthorizationEnablerSearch, AuthorizationSearch, AvailabilityEnablerSearch, AvailabilitySearch, AwardEntrySearch, AwardSearch, BallotConstrainerEnablerSearch, BallotConstrainerSearch, BallotSearch, BankSearch, BidEnablerSearch, BidSearch, BillingSearch, BinSearch, BlockSearch, BlogSearch, BookSearch, BranchSearch, BrokerConstrainerEnablerSearch, BrokerConstrainerSearch, BrokerEnablerSearch, BrokerProcessorEnablerSearch, BrokerProcessorSearch, BrokerSearch, BudgetEntrySearch, BudgetSearch, BuildingSearch, BusinessSearch, BusinessSearch, CalendarSearch, CampusSearch, CandidateSearch, CanonicalUnitEnablerSearch, CanonicalUnitProcessorEnablerSearch, CanonicalUnitProcessorSearch, CanonicalUnitSearch, CatalogEnablerSearch, CatalogSearch, CatalogueSearch, CategorySearch, ChainSearch, ChecklistSearch, CheckSearch, CommentSearch, CommissionEnablerSearch, CommissionSearch, CommitmentEnablerSearch, CommitmentSearch, CompetencySearch, CompositionEnablerSearch, CompositionSearch, ConferralSearch, ConfigurationSearch, ContactEnablerSearch, ContactSearch, ControllerSearch, ConvocationSearch, CookbookSearch, CourseCatalogSearch, CourseEntrySearch, CourseOfferingSearch, CourseRegistrationSearch, CourseSearch, CredentialEntrySearch, CredentialSearch, CreditSearch, CustomerSearch, CyclicEventSearch, CyclicTimePeriodSearch, DeedSearch, DemographicEnablerSearch, DemographicSearch, DepotSearch, DeviceEnablerSearch, DeviceSearch, DictionarySearch, DirectionSearch, DirectorySearch, DispatchConstrainerEnablerSearch, DispatchConstrainerSearch, DispatchEnablerSearch, DispatchProcessorEnablerSearch, DispatchProcessorSearch, DispatchSearch, DistributorSearch, DocetSearch, EdgeEnablerSearch, EdgeSearch, EffortSearch, EngineSearch, EngineSearch, EnrollmentSearch, EntrySearch, EntrySearch, EntrySearch, EntrySearch, EventSearch, FamilySearch, FileSearch, FiscalPeriodSearch, FloorSearch, ForumSearch, FoundrySearch, FrontOfficeSearch, FunctionSearch, GradebookColumnSearch, GradebookSearch, GradeEntrySearch, GradeSearch, GradeSystemSearch, GraphSearch, HierarchySearch, HoldEnablerSearch, HoldSearch, IdiomSearch, InputEnablerSearch, InputSearch, InquestSearch, InquiryEnablerSearch, InquirySearch, InstallationSearch, InstructionSearch, IntersectionSearch, InventorySearch, IssueConstrainerEnablerSearch, IssueConstrainerSearch, IssueEnablerSearch, IssueProcessorEnablerSearch, IssueProcessorSearch, IssueSearch, IssueSearch, ItemSearch, ItemSearch, ItemSearch, JobConstrainerEnablerSearch, JobConstrainerSearch, JobProcessorEnablerSearch, JobProcessorSearch, JobSearch, JournalEntrySearch, JournalSearch, KeySearch, LeaseSearch, LessonSearch, LocationSearch, LogEntrySearch, LogSearch, MailboxSearch, MapSearch, MessageSearch, MeterSearch, ModelSearch, ModuleSearch, NodeSearch, ObjectiveBankSearch, ObjectiveSearch, ObstacleEnablerSearch, ObstacleSearch, OfferingConstrainerEnablerSearch, OfferingConstrainerSearch, OfferingSearch, OfficeSearch, OffsetEventEnablerSearch, OffsetEventSearch, OntologySearch, OrderSearch, OrganizationSearch, OublietteSearch, PackageSearch, ParameterProcessorEnablerSearch, ParameterProcessorSearch, ParameterSearch, ParameterSearch, ParticipantSearch, PathSearch, PathSearch, PayerSearch, PaymentSearch, PeriodSearch, PersonSearch, PlanSearch, PollsSearch, PoolConstrainerEnablerSearch, PoolConstrainerSearch, PoolEnablerSearch, PoolProcessorEnablerSearch, PoolProcessorSearch, PoolSearch, PositionSearch, PostEntrySearch, PostSearch, PostSearch, PressSearch, PriceEnablerSearch, PriceScheduleSearch, ProcedureSearch, ProcessConstrainerEnablerSearch, ProcessConstrainerSearch, ProcessEnablerSearch, ProcessProcessorEnablerSearch, ProcessProcessorSearch, ProcessSearch, ProcessSearch, ProductSearch, ProficiencySearch, ProfileEntryEnablerSearch, ProfileEntrySearch, ProfileItemSearch, ProfileSearch, ProgramEntrySearch, ProgramOfferingSearch, ProgramSearch, ProjectSearch, ProvisionableEnablerSearch, ProvisionableSearch, ProvisionEnablerSearch, ProvisionSearch, PublisherSearch, QualifierSearch, QueueConstrainerEnablerSearch, QueueConstrainerEnablerSearch, QueueConstrainerSearch, QueueConstrainerSearch, QueueEnablerSearch, QueueEnablerSearch, QueueProcessorEnablerSearch, QueueProcessorEnablerSearch, QueueProcessorSearch, QueueProcessorSearch, QueueSearch, QueueSearch, RaceConstrainerEnablerSearch, RaceConstrainerSearch, RaceProcessorEnablerSearch, RaceProcessorSearch, RaceSearch, RealmSearch, RecipeSearch, RecurringEventEnablerSearch, RecurringEventSearch, RegistrationRequestItemSearch, RegistrationRequestSearch, RegistrationSearch, RegistrationTargetSearch, RelationshipEnablerSearch, RelationshipSearch, RelevancyEnablerSearch, RelevancySearch, RenovationSearch, ReplySearch, RepositorySearch, RequestSearch, RequestTransactionSearch, RequisiteSearch, ResourceRelationshipSearch, ResourceSearch, ResponseSearch, ResultSearch, RoomSearch, RouteSearch, RuleSearch, SceneSearch, ScheduleSearch, ScheduleSlotSearch, Search, SequenceRuleEnablerSearch, SequenceRuleSearch, SettingSearch, ShipmentSearch, SignalEnablerSearch, SignalSearch, SpeedZoneEnablerSearch, SpeedZoneSearch, StateSearch, StatisticSearch, StepConstrainerEnablerSearch, StepConstrainerSearch, StepEnablerSearch, StepProcessorEnablerSearch, StepProcessorSearch, StepSearch, StockSearch, StoreSearch, SubjectSearch, SubscriptionEnablerSearch, SubscriptionSearch, SupersedingEventEnablerSearch, SupersedingEventSearch, SyllabusSearch, SystemSearch, TermSearch, TextSearch, TimePeriodSearch, TodoProducerSearch, TodoSearch, TriggerEnablerSearch, TriggerSearch, UtilitySearch, ValueEnablerSearch, ValueSearch, VaultSearch, VoteEnablerSearch, VoteSearch, WarehouseSearch, WorkflowEventSearch, WorkSearch, WorkSearch

public interface OsidSearch
extends OsidCondition

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

Method Summary

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

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 .

Method Details

limitResultSet

void limitResultSet(long start,
 long end)

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.

Parameters:

start - the start of the result set

end - the end of the result set

Throws:

InvalidArgumentException - end is less than or equal to start

Compliance:

mandatory - This method must be implemented.