OSID - osid.calendaring.CommitmentAdminSession Service Interface Definition

Interface	osid.calendaring.CommitmentAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Commitments.` 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 a `Commitment,` a `CommitmentForm` is requested using `getCommitmentFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `CommitmentForm` 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 `CommitmentForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CommitmentForm` corresponds to an attempted transaction. For updates, `CommitmentForms` are requested to the `Commitment` `Id` that is to be updated using `getCommitmentFormForUpdate().` Similarly, the `CommitmentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CommitmentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Commitment.` To unmap a `Commitment` from the current `Calendar,` the `CommitmentCalendarAssignmentSession` should be used. These delete operations attempt to remove the `Commitment` itself thus removing it from all known `Calendar` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommitments
Description	Tests if this user can create `Commitments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Commitment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Commitment` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommitmentWithRecordTypes
Description	Tests if this user can create a single `Commitment` using the desired record types. While `CalendaringManager.getCommitmentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Commitment.` Providing an empty array tests if a `Commitment` can be created with no records.
Parameters	`osid.type.Type[]`	`commitmentRecordTypes`	array of comitment record types
Return	`boolean`		`true` if `Commitment` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commitmentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentFormForCreate
Description	Gets the commitment form for creating new commitments. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event`
	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
	`osid.type.Type[]`	`commitmentRecordTypes`	array of comitment record types
Return	`osid.calendaring.CommitmentForm`		the commitment form
Errors	NOT_FOUND		`eventId` or `resourceId` is not found
	NULL_ARGUMENT		`eventId` or `resourceId` or `commitmentRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested recod types
Compliance	`mandatory`		This method must be implemented.
Method	createCommitment
Description	Creates a new `Commitment.`
Parameters	`osid.calendaring.CommitmentForm`	`commitmentForm`	the forms for this `Commitment`
Return	`osid.calendaring.Commitment`		the new `Commitment`
Errors	ILLEGAL_STATE		`commitmentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`commitmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentForm` did not originate from `getCommitmentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCommitments
Description	Tests if this user can update `Commitments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Commitment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if commitment modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentFormForUpdate
Description	Gets the commitment form for updating an existing commitment. A new commitment form should be requested for each update transaction.
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment`
Return	`osid.calendaring.CommitmentForm`		the commitment form
Errors	NOT_FOUND		`commitmentId` is not found
	NULL_ARGUMENT		`commitmentid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCommitment
Description	Updates an existing commitment.
Parameters	`osid.calendaring.CommitmentForm`	`commitmentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`commitmentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`commitmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentForm` did not originate from `getCommitmentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCommitments
Description	Tests if this user can delete `Commitments.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Commitment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Commitment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCommitment
Description	Deletes the `Commitment` identified by the given `Id.`
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment` to delete
Errors	NOT_FOUND		a `Commitment` was not found identified by the given `Id`
	NULL_ARGUMENT		`commitmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCommitmentAliases
Description	Tests if this user can manage `Id` aliases for `Commitments.` 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 `Commitment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCommitment
Description	Adds an `Id` to a `Commitment` for the purpose of creating compatibility. The primary `Id` of the `Commitment` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another commitment, it is reassigned to the given commitment `Id.`
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of a `Commitment`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`commitmentId` not found
	NULL_ARGUMENT		`commitmentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.