OSID - osid.subscription.rules.DispatchProcessorEnablerAdminSession Service Interface Definition

Interface	osid.subscription.rules.DispatchProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session creates, updates, and deletes `DispatchProcessorEnablers` . 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 `DispatchProcessorEnabler` , a `DispatchProcessorEnablerForm` is requested using `getDispatchProcessorEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `DispatchProcessorEnablerForm` 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 `DispatchProcessorEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `DispatchProcessorEnablerForm` corresponds to an attempted transaction. For updates, `DispatchProcessorEnablerForms` are requested to the `DispatchProcessorEnabler` `Id` that is to be updated using `getDispatchProcessorEnablerFormForUpdate()` . Similarly, the `DispatchProcessorEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `DispatchProcessorEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `DispatchProcessorEnablers` . To unmap a `DispatchProcessorEnabler` from the current `Publisher` , the `DispatchProcessorEnablerPublisherAssignmentSession` should be used. These delete operations attempt to remove the `DispatchProcessorEnabler` itself thus removing it from all known `Publisher` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned `Id` .
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDispatchProcessorEnablers
Description	Tests if this user can create `DispatchProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `DispatchProcessorEnabler` 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 `DispatchProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDispatchProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `DispatchProcessorEnabler` using the desired record types. While `SubscriptionRulesManager.getDispatchProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `DispatchProcessorEnabler` . Providing an empty array tests if a `DispatchProcessorEnabler can be` created with no records.
Parameters	`osid.type.Type[]`	`dispatchProcessorEnablerRecordTypes`	array of dispatch processor enabler record types
Return	`boolean`		`true` if `DispatchProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerFormForCreate
Description	Gets the dispatch processor enabler form for creating new dispatch processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`dispatchProcessorEnablerRecordTypes`	array of dispatch processor enabler record types
Return	`osid.subscription.rules.DispatchProcessorEnablerForm`		the dispatch processor enabler form
Errors	NULL_ARGUMENT		`dispatchProcessorEnablerRecordTypes` 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	createDispatchProcessorEnabler
Description	Creates a new `DispatchProcessorEnabler` .
Parameters	`osid.subscription.rules.DispatchProcessorEnablerForm`	`dispatchProcessorEnablerForm`	the form for this `DispatchProcessorEnabler`
Return	`osid.subscription.rules.DispatchProcessorEnabler`		the new `DispatchProcessorEnabler`
Errors	ILLEGAL_STATE		`dispatchProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`dispatchProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchProcessorEnablerForm` did not originate from `getDispatchProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDispatchProcessorEnablers
Description	Tests if this user can update `DispatchProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `DispatchProcessorEnabler` 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 `DispatchProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorEnablerFormForUpdate
Description	Gets the dispatch processor enabler form for updating an existing dispatch processor enabler. A new dispatch processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Return	`osid.subscription.rules.DispatchProcessorEnablerForm`		the dispatch processor enabler form
Errors	NOT_FOUND		`dispatchProcessorEnablerId` is not found
	NULL_ARGUMENT		`dispatchProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDispatchProcessorEnabler
Description	Updates an existing dispatch processor enabler.
Parameters	`osid.subscription.rules.DispatchProcessorEnablerForm`	`dispatchProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`dispatchProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`dispatchProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchProcessorEnablerForm` did not originate from `getDispatchProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDispatchProcessorEnablers
Description	Tests if this user can delete `DispatchProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `DispatchProcessorEnabler` 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 `DispatchProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDispatchProcessorEnabler
Description	Deletes a `DispatchProcessorEnabler` .
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler` to remove
Errors	NOT_FOUND		`dispatchProcessorEnablerId` not found
	NULL_ARGUMENT		`dispatchProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDispatchProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for `DispatchProcessorEnablers` 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 `DispatchProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDispatchProcessorEnabler
Description	Adds an `Id` to a `DispatchProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `DispatchProcessorEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another dispatch processor enabler, it is reassigned to the given dispatch processor enabler `Id` .
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of a `DispatchProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`dispatchProcessorEnablerId` not found
	NULL_ARGUMENT		`dispatchProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.