OSID - osid.messaging.MailboxAdminSession Service Interface Definition

Interface	osid.messaging.MailboxAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Mailboxes.` 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 `Mailbox,` a `MailboxForm` is requested using `getMailboxFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `MailboxForm` 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 `MailboxForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `MailboxForm` corresponds to an attempted transaction. For updates, `MailboxForms` are requested to the `Mailbox` `Id` that is to be updated using `getMailboxFormForUpdate().` Similarly, the `MailboxForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `MailboxForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Mailboxes.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateMailboxes
Description	Tests if this user can create `Mailboxes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Mailbox` 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 `Mailbox` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateMailboxWithRecordTypes
Description	Tests if this user can create a single `Mailbox` using the desired record types. While `MessagingManager.getMailboxRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Mailbox.` Providing an empty array tests if a `Mailbox` can be created with no records.
Parameters	`osid.type.Type[]`	`mailboxRecordTypes`	array of mailbox record types
Return	`boolean`		`true` if `Mailbox` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`mailboxRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxFormForCreate
Description	Gets the mailbox form for creating new mailboxes.
Parameters	`osid.type.Type[]`	`mailboxRecordTypes`	array of mailbox record types
Return	`osid.messaging.MailboxForm`		the mailbox form
Errors	NULL_ARGUMENT		`mailboxRecordTypes` 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	createMailbox
Description	Creates a new `Mailbox.`
Parameters	`osid.messaging.MailboxForm`	`mailboxForm`	the form for this `Mailbox`
Return	`osid.messaging.Mailbox`		the new `Mailbox`
Errors	ILLEGAL_STATE		`mailboxForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`mailboxForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`mailboxForm` did not originate from `getMailboxFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateMailboxes
Description	Tests if this user can update `Mailboxes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Mailbox` 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 `Mailbox` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxFormForUpdate
Description	Gets the mailbox form for updating an existing mailbox. A new mailbox form should be requested for each update transaction.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox`
Return	`osid.messaging.MailboxForm`		the mailbox form
Errors	NOT_FOUND		`mailboxId` is not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateMailbox
Description	Updates an existing mailbox.
Parameters	`osid.messaging.MailboxForm`	`mailboxForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`mailboxForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`mailboxForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`mailboxForm` did not originate from `getMailboxFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteMailboxes
Description	Tests if this user can delete `Mailboxes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Mailbox` 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 `Mailbox` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteMailbox
Description	Deletes a `Mailbox.`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of the `Mailbox` to remove
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageMailboxAliases
Description	Tests if this user can manage `Id` aliases for `Mailboxes.` 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 `Mailbox` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasMailbox
Description	Adds an `Id` to a `Mailbox` for the purpose of creating compatibility. The primary `Id` of the `Mailbox` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another mailbox, it is reassigned to the given mailbox `Id.`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of a `Mailbox`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.