OSID - osid.installation.InstallationSearchOrder Service Interface Definition

Interface	osid.installation.InstallationSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderBySite
Description	Specified a preference for ordering results by the site.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSiteSearchOrder
Description	Tests if a `SiteSearchOrder` is available for sites.
Return	`boolean`		`true` if a site search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSiteSearchOrder
Description	Gets the search order for a site.
Return	`osid.installation.SiteSearchOrder`		the site search order
Errors	UNIMPLEMENTED		`supportsSiteSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSiteSearchOrder()` is `true.`
Method	orderByPackage
Description	Specified a preference for ordering results by the package.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPackageSearchOrder
Description	Tests if a `PackageSearchOrder` is available for packages.
Return	`boolean`		`true` if a package search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPackageSearchOrder
Description	Gets the search order for a package.
Return	`osid.installation.PackageSearchOrder`		the package search order
Errors	UNIMPLEMENTED		`supportsPackageSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageSearchOrder()` is `true.`
Method	orderByInstallDate
Description	Specified a preference for ordering results by the install date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAgent
Description	Specified a preference for ordering results 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 `AgenteSearchOrder` is available for agents.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentSearchOrder
Description	Gets the search order for an agent.
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	orderByLastCheckDate
Description	Specified a preference for ordering results by the last checked date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationSearchOrderRecord
Description	Gets the installation search order record corresponding to the given installation record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`installationRecordType`	an installation record type
Return	`osid.installation.records.InstallationSearchOrderRecord`		the installation search order record
Errors	NULL_ARGUMENT		`installationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(installationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.