OSID - osid.offering.ResultAdminSession Service Interface Definition

Interface	osid.offering.ResultAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Results.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Result,` an `ResultForm` is requested using `getResultFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `ResultForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `ResultForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ResultForm` corresponds to an attempted transaction. For updates, `ResultForms` are requested to the `Result` `Id` that is to be updated using `getResultFormForUpdate().` Similarly, the `ResultForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ResultForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Results.` To unmap an `Result` from the current `Catalogue,` the `ResultCatalogueAssignmentSession` should be used. These delete operations attempt to remove the `Result` itself thus removing it from all known `Catalogue` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResults
Description	Tests if this user can create results. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Result` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Result` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResultWithRecordTypes
Description	Tests if this user can create a single `Result` using the desired record types. While `OfferingManager.getResultRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Result.` Providing an empty array tests if an `Result` can be created with no records.
Parameters	`osid.type.Type[]`	`resultRecordTypes`	array of result record types
Return	`boolean`		`true` if `Result` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resultRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResultFormForCreate
Description	Gets the result form for creating new results. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`canonicalUnitId`	the canonical unit `Id`
	`osid.id.Id`	`particpantId`	the particpant `Id`
	`osid.type.Type[]`	`resultRecordTypes`	array of result record types to be included in the create operation or an empty list if none
Return	`osid.offering.ResultForm`		the result form
Errors	NOT_FOUND		`canonicalUnitId` or `particpantId` is not found
	NULL_ARGUMENT		`canonicalUnitId, particpantId,` or `resultRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createResult
Description	Creates a new `Result.`
Parameters	`osid.offering.ResultForm`	`resultForm`	the form for this `Result`
Return	`osid.offering.Result`		the new `Result`
Errors	ILLEGAL_STATE		`resultForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`resultForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resultForm` did not originate from `getResultFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateResults
Description	Tests if this user can update results. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Result` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Result` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultFormForUpdate
Description	Gets the result form for updating an existing result. A new result form should be requested for each update transaction.
Parameters	`osid.id.Id`	`resultId`	the `Id` of the `Result`
Return	`osid.offering.ResultForm`		the result form
Errors	NOT_FOUND		`resultId` is not found
	NULL_ARGUMENT		`resultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateResult
Description	Updates an existing result.
Parameters	`osid.offering.ResultForm`	`resultForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`resultForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`resultForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resultForm` did not originate from `getResultFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteResults
Description	Tests if this user can delete results. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Result` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Result` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteResult
Description	Deletes an `Result.`
Parameters	`osid.id.Id`	`resultId`	the `Id` of the `Result` to remove
Errors	NOT_FOUND		`resultId` not found
	NULL_ARGUMENT		`resultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageResultAliases
Description	Tests if this user can manage `Id` aliases for `Results.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Result` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasResult
Description	Adds an `Id` to an `Result` for the purpose of creating compatibility. The primary `Id` of the `Result` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another result, it is reassigned to the given result `Id.`
Parameters	`osid.id.Id`	`resultId`	the `Id` of an `Result`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`resultId` not found
	NULL_ARGUMENT		`resultId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.