OSID - osid.resourcing.rules.CommissionEnablerAdminSession Service Interface Definition

Interface	osid.resourcing.rules.CommissionEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session creates and removes commission enablers. The data for create and update is provided via the `CommissionEnablerForm`.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommissionEnabler
Description	Tests if this user can create commission enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CommissionEnabler` 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 `CommissionEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCommissionEnablerWithRecordTypes
Description	Tests if this user can create a single `CommissionEnabler` using the desired record types. While `ResourcingRulesManager.getCommissionEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CommissionEnabler`. Providing an empty array tests if a `CommissionEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`commissionEnablerRecordTypes`	array of commission enabler record types
Return	`boolean`		`true` if `CommissionEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commissionEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerFormForCreate
Description	Gets the commission enabler form for creating new commission enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`commissionEnablerRecordTypes`	array of commission enabler record types
Return	`osid.resourcing.rules.CommissionEnablerForm`		the commission enabler form
Errors	NULL_ARGUMENT		`commissionEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCommissionEnabler
Description	Creates a new `CommissionEnabler`.
Parameters	`osid.resourcing.rules.CommissionEnablerForm`	`commissionEnablerForm`	the form for this `CommissionEnabler`
Return	`osid.resourcing.rules.CommissionEnabler`		the new `CommissionEnabler`
Errors	ILLEGAL_STATE		`commissionEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`commissionEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commissionEnablerForm` did not originate from `getCommissionEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCommissionEnablers
Description	Tests if this user can update commission enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CommissionEnabler` 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 `CommissionEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerFormForUpdate
Description	Gets the commission enabler form for updating an existing commission enabler. A new commission enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`commissionEnablerId`	the `Id` of the `CommissionEnabler`
Return	`osid.resourcing.rules.CommissionEnablerForm`		the commission enabler form
Errors	NOT_FOUND		`commissionEnablerId` is not found
	NULL_ARGUMENT		`commissionEnablerd` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCommissionEnabler
Description	Updates an existing commission enabler.
Parameters	`osid.resourcing.rules.CommissionEnablerForm`	`commissionEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`commissionEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`commissionEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commissionEnablerForm` did not originate from `getCommissionEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCommissionEnablers
Description	Tests if this user can delete commission enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CommissionEnabler` 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 `CommissionEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCommissionEnabler
Description	Deletes a `CommissionEnabler`.
Parameters	`osid.id.Id`	`commissionEnablerId`	the `Id` of the `CommissionEnabler` to remove
Errors	NOT_FOUND		`commissionEnablerId` not found
	NULL_ARGUMENT		`commissionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCommissionEnablerAliases
Description	Tests if this user can manage `Id` aliases for commission 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 `CommissionEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCommissionEnabler
Description	Adds an `Id` to a `CommissionEnabler` for the purpose of creating compatibility. The primary `Id` of the `CommissionEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another commission enabler. it is reassigned to the given commission enabler `Id`.
Parameters	`osid.id.Id`	`commissionEnablerId`	the `Id` of a `CommissionEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`commissionEnablerId` not found
	NULL_ARGUMENT		`commissionEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.