OSID - osid.subscription.DispatchAdminSession Service Interface Definition

Interface	osid.subscription.DispatchAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Dispatches.` 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 `Dispatch,` a `DispatchForm` is requested using `getDispatchFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `DispatchForm` 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 `DispatchForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `DispatchForm` corresponds to an attempted transaction. For updates, `DispatchForms` are requested to the `Dispatch` `Id` that is to be updated using `getDispatchFormForUpdate().` Similarly, the `DispatchForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `DispatchForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Dispatches.` To unmap a `Dispatch` from the current `Publisher,` the `DispatchPublisherAssignmentSession` should be used. These delete operations attempt to remove the `Dispatch` 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	canCreateDispatches
Description	Tests if this user can create `Dispatches.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Dispatch` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Dispatch` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDispatchWithRecordTypes
Description	Tests if this user can create a single `Dispatch` using the desired record interface types. While `SubscriptionManager.getDispatchRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Dispatch.` Providing an empty array tests if a `Dispatch` can be created with no records.
Parameters	`osid.type.Type[]`	`dispatchRecordTypes`	array of dispatch record types
Return	`boolean`		`true` if `Dispatch` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dispatchRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchFormForCreate
Description	Gets the dispatch form for creating new dispatches. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`dispatchRecordTypes`	array of dispatch record types
Return	`osid.subscription.DispatchForm`		the dispatch form
Errors	NULL_ARGUMENT		`dispatchRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get from for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createDispatch
Description	Creates a new `Dispatch.`
Parameters	`osid.subscription.DispatchForm`	`dispatchForm`	the form for this `Dispatch`
Return	`osid.subscription.Dispatch`		the new `Dispatch`
Errors	ILLEGAL_STATE		`dispatchForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`dispatchForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchForm` did not originate from `getDispatchFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDispatches
Description	Tests if this user can update `Dispatches.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Dispatch` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Dispatch` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchFormForUpdate
Description	Gets the dispatch form for updating an existing dispatch. A new dispatch form should be requested for each update transaction.
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Return	`osid.subscription.DispatchForm`		the dispatch form
Errors	NOT_FOUND		`dispatchId` is not found
	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDispatch
Description	Updates an existing dispatch.
Parameters	`osid.subscription.DispatchForm`	`dispatchForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`dispatchForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`dispatchId` or `dispatchForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`dispatchForm` did not originate from `getDispatchFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDispatches
Description	Tests if this user can delete `Dispatches` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Dispatch` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Dispatch` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDispatch
Description	Deletes a `Dispatch.`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch` to remove
Errors	NOT_FOUND		`dispatchId` not found
	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDispatchAliases
Description	Tests if this user can manage `Id` aliases for `Dispatches.` 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 `Dispatch` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDispatch
Description	Adds an `Id` to a `Dispatch` for the purpose of creating compatibility. The primary `Id` of the `Dispatch` 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, it is reassigned to the given dispatch `Id.`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of a `Dispatch`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`dispatchId` not found
	NULL_ARGUMENT		`dispatchId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.