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

Interface	osid.subscription.rules.DispatchConstrainerEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session creates, updates, and deletes `DispatchConstrainerEnablers` . 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 `DispatchConstrainerEnabler` , a `DispatchConstrainerEnablerForm` is requested using `getDispatchConstrainerEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `DispatchConstrainerEnablerForm` 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 `DispatchConstrainerEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `DispatchConstrainerEnablerForm` corresponds to an attempted transaction. For updates, `DispatchConstrainerEnablerForms` are requested to the `DispatchConstrainerEnabler` `Id` that is to be updated using `getDispatchConstrainerEnablerFormForUpdate()` . Similarly, the `DispatchConstrainerEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `DispatchConstrainerEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `DispatchConstrainerEnablers` . To unmap a `DispatchConstrainerEnabler` from the current `Publisher` , the `DispatchConstrainerEnablerPublisherAssignmentSession` should be used. These delete operations attempt to remove the `DispatchConstrainerEnabler` 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	canCreateDispatchConstrainerEnablers
Description	Tests if this user can create `DispatchConstrainerEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `DispatchConstrainerEnabler` 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 `DispatchConstrainerEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDispatchConstrainerEnablerWithRecordTypes
Description	Tests if this user can create a single `DispatchConstrainerEnabler` using the desired record types. While `SubscriptionRulesManager.getDispatchConstrainerEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `DispatchConstrainerEnabler` . Providing an empty array tests if a `DispatchConstrainerEnabler can be` created with no records.
Parameters	`osid.type.Type[]`	`dispatchConstrainerEnablerRecordTypes`	array of dispatch constrainer enabler record types
Return	`boolean`		`true` if `DispatchConstrainerEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerFormForCreate
Description	Gets the dispatch constrainer enabler form for creating new dispatch constrainer enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`dispatchConstrainerEnablerRecordTypes`	array of dispatch constrainer enabler record types
Return	`osid.subscription.rules.DispatchConstrainerEnablerForm`		the dispatch constrainer enabler form
Errors	NULL_ARGUMENT		`dispatchConstrainerEnablerRecordTypes` 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	createDispatchConstrainerEnabler
Description	Creates a new `DispatchConstrainerEnabler` .
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerForm`	`dispatchConstrainerEnablerForm`	the form for this `DispatchConstrainerEnabler`
Return	`osid.subscription.rules.DispatchConstrainerEnabler`		the new `DispatchConstrainerEnabler`
Errors	ILLEGAL_STATE		`dispatchConstrainerEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`dispatchConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchConstrainerEnablerForm` did not originate from `getDispatchConstrainerEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDispatchConstrainerEnablers
Description	Tests if this user can update `DispatchConstrainerEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `DispatchConstrainerEnabler` 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 `DispatchConstrainerEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainerEnablerFormForUpdate
Description	Gets the dispatch constrainer enabler form for updating an existing dispatch constrainer enabler. A new dispatch constrainer enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler`
Return	`osid.subscription.rules.DispatchConstrainerEnablerForm`		the dispatch constrainer enabler form
Errors	NOT_FOUND		`dispatchConstrainerEnablerId` is not found
	NULL_ARGUMENT		`dispatchConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDispatchConstrainerEnabler
Description	Updates an existing dispatch constrainer enabler.
Parameters	`osid.subscription.rules.DispatchConstrainerEnablerForm`	`dispatchConstrainerEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`dispatchConstrainerEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`dispatchConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchConstrainerEnablerForm` did not originate from `getDispatchConstrainerEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDispatchConstrainerEnablers
Description	Tests if this user can delete `DispatchConstrainerEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `DispatchConstrainerEnabler` 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 `DispatchConstrainerEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDispatchConstrainerEnabler
Description	Deletes a `DispatchConstrainerEnabler` .
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler` to remove
Errors	NOT_FOUND		`dispatchConstrainerEnablerId` not found
	NULL_ARGUMENT		`dispatchConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDispatchConstrainerEnablerAliases
Description	Tests if this user can manage `Id` aliases for `DispatchConstrainerEnablers` 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 `DispatchConstrainerEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDispatchConstrainerEnabler
Description	Adds an `Id` to a `DispatchConstrainerEnabler` for the purpose of creating compatibility. The primary `Id` of the `DispatchConstrainerEnabler` 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 constrainer enabler, it is reassigned to the given dispatch constrainer enabler `Id` .
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of a `DispatchConstrainerEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`dispatchConstrainerEnablerId` not found
	NULL_ARGUMENT		`dispatchConstrainerEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.