OSID - osid.resource.ResourceSearchOrder Service Interface Definition

Interface	osid.resource.ResourceSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Used By	`osid.OsidRequestSearchOrder`
	`osid.OsidRuleApplicatorSearchOrder`
	`osid.OsidSourceableSearchOrder`
	`osid.acknowledgement.CreditSearchOrder`
	`osid.assessment.AssessmentTakenSearchOrder`
	`osid.authentication.AgentSearchOrder`
	`osid.authorization.AuthorizationSearchOrder`
	`osid.bidding.AuctionSearchOrder`
	`osid.bidding.BidSearchOrder`
	`osid.billing.CustomerSearchOrder`
	show 54 more…
`osid.billing.payment.PayerSearchOrder`
`osid.blogging.EntrySearchOrder`
`osid.calendaring.CommitmentSearchOrder`
`osid.contact.AddressSearchOrder`
`osid.contact.ContactSearchOrder`
`osid.course.chronicle.AssessmentEntrySearchOrder`
`osid.course.chronicle.AwardEntrySearchOrder`
`osid.course.chronicle.CourseEntrySearchOrder`
`osid.course.chronicle.CredentialEntrySearchOrder`
`osid.course.chronicle.ProgramEntrySearchOrder`
`osid.course.program.EnrollmentSearchOrder`
`osid.course.registration.ActivityRegistrationSearchOrder`
`osid.course.registration.CourseRegistrationSearchOrder`
`osid.course.registration.RegistrationSearchOrder`
`osid.course.registration.request.RegistrationRequestItemSearchOrder`
`osid.financials.ActivitySearchOrder`
`osid.forum.PostSearchOrder`
`osid.forum.ReplySearchOrder`
`osid.grading.GradeEntrySearchOrder`
`osid.hold.HoldSearchOrder`
`osid.inquiry.ResponseSearchOrder`
`osid.installation.InstallationPackageSearchOrder`
`osid.inventory.ModelSearchOrder`
`osid.inventory.shipment.ShipmentSearchOrder`
`osid.journaling.JournalEntrySearchOrder`
`osid.learning.ProficiencySearchOrder`
`osid.logging.LogEntrySearchOrder`
`osid.messaging.MessageSearchOrder`
`osid.messaging.ReceiptSearchOrder`
`osid.offering.ParticipantSearchOrder`
`osid.ordering.OrderSearchOrder`
`osid.ordering.PriceSearchOrder`
`osid.profile.ProfileEntrySearchOrder`
`osid.provisioning.ProvisionReturnSearchOrder`
`osid.provisioning.ProvisionSearchOrder`
`osid.provisioning.ProvisionableSearchOrder`
`osid.provisioning.RequestSearchOrder`
`osid.provisioning.RequestTransactionSearchOrder`
`osid.recognition.ConferralSearchOrder`
`osid.repository.AssetSearchOrder`
`osid.resource.ResourceRelationshipSearchOrder`
`osid.resource.ResourceSearchSession`
`osid.resource.ResourceSmartBinSession`
`osid.resource.demographic.DemographicBuilderSession`
`osid.resourcing.AvailabilitySearchOrder`
`osid.resourcing.CommissionSearchOrder`
`osid.resourcing.EffortSearchOrder`
`osid.room.squatting.DeedSearchOrder`
`osid.room.squatting.LeaseSearchOrder`
`osid.subscription.SubscriptionSearchOrder`
`osid.tracking.IssueSearchOrder`
`osid.voting.CandidateSearchOrder`
`osid.voting.VoteSearchOrder`
`osid.workflow.event.WorkflowEventSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByGroup
Description	Groups the search results by resources that are groups.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDemographic
Description	Groups the search results by resources that are demographics.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAvatar
Description	Orders the result set by avatar.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAvatarSearchOrder
Description	Tests if an `AssetSearchOrder` is available.
Return	`boolean`		`true` if an asset search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvatarSearchOrder
Description	Gets the search order for an asset.
Return	`osid.repository.AssetSearchOrder`		the asset search order
Errors	UNIMPLEMENTED		`supportsAvatarSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAvatarSearchOrder()` is `true`.
Method	getResourceSearchOrderRecord
Description	Gets the resource search record corresponding to the given resource record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`resourceRecordType`	a resource record type
Return	`osid.resource.records.ResourceSearchOrderRecord`		the resource search order record
Errors	NULL_ARGUMENT		`resourceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.