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

Interface	osid.resourcing.rules.AvailabilityEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session creates and removes availability enablers. The data for create and update is provided via the `AvailabilityEnablerForm` .
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	canCreateAvailabilityEnabler
Description	Tests if this user can create availability enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AvailabilityEnabler` 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 `AvailabilityEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAvailabilityEnablerWithRecordTypes
Description	Tests if this user can create a single `AvailabilityEnabler` using the desired record types. While `ResourcingRulesManager.getAvailabilityEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AvailabilityEnabler` . Providing an empty array tests if an `AvailabilityEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`availabilityEnablerRecordTypes`	array of availability enabler record types
Return	`boolean`		`true` if `AvailabilityEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`availabilityEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablerFormForCreate
Description	Gets the availability enabler form for creating new availability enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`availabilityEnablerRecordTypes`	array of availability enabler record types
Return	`osid.resourcing.rules.AvailabilityEnablerForm`		the availability enabler form
Errors	NULL_ARGUMENT		`availabilityEnablerRecordTypes` 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	createAvailabilityEnabler
Description	Creates a new `AvailabilityEnabler` .
Parameters	`osid.resourcing.rules.AvailabilityEnablerForm`	`availabilityEnablerForm`	the form for this `AvailabilityEnabler`
Return	`osid.resourcing.rules.AvailabilityEnabler`		the new `AvailabilityEnabler`
Errors	ILLEGAL_STATE		`availabilityEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`availabilityEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityEnablerForm` did not originate from `getAvailabilityEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAvailabilityEnablers
Description	Tests if this user can update availability enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AvailabilityEnabler` 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 `AvailabilityEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablerFormForUpdate
Description	Gets the availability enabler form for updating an existing availability enabler. A new availability enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`availabilityEnablerId`	the `Id` of the `AvailabilityEnabler`
Return	`osid.resourcing.rules.AvailabilityEnablerForm`		the availability enabler form
Errors	NOT_FOUND		`availabilityEnablerId` is not found
	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAvailabilityEnabler
Description	Updates an existing availability enabler.
Parameters	`osid.resourcing.rules.AvailabilityEnablerForm`	`availabilityEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`availabilityEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`availabilityEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityEnablerForm` did not originate from `getAvailabilityEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAvailabilityEnablers
Description	Tests if this user can delete availability enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AvailabilityEnabler` 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 `AvailabilityEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAvailabilityEnabler
Description	Deletes an `AvailabilityEnabler` .
Parameters	`osid.id.Id`	`availabilityEnablerId`	the `Id` of the `AvailabilityEnabler` to remove
Errors	NOT_FOUND		`availabilityEnablerId` not found
	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAvailabilityEnablerAliases
Description	Tests if this user can manage `Id` aliases for availability 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 `AvailabilityEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAvailabilityEnabler
Description	Adds an `Id` to an `AvailabilityEnabler` for the purpose of creating compatibility. The primary `Id` of the `AvailabilityEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another availability enabler. it is reassigned to the given availability enabler `Id` .
Parameters	`osid.id.Id`	`availabilityEnablerId`	the `Id` of an `AvailabilityEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`availabilityEnablerId` not found
	NULL_ARGUMENT		`availabilityEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.