org.osid

Interface OsidObjectSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidSearchOrder, Suppliable

All Known Subinterfaces:

AcademySearchOrder, AccountSearchOrder, ActionEnablerSearchOrder, ActionGroupSearchOrder, ActivityBundleSearchOrder, ActivityRegistrationSearchOrder, ActivitySearchOrder, ActivitySearchOrder, ActivitySearchOrder, ActivityUnitSearchOrder, AddressBookSearchOrder, AddressSearchOrder, AgencySearchOrder, AgendaSearchOrder, AgentSearchOrder, AnswerSearchOrder, AntimatroidSearchOrder, AppointmentSearchOrder, AssessmentEntrySearchOrder, AssessmentOfferedSearchOrder, AssessmentPartSearchOrder, AssessmentSearchOrder, AssessmentTakenSearchOrder, AssetSearchOrder, AuctionConstrainerEnablerSearchOrder, AuctionConstrainerSearchOrder, AuctionHouseSearchOrder, AuctionProcessorEnablerSearchOrder, AuctionProcessorSearchOrder, AuctionSearchOrder, AuditEnablerSearchOrder, AuditSearchOrder, AuthorizationEnablerSearchOrder, AuthorizationSearchOrder, AvailabilityEnablerSearchOrder, AvailabilitySearchOrder, AwardEntrySearchOrder, AwardSearchOrder, BallotConstrainerEnablerSearchOrder, BallotConstrainerSearchOrder, BallotSearchOrder, BankSearchOrder, BidSearchOrder, BillingSearchOrder, BinSearchOrder, BlockSearchOrder, BlogSearchOrder, BookSearchOrder, BranchSearchOrder, BrokerConstrainerEnablerSearchOrder, BrokerConstrainerSearchOrder, 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, CourseSearchOrder, CredentialEntrySearchOrder, CredentialSearchOrder, CreditSearchOrder, CustomerSearchOrder, CyclicEventSearchOrder, CyclicTimePeriodSearchOrder, DeedSearchOrder, DemographicEnablerSearchOrder, DemographicSearchOrder, DepotSearchOrder, DeviceEnablerSearchOrder, DeviceSearchOrder, DictionarySearchOrder, DirectionSearchOrder, DirectoryEntrySearchOrder, DirectorySearchOrder, 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, InputEnablerSearchOrder, InputSearchOrder, InquestSearchOrder, InquiryEnablerSearchOrder, InquirySearchOrder, InstallationSearchOrder, InstructionSearchOrder, IntersectionSearchOrder, InventorySearchOrder, 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, OsidEnablerSearchOrder, OsidGovernatorSearchOrder, OsidProcessorSearchOrder, OsidRelationshipSearchOrder, OsidRuleSearchOrder, OublietteSearchOrder, PackageSearchOrder, ParameterProcessorEnablerSearchOrder, ParameterProcessorSearchOrder, ParameterSearchOrder, ParticipantSearchOrder, PathSearchOrder, PathSearchOrder, PayerSearchOrder, PaymentSearchOrder, PeriodSearchOrder, PersonSearchOrder, PlanSearchOrder, PollsSearchOrder, PoolConstrainerEnablerSearchOrder, PoolConstrainerSearchOrder, PoolProcessorEnablerSearchOrder, PoolProcessorSearchOrder, PoolSearchOrder, PositionSearchOrder, PostEntrySearchOrder, PostSearchOrder, PostSearchOrder, PriceEnablerSearchOrder, PriceScheduleSearchOrder, PriceSearchOrder, ProcedureSearchOrder, ProcessEnablerSearchOrder, ProcessSearchOrder, ProcessSearchOrder, ProductSearchOrder, ProficiencySearchOrder, ProfileEntryEnablerSearchOrder, ProfileEntrySearchOrder, ProfileItemSearchOrder, ProfileSearchOrder, ProgramEntrySearchOrder, ProgramOfferingSearchOrder, ProgramSearchOrder, ProjectSearchOrder, ProvisionableSearchOrder, ProvisionReturnSearchOrder, ProvisionSearchOrder, PublisherSearchOrder, QualifierSearchOrder, QuestionSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerEnablerSearchOrder, QueueConstrainerSearchOrder, QueueConstrainerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorEnablerSearchOrder, QueueProcessorSearchOrder, QueueProcessorSearchOrder, QueueSearchOrder, QueueSearchOrder, RaceConstrainerEnablerSearchOrder, RaceConstrainerSearchOrder, RaceProcessorEnablerSearchOrder, RaceProcessorSearchOrder, RaceSearchOrder, RealmSearchOrder, ReceiptSearchOrder, RecipeSearchOrder, RecurringEventEnablerSearchOrder, RecurringEventSearchOrder, RegistrationSearchOrder, 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, StepProcessorEnablerSearchOrder, StepProcessorSearchOrder, StepSearchOrder, StockSearchOrder, StoreSearchOrder, SubjectSearchOrder, SubscriptionEnablerSearchOrder, SubscriptionSearchOrder, SummarySearchOrder, SupersedingEventEnablerSearchOrder, SupersedingEventSearchOrder, SyllabusSearchOrder, SystemSearchOrder, TermSearchOrder, TimePeriodSearchOrder, TodoProducerSearchOrder, TodoSearchOrder, TriggerEnablerSearchOrder, TriggerSearchOrder, UtilitySearchOrder, ValueEnablerSearchOrder, ValueSearchOrder, VaultSearchOrder, VoteSearchOrder, WarehouseSearchOrder, 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 Summary

Methods

Modifier and Type	Method and Description
void	orderByCreateTime(SearchOrderStyle style) Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style) Orders by the cumulative rating in a given Book.
void	orderByDescription(SearchOrderStyle style) Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style) Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style) Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style) Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style) Orders by the state in a given Process.
void	orderByStatistic(Id meterId, SearchOrderStyle style) Orders by a statistic for a given Meter.

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

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.