OSID - osid.authorization.AuthorizationSearchOrder Service Interface Definition

Interface	osid.authorization.AuthorizationSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByResource
Description	Specifies a preference for ordering the result set by the resource.
Parameters	`osid.SearchOrderStyle`	`style`	the search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSearchOrder
Description	Tests if a `Resource` is available.
Return	`boolean`		`true` if a resource search order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsResourceSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceSearchOrder()` is `true.`
Method	orderByTrust
Description	Specifies a preference for ordering the result set by the trust.
Parameters	`osid.SearchOrderStyle`	`style`	the search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAgent
Description	Specifies a preference for ordering the result set by the agent.
Parameters	`osid.SearchOrderStyle`	`style`	the search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentSearchOrder
Description	Tests if an `Agent` is available.
Return	`boolean`		`true` if an agent search order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentSearchOrder
Description	Gets the agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSearchOrder()` is `true.`
Method	orderByFunction
Description	Specifies a preference for ordering the result set by the active status.
Parameters	`osid.SearchOrderStyle`	`style`	the search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionSearchOrder
Description	Tests if a `Function` is available.
Return	`boolean`		`true` if a function search order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionSearchOrder
Description	Gets the function search order.
Return	`osid.authorization.FunctionSearchOrder`		the function search order
Errors	UNIMPLEMENTED		`supportsFunctionSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsQualifierSearchOrder()` is `true.`
Method	orderByQualifier
Description	Specifies a preference for ordering the result set by the qualifier,
Parameters	`osid.SearchOrderStyle`	`style`	the search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierSearchOrder
Description	Tests if a `Qualifier` is available.
Return	`boolean`		`true` if a qualifier search order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierSearchOrder
Description	Gets the qualifier search order.
Return	`osid.authorization.QualifierSearchOrder`		the qualifier search order
Errors	UNIMPLEMENTED		`supportsQualifierSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsQualifierSearchOrder()` is `true.`
Method	getAuthorizationSearchOrderRecord
Description	Gets the authorization search order record corresponding to the given function record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`authorizationRecordType`	an authorization record type
Return	`osid.authorization.records.AuthorizationSearchOrderRecord`		the authorization search order record
Errors	NULL_ARGUMENT		`authorizationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(authorizationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.