OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgentSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.OsidRequestSearchOrder
osid.assessment.AssessmentTakenSearchOrder
osid.authentication.AgentSearchSession
osid.authentication.AgentSmartAgencySession
osid.authentication.keys.KeySearchOrder
osid.authorization.AuthorizationSearchOrder
osid.bidding.BidSearchOrder
osid.blogging.EntrySearchOrder
osid.commenting.CommentSearchOrder
osid.filing.DirectoryEntrySearchOrder
show 19 more…
osid.forum.PostSearchOrder
osid.forum.ReplySearchOrder
osid.grading.GradeEntrySearchOrder
osid.hold.HoldSearchOrder
osid.inquiry.ResponseSearchOrder
osid.installation.InstallationSearchOrder
osid.journaling.JournalEntrySearchOrder
osid.logging.LogEntrySearchOrder
osid.messaging.MessageSearchOrder
osid.messaging.ReceiptSearchOrder
osid.ordering.OrderSearchOrder
osid.profile.ProfileEntrySearchOrder
osid.provisioning.ProvisionReturnSearchOrder
osid.provisioning.RequestSearchOrder
osid.provisioning.RequestTransactionSearchOrder
osid.tracking.IssueSearchOrder
osid.tracking.LogEntrySearchOrder
osid.voting.VoteSearchOrder
osid.workflow.event.WorkflowEventSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

Orders the results by resource.

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

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order interface is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetResourceSearchOrder
Description

Gets the resource search order.

Returnosid.resource.ResourceSearchOrder the resource search odrer
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
Complianceoptional This method must be implemented if supportsResourceSearchOrder() is true.
MethodgetAgentSearchOrderRecord
Description

Gets the agent search order record corresponding to the given agent record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeagentRecordType an agent record type
Returnosid.authentication.records.AgentSearchOrderRecord the agent search order record
ErrorsNULL_ARGUMENT agentRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(agentRecordType) is false
Compliancemandatory This method must be implemented.