Interface OsidObjectSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidSearchOrder, Suppliable
All Known Subinterfaces:
AcademySearchOrder, AccountSearchOrder, ActionEnablerSearchOrder, ActionGroupSearchOrder, ActivityRegistrationSearchOrder, ActivitySearchOrder, ActivitySearchOrder, ActivitySearchOrder, ActivityUnitSearchOrder, AddressBookSearchOrder, AddressSearchOrder, AgencySearchOrder, AgendaSearchOrder, AgentSearchOrder, AnswerSearchOrder, AntimatroidSearchOrder, AppointmentSearchOrder, AssessmentEntrySearchOrder, AssessmentOfferedSearchOrder, AssessmentPartSearchOrder, AssessmentSearchOrder, AssessmentTakenSearchOrder, AssetContentSearchOrder, AssetSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionConstrainerSearchOrder, AuctionHouseSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionProcessorSearchOrder, AuctionSearchOrder, AuditConstrainerEnablerSearchOrder, AuditConstrainerSearchOrder, AuditEnablerSearchOrder, AuditProcessorEnablerSearchOrder, AuditProcessorSearchOrder, AuditSearchOrder, AuthorizationEnablerSearchOrder, AuthorizationSearchOrder, AvailabilityEnablerSearchOrder, AvailabilitySearchOrder, AwardEntrySearchOrder, AwardSearchOrder, BallotConstrainerEnablerSearchOrder, BallotConstrainerSearchOrder, BallotSearchOrder, BankSearchOrder, BidEnablerSearchOrder, BidSearchOrder, BillingSearchOrder, BinSearchOrder, BlockSearchOrder, BlogSearchOrder, BookSearchOrder, BranchSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerConstrainerSearchOrder, BrokerEnablerSearchOrder, BrokerProcessorEnablerSearchOrder, BrokerProcessorSearchOrder, BrokerSearchOrder, BudgetEntrySearchOrder, BudgetSearchOrder, BuildingSearchOrder, BusinessSearchOrder, BusinessSearchOrder, CalendarSearchOrder, CampusSearchOrder, CandidateSearchOrder, CanonicalUnitEnablerSearchOrder, CanonicalUnitProcessorEnablerSearchOrder, CanonicalUnitProcessorSearchOrder, CanonicalUnitSearchOrder, CatalogEnablerSearchOrder, CatalogSearchOrder, CatalogueSearchOrder, CategorySearchOrder, ChainSearchOrder, ChecklistSearchOrder, CheckSearchOrder, CommentSearchOrder, CommissionEnablerSearchOrder, CommissionSearchOrder, CommitmentEnablerSearchOrder, CommitmentSearchOrder, CompetencySearchOrder, CompositionEnablerSearchOrder, CompositionSearchOrder, ConferralSearchOrder, ConfigurationSearchOrder, ContactEnablerSearchOrder, ContactSearchOrder, ControllerSearchOrder, ConvocationSearchOrder, CookbookSearchOrder, CourseCatalogSearchOrder, CourseEntrySearchOrder, CourseOfferingSearchOrder, CourseRegistrationSearchOrder, CourseRequirementSearchOrder, CourseSearchOrder, CredentialEntrySearchOrder, CredentialSearchOrder, CreditSearchOrder, CustomerSearchOrder, CyclicEventSearchOrder, CyclicTimePeriodSearchOrder, DeedSearchOrder, DemographicEnablerSearchOrder, DemographicSearchOrder, DepotSearchOrder, DeviceEnablerSearchOrder, DeviceSearchOrder, DictionarySearchOrder, DirectionSearchOrder, DirectoryEntrySearchOrder, DirectorySearchOrder, DispatchConstrainerEnablerSearchOrder, DispatchConstrainerSearchOrder, DispatchEnablerSearchOrder, DispatchProcessorEnablerSearchOrder, DispatchProcessorSearchOrder, DispatchSearchOrder, DistributorSearchOrder, DocetSearchOrder, EdgeEnablerSearchOrder, EdgeSearchOrder, EffortSearchOrder, EngineSearchOrder, EngineSearchOrder, EnrollmentSearchOrder, EntrySearchOrder, EntrySearchOrder, EntrySearchOrder, EntrySearchOrder, EventSearchOrder, FamilySearchOrder, FileSearchOrder, FiscalPeriodSearchOrder, FloorSearchOrder, ForumSearchOrder, FoundrySearchOrder, FrontOfficeSearchOrder, FunctionSearchOrder, GradebookColumnSearchOrder, GradebookColumnSummarySearchOrder, GradebookSearchOrder, GradeEntrySearchOrder, GradeSearchOrder, GradeSystemSearchOrder, GraphSearchOrder, HierarchySearchOrder, HoldEnablerSearchOrder, HoldSearchOrder, IdiomSearchOrder, InputEnablerSearchOrder, InputSearchOrder, InquestSearchOrder, InquiryEnablerSearchOrder, InquirySearchOrder, InstallationSearchOrder, InstructionSearchOrder, IntersectionSearchOrder, InventorySearchOrder, IssueConstrainerEnablerSearchOrder, IssueConstrainerSearchOrder, IssueEnablerSearchOrder, IssueProcessorEnablerSearchOrder, IssueProcessorSearchOrder, IssueSearchOrder, IssueSearchOrder, ItemSearchOrder, ItemSearchOrder, ItemSearchOrder, ItemSearchOrder, JobConstrainerEnablerSearchOrder, JobConstrainerSearchOrder, JobProcessorEnablerSearchOrder, JobProcessorSearchOrder, JobSearchOrder, JournalEntrySearchOrder, JournalSearchOrder, KeySearchOrder, LeaseSearchOrder, LessonSearchOrder, LocationSearchOrder, LogEntrySearchOrder, LogEntrySearchOrder, LogSearchOrder, MailboxSearchOrder, MapSearchOrder, MessageSearchOrder, MeterSearchOrder, ModelSearchOrder, ModuleSearchOrder, NodeSearchOrder, ObjectiveBankSearchOrder, ObjectiveSearchOrder, ObstacleEnablerSearchOrder, ObstacleSearchOrder, OfferingConstrainerEnablerSearchOrder, OfferingConstrainerSearchOrder, OfferingSearchOrder, OfficeSearchOrder, OffsetEventEnablerSearchOrder, OffsetEventSearchOrder, OntologySearchOrder, OrderSearchOrder, OrganizationSearchOrder, OsidCatalogSearchOrder, OsidCompendiumSearchOrder, OsidConstrainerSearchOrder, OsidEffectuatorSearchOrder, OsidEnablerSearchOrder, OsidGovernatorSearchOrder, OsidOperatorSearchOrder, OsidProcessorSearchOrder, OsidRelationshipSearchOrder, OsidRequestSearchOrder, OsidRuleApplicatorSearchOrder, OsidRuleSearchOrder, OublietteSearchOrder, PackageSearchOrder, ParameterProcessorEnablerSearchOrder, ParameterProcessorSearchOrder, ParameterSearchOrder, ParameterSearchOrder, ParticipantSearchOrder, PathSearchOrder, PathSearchOrder, PayerSearchOrder, PaymentSearchOrder, PeriodSearchOrder, PersonSearchOrder, PlanSearchOrder, PollsSearchOrder, PoolConstrainerEnablerSearchOrder, PoolConstrainerSearchOrder, PoolEnablerSearchOrder, PoolProcessorEnablerSearchOrder, PoolProcessorSearchOrder, PoolSearchOrder, PositionSearchOrder, PostEntrySearchOrder, PostSearchOrder, PostSearchOrder, PressSearchOrder, PriceEnablerSearchOrder, PriceScheduleSearchOrder, PriceSearchOrder, ProcedureSearchOrder, ProcessConstrainerEnablerSearchOrder, ProcessConstrainerSearchOrder, ProcessEnablerSearchOrder, ProcessProcessorEnablerSearchOrder, ProcessProcessorSearchOrder, ProcessSearchOrder, ProcessSearchOrder, ProductSearchOrder, ProficiencySearchOrder, ProfileEntryEnablerSearchOrder, ProfileEntrySearchOrder, ProfileItemSearchOrder, ProfileSearchOrder, ProgramEntrySearchOrder, ProgramOfferingSearchOrder, ProgramSearchOrder, ProjectSearchOrder, ProvisionableEnablerSearchOrder, ProvisionableSearchOrder, ProvisionEnablerSearchOrder, ProvisionReturnSearchOrder, ProvisionSearchOrder, PublisherSearchOrder, QualifierSearchOrder, QuestionSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerSearchOrder, QueueConstrainerSearchOrder, QueueEnablerSearchOrder, QueueEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorSearchOrder, QueueProcessorSearchOrder, QueueSearchOrder, QueueSearchOrder, RaceConstrainerEnablerSearchOrder, RaceConstrainerSearchOrder, RaceProcessorEnablerSearchOrder, RaceProcessorSearchOrder, RaceSearchOrder, RealmSearchOrder, ReceiptSearchOrder, RecipeSearchOrder, RecurringEventEnablerSearchOrder, RecurringEventSearchOrder, RegistrationRequestItemSearchOrder, RegistrationRequestSearchOrder, RegistrationSearchOrder, RegistrationTargetSearchOrder, RelationshipEnablerSearchOrder, RelationshipSearchOrder, RelevancyEnablerSearchOrder, RelevancySearchOrder, RenovationSearchOrder, ReplySearchOrder, RepositorySearchOrder, RequestSearchOrder, RequestTransactionSearchOrder, RequisiteSearchOrder, ResourceRelationshipSearchOrder, ResourceSearchOrder, ResponseSearchOrder, ResultSearchOrder, RoomSearchOrder, RouteSearchOrder, RouteSegmentSearchOrder, RuleSearchOrder, SceneSearchOrder, ScheduleSearchOrder, ScheduleSlotSearchOrder, SequenceRuleEnablerSearchOrder, SequenceRuleSearchOrder, SettingSearchOrder, ShipmentSearchOrder, SignalEnablerSearchOrder, SignalSearchOrder, SiteSearchOrder, SpeedZoneEnablerSearchOrder, SpeedZoneSearchOrder, StateSearchOrder, StatisticSearchOrder, StepConstrainerEnablerSearchOrder, StepConstrainerSearchOrder, StepEnablerSearchOrder, StepProcessorEnablerSearchOrder, StepProcessorSearchOrder, StepSearchOrder, StockSearchOrder, StoreSearchOrder, SubjectSearchOrder, SubscriptionEnablerSearchOrder, SubscriptionSearchOrder, SummarySearchOrder, SupersedingEventEnablerSearchOrder, SupersedingEventSearchOrder, SyllabusSearchOrder, SystemSearchOrder, TermSearchOrder, TextSearchOrder, TimePeriodSearchOrder, TodoProducerSearchOrder, TodoSearchOrder, TriggerEnablerSearchOrder, TriggerSearchOrder, UtilitySearchOrder, ValueEnablerSearchOrder, ValueSearchOrder, VaultSearchOrder, VoteEnablerSearchOrder, VoteSearchOrder, WarehouseSearchOrder, WorkflowEventSearchOrder, WorkSearchOrder, WorkSearchOrder
public interface OsidObjectSearchOrder extends OsidIdentifiableSearchOrder, OsidExtensibleSearchOrder, OsidBrowsableSearchOrder

