OSID - osid.profile.ProfileEntrySearchOrder Service Interface Definition

Interface	osid.profile.ProfileEntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.profile.ProfileEntrySearchSession`
Used By	`osid.profile.ProfileEntrySmartProfileSession`
Description	An interface for specifying the ordering of search results.
Method	orderByImplicit
Description	Specifies a preference for ordering the result set by the implicit status.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByResource
Description	Specifies a preference for ordering the result set by the resource.
Parameters	`osid.SearchOrderStyle`	`style`	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 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	orderByAgent
Description	Specifies a preference for ordering the result set by the agent.
Parameters	`osid.SearchOrderStyle`	`style`	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 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	orderByProfileItem
Description	Specifies a preference for ordering the result set by the active status.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProfileItemSearchOrder
Description	Tests if a `ProfileItem` is available.
Return	`boolean`		`true` if a profile item search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemSearchOrder
Description	Gets the profil eitem search order.
Return	`osid.profile.ProfileItemSearchOrder`		the profile item search order
Errors	UNIMPLEMENTED		`supportsProfileItemSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProfileItemSearchOrder()` is `true`.
Method	getProfileEntrySearchOrderRecord
Description	Gets the profile entry search order record corresponding to the given profile entry record `Type`.Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`profileEntryRecordType`	a profile entry record type
Return	`osid.profile.records.ProfileEntrySearchOrderRecord`		the profile entry search order record
Errors	NULL_ARGUMENT		`profileEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(profileEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.