OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.OsidObjectSearchOrder
Implementsosid.OsidIdentifiableSearchOrder
osid.OsidExtensibleSearchOrder
osid.OsidBrowsableSearchOrder
Implemented Byosid.course.CourseSearchOrder
osid.course.ActivityUnitSearchOrder
osid.course.TermSearchOrder
osid.assessment.authoring.AssessmentPartSearchOrder
osid.ordering.OrderSearchOrder
osid.ordering.ProductSearchOrder
osid.ordering.PriceScheduleSearchOrder
osid.topology.NodeSearchOrder
osid.inventory.shipment.ShipmentSearchOrder
osid.inventory.shipment.EntrySearchOrder
osid.authentication.keys.KeySearchOrder
osid.financials.AccountSearchOrder
osid.financials.ActivitySearchOrder
osid.financials.FiscalPeriodSearchOrder
osid.workflow.event.WorkflowEventSearchOrder
osid.authentication.AgentSearchOrder
osid.contact.AddressSearchOrder
osid.provisioning.ProvisionReturnSearchOrder
osid.hold.BlockSearchOrder
osid.filing.DirectoryEntrySearchOrder
osid.forum.PostSearchOrder
osid.forum.ReplySearchOrder
osid.authorization.QualifierSearchOrder
osid.OsidRelationshipSearchOrder
osid.OsidCatalogSearchOrder
osid.OsidRequestSearchOrder
osid.OsidRuleSearchOrder
osid.OsidGovernatorSearchOrder
osid.OsidCompendiumSearchOrder
osid.lexicon.TextSearchOrder
osid.lexicon.IdiomSearchOrder
osid.lexicon.ParameterSearchOrder
osid.inventory.ItemSearchOrder
osid.inventory.StockSearchOrder
osid.inventory.ModelSearchOrder
osid.inventory.InventorySearchOrder
osid.calendaring.cycle.CyclicEventSearchOrder
osid.calendaring.cycle.CyclicTimePeriodSearchOrder
osid.learning.ObjectiveSearchOrder
osid.learning.ActivitySearchOrder
osid.installation.InstallationPackageSearchOrder
osid.installation.InstallationSearchOrder
osid.installation.SiteSearchOrder
osid.messaging.MessageSearchOrder
osid.messaging.ReceiptSearchOrder
osid.room.construction.RenovationSearchOrder
osid.room.construction.ProjectSearchOrder
osid.recognition.AwardSearchOrder
osid.grading.GradeSearchOrder
osid.grading.GradeSystemSearchOrder
osid.grading.GradebookColumnSearchOrder
osid.grading.GradebookColumnSummarySearchOrder
osid.resourcing.WorkSearchOrder
osid.resourcing.CompetencySearchOrder
osid.repository.AssetSearchOrder
osid.repository.AssetContentSearchOrder
osid.profile.ProfileItemSearchOrder
osid.recipe.RecipeSearchOrder
osid.recipe.DirectionSearchOrder
osid.recipe.ProcedureSearchOrder
osid.course.registration.RegistrationTargetSearchOrder
osid.tracking.LogEntrySearchOrder
osid.mapping.route.RouteSegmentSearchOrder
osid.journaling.JournalEntrySearchOrder
osid.journaling.BranchSearchOrder
osid.offering.CanonicalUnitSearchOrder
osid.offering.ResultSearchOrder
osid.mapping.LocationSearchOrder
osid.assessment.QuestionSearchOrder
osid.assessment.AnswerSearchOrder
osid.assessment.ItemSearchOrder
osid.assessment.AssessmentSearchOrder
osid.assessment.AssessmentOfferedSearchOrder
osid.assessment.AssessmentTakenSearchOrder
osid.blogging.EntrySearchOrder
osid.calendaring.EventSearchOrder
osid.calendaring.ScheduleSearchOrder
osid.calendaring.ScheduleSlotSearchOrder
osid.calendaring.TimePeriodSearchOrder
osid.metering.MeterSearchOrder
osid.dictionary.EntrySearchOrder
osid.configuration.ValueSearchOrder
osid.resource.ResourceSearchOrder
osid.logging.LogEntrySearchOrder
osid.personnel.PersonSearchOrder
osid.personnel.OrganizationSearchOrder
osid.personnel.PositionSearchOrder
osid.course.program.ProgramSearchOrder
osid.course.program.CredentialSearchOrder
osid.process.StateSearchOrder
osid.checklist.TodoSearchOrder
osid.sequencing.ChainSearchOrder
osid.billing.CustomerSearchOrder
osid.billing.ItemSearchOrder
osid.billing.CategorySearchOrder
osid.billing.PeriodSearchOrder
osid.workflow.WorkSearchOrder
osid.billing.payment.PayerSearchOrder
osid.billing.payment.PaymentSearchOrder
osid.room.RoomSearchOrder
osid.room.FloorSearchOrder
osid.room.BuildingSearchOrder
osid.mapping.path.PathSearchOrder
osid.mapping.path.IntersectionSearchOrder
osid.mapping.path.ObstacleSearchOrder
osid.course.syllabus.SyllabusSearchOrder
osid.course.syllabus.ModuleSearchOrder
osid.financials.posting.PostSearchOrder
osid.financials.posting.PostEntrySearchOrder
osid.course.registration.request.RegistrationRequestItemSearchOrder
osid.ontology.SubjectSearchOrder
osid.control.DeviceSearchOrder
osid.control.ControllerSearchOrder
osid.control.SettingSearchOrder
osid.control.SceneSearchOrder
osid.control.ActionGroupSearchOrder
Description

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

Specifies a preference for ordering the result set by the display name.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByDescription
Description

Specifies a preference for ordering the result set by the description.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByGenusType
Description

Specifies a preference for ordering the result set by the genus type.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByState
Description

Orders by the state in a given Process.

Parametersosid.id.IdprocessId a process Id
osid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT processId or style is null
Compliancemandatory This method must be implemented.
MethodorderByCumulativeRating
Description

Orders by the cumulative rating in a given Book.

Parametersosid.id.IdbookId a book Id
osid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT bookId or style is null
Compliancemandatory This method must be implemented.
MethodorderByStatistic
Description

Orders by a statistic for a given Meter.

Parametersosid.id.IdmeterId a meter Id
osid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT meterId or style is null
Compliancemandatory This method must be implemented.
MethodorderByCreateTime
Description

Orders by the timestamp of the first journal entry.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByLastModifiedTime
Description

Orders by the timestamp of the last journal entry.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.