OsidObjectSearchOrder specifies preferred ordering of search results. An OsidSearchOrder is available from an search session and supplied to an OsidSearch . 

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

OsidObjectSearchOrder order = session.getObjectSearchOrder();
order.orderByDisplayName();
os.orderResults(order);

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

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

  • Method Details

    • orderByDisplayName

      void orderByDisplayName(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the display name.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDescription

      void orderByDescription(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the description.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByGenusType

      void orderByGenusType(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the genus type.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByState

      void orderByState(Id processId, SearchOrderStyle style)
      Orders by the state in a given Process .
      Parameters:
      processId - a process Id
      style - search order style
      Throws:
      NullArgumentException - processId or style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCumulativeRating

      void orderByCumulativeRating(Id bookId, SearchOrderStyle style)
      Orders by the cumulative rating in a given Book .
      Parameters:
      bookId - a book Id
      style - search order style
      Throws:
      NullArgumentException - bookId or style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStatistic

      void orderByStatistic(Id meterId, SearchOrderStyle style)
      Orders by a statistic for a given Meter .
      Parameters:
      meterId - a meter Id
      style - search order style
      Throws:
      NullArgumentException - meterId or style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByCreateTime

      void orderByCreateTime(SearchOrderStyle style)
      Orders by the timestamp of the first journal entry.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByLastModifiedTime

      void orderByLastModifiedTime(SearchOrderStyle style)
      Orders by the timestamp of the last journal entry.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.