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

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