OSID - osid.messaging.MessageAdminSession Service Interface Definition

Interface	osid.messaging.MessageAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Messages.` 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 `Message,` a `MessageForm` is requested using `getMessageFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `MessageForm` 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 `MessageForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `MessageForm` corresponds to an attempted transaction. For updates, `MessageForms` are requested to the `Message` `Id` that is to be updated using `getMessageFormForUpdate().` Similarly, the `MessageForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `MessageForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Messages.` To unmap a `Message` from the current `Mailbox,` the `MessageMailboxAssignmentSession` should be used. These delete operations attempt to remove the `Message` itself thus removing it from all known `Mailbox` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getMailboxId
Description	Gets the `Mailbox` `Id` associated with this session.
Return	`osid.id.Id`		the `Mailbox Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMailbox
Description	Gets the `Mailbox` associated with this session.
Return	`osid.messaging.Mailbox`		the `Mailbox` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateMessages
Description	Tests if this user can create `Messages.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Message` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Message` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateMessageWithRecordTypes
Description	Tests if this user can create a single `Message` using the desired record types. While `MessagingManager.getMessageRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Message.` Providing an empty array tests if a `Message` can be created with no records.
Parameters	`osid.type.Type[]`	`messageRecordTypes`	array of message record types
Return	`boolean`		`true` if `Message` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`messageRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMessageFormForCreate
Description	Gets the message form for creating new messages. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`messageRecordTypes`	array of message record types
Return	`osid.messaging.MessageForm`		the message form
Errors	NULL_ARGUMENT		`messageRecordTypes` 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	createMessage
Description	Creates a new `Message.`
Parameters	`osid.messaging.MessageForm`	`messageForm`	the form for this `Message`
Return	`osid.messaging.Message`		the new `Message`
Errors	ILLEGAL_STATE		`messageForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`messageForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`messageForm` did not originate from `getMessageFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateMessages
Description	Tests if this user can update `Messages.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Message` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Message` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMessageFormForUpdate
Description	Gets the message form for updating an existing message. A new message form should be requested for each update transaction.
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message`
Return	`osid.messaging.MessageForm`		the message form
Errors	NOT_FOUND		`messageId` is not found
	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateMessage
Description	Updates an existing message.
Parameters	`osid.messaging.MessageForm`	`messageForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`messageForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`messageForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`messageForm` did not originate from `getMessageFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteMessages
Description	Tests if this user can delete `Messages.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Message` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Message` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteMessage
Description	Deletes a `Message.`
Parameters	`osid.id.Id`	`messageId`	the `Id` of the `Message` to remove
Errors	NOT_FOUND		`messageId` not found
	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageMessageAliases
Description	Tests if this user can manage `Id` aliases for `Messages.` 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 `Message` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasMessage
Description	Adds an `Id` to a `Message` for the purpose of creating compatibility. The primary `Id` of the `Message` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another message, it is reassigned to the given message `Id.`
Parameters	`osid.id.Id`	`messageId`	the `Id` of a `Message`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`messageId` not found
	NULL_ARGUMENT		`aliasId` or `messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.