OSID - osid.tracking.rules.QueueEnablerAdminSession Service Interface Definition

Interface	osid.tracking.rules.QueueEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.rules.TrackingRulesManager`
Used By	`osid.tracking.rules.TrackingRulesProxyManager`
Description	This session creates, updates, and deletes `QueueEnablers` . 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 `QueueEnabler` , a `QueueEnablerForm` is requested using `getQueueEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `QueueEnablerForm` 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 `QueueEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `QueueEnablerForm` corresponds to an attempted transaction. For updates, `QueueEnablerForms` are requested to the `QueueEnabler` `Id` that is to be updated using `getQueueEnablerFormForUpdate()` . Similarly, the `QueueEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `QueueEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `QueueEnablers` . To unmap a `QueueEnabler` from the current `FrontOffice` , the `QueueEnablerFrontOfficeAssignmentSession` should be used. These delete operations attempt to remove the `QueueEnabler` itself thus removing it from all known `FrontOffice` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned `Id` .
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQueueEnablers
Description	Tests if this user can create `QueueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `QueueEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `QueueEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateQueueEnablerWithRecordTypes
Description	Tests if this user can create a single `QueueEnabler` using the desired record types. While `TrackingRulesManager.getQueueEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `QueueEnabler` . Providing an empty array tests if a `QueueEnabler can be cr` eated with no records.
Parameters	`osid.type.Type[]`	`queueEnablerRecordTypes`	array of queue enabler record types
Return	`boolean`		`true` if `QueueEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queueEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueEnablerFormForCreate
Description	Gets the queue enabler form for creating new queue enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`queueEnablerRecordTypes`	array of queue enabler record types
Return	`osid.tracking.rules.QueueEnablerForm`		the queue enabler form
Errors	NULL_ARGUMENT		`queueEnablerRecordTypes` 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	createQueueEnabler
Description	Creates a new `QueueEnabler` .
Parameters	`osid.tracking.rules.QueueEnablerForm`	`queueEnablerForm`	the form for this `QueueEnabler`
Return	`osid.tracking.rules.QueueEnabler`		the new `QueueEnabler`
Errors	ILLEGAL_STATE		`queueEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`queueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueEnablerForm` did not originate from `getQueueEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateQueueEnablers
Description	Tests if this user can update `QueueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `QueueEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `QueueEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getQueueEnablerFormForUpdate
Description	Gets the queue enabler form for updating an existing queue enabler. A new queue enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler`
Return	`osid.tracking.rules.QueueEnablerForm`		the queue enabler form
Errors	NOT_FOUND		`queueEnablerId` is not found
	NULL_ARGUMENT		`queueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateQueueEnabler
Description	Updates an existing queue enabler.
Parameters	`osid.tracking.rules.QueueEnablerForm`	`queueEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`queueEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`queueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`queueEnablerForm` did not originate from `getQueueEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteQueueEnablers
Description	Tests if this user can delete `QueueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `QueueEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `QueueEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteQueueEnabler
Description	Deletes a `QueueEnabler` .
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler` to remove
Errors	NOT_FOUND		`queueEnablerId` not found
	NULL_ARGUMENT		`queueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageQueueEnablerAliases
Description	Tests if this user can manage `Id` aliases for `QueueEnablers` 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 `QueueEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasQueueEnabler
Description	Adds an `Id` to a `QueueEnabler` for the purpose of creating compatibility. The primary `Id` of the `QueueEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another queue enabler, it is reassigned to the given queue enabler `Id` .
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of a `QueueEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`queueEnablerId` not found
	NULL_ARGUMENT		`queueEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.