OSID - osid.calendaring.rules.CommitmentEnablerAdminSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes commitment enablers. The data for create and update is provided via the `CommitmentEnablerForm.`
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommitmentEnabler
Description	Tests if this user can create commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CommitmentEnabler` 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 `CommitmentEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommitmentEnablerWithRecordTypes
Description	Tests if this user can create a single `CommitmentEnabler` using the desired record types. While `CalendaringRulesManager.getCommitmentEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CommitmentEnabler.` Providing an empty array tests if a `CommitmentEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`commitmentEnablerRecordTypes`	array of commitment enabler record types
Return	`boolean`		`true` if `CommitmentEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commitmentEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerFormForCreate
Description	Gets the commitment enabler form for creating new commitment enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`commitmentEnablerRecordTypes`	array of commitment enabler record types
Return	`osid.calendaring.rules.CommitmentEnablerForm`		the commitment enabler form
Errors	NULL_ARGUMENT		`commitmentEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCommitmentEnabler
Description	Creates a new `CommitmentEnabler.`
Parameters	`osid.calendaring.rules.CommitmentEnablerForm`	`commitmentEnablerForm`	the form for this `CommitmentEnabler`
Return	`osid.calendaring.rules.CommitmentEnabler`		the new `CommitmentEnabler`
Errors	ILLEGAL_STATE		`commitmentEnablerForm` already used in a create trsnaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`commitmentEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentEnablerForm` did not originate from `getCommitmentEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCommitmentEnablers
Description	Tests if this user can update commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CommitmentEnabler` 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 `CommitmentEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerFormForUpdate
Description	Gets the commitment enabler form for updating an existing commitment enabler. A new commitment enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler`
Return	`osid.calendaring.rules.CommitmentEnablerForm`		the commitment enabler form
Errors	NOT_FOUND		`commitmentEnablerId` is not found
	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCommitmentEnabler
Description	Updates an existing commitment enabler.
Parameters	`osid.calendaring.rules.CommitmentEnablerForm`	`commitmentEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`commitmentEnablerForm` already used in an update trsnaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`commitmentEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commitmentEnablerForm` did not originate from `getCommitmentEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCommitmentEnablers
Description	Tests if this user can delete commitment enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CommitmentEnabler` 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 `CommitmentEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCommitmentEnabler
Description	Deletes a `CommitmentEnabler.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler` to remove
Errors	NOT_FOUND		`commitmentEnablerId` not found
	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCommitmentEnablerAliases
Description	Tests if this user can manage `Id` aliases for commitment enablers. 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 `CommitmentEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCommitmentEnabler
Description	Adds an `Id` to a `CommitmentEnabler` for the purpose of creating compatibility. The primary `Id` of the `CommitmentEnabler` 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 enabler. it is reassigned to the given commitment enabler `Id.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of a `CommitmentEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`commitmentEnablerId` not found
	NULL_ARGUMENT		`commitmentEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.