OSID - osid.contact.AddressAdminSession Service Interface Definition

Interface	osid.contact.AddressAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Addresses.` 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 an `Address,` an `AddressForm` is requested using `getAddressFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `AddressForm` 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 `AddressForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AddressForm` corresponds to an attempted transaction. For updates, `AddressForms` are requested to the `Address` `Id` that is to be updated using `getAddressFormForUpdate().` Similarly, the `AddressForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AddressForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Addresses.` To unmap an `Address` from the current `AddressBook,` the `AddressAddressBookAssignmentSession` should be used. These delete operations attempt to remove the `Address` itself thus removing it from all known `AddressBook` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getAddressBookId
Description	Gets the `AddressBook` `Id` associated with this session.
Return	`osid.id.Id`		the `AddressBook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBook
Description	Gets the `AddressBook` associated with this session.
Return	`osid.contact.AddressBook`		the address book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAddresses
Description	Tests if this user can create `Addresses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Address` 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 `Address` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAddressWithRecordTypes
Description	Tests if this user can create a single `Address` using the desired record types. While `ContactManager.getAddressRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Address.` Providing an empty array tests if an `Address` can be created with no records.
Parameters	`osid.type.Type[]`	`addressRecordTypes`	array of address record types
Return	`boolean`		`true` if `Address` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`addressRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressFormForCreate
Description	Gets the address form for creating new addresses. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`addressRecordTypes`	array of address record types
Return	`osid.contact.AddressForm`		the address form
Errors	NULL_ARGUMENT		`addressRecordTypes` 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	createAddress
Description	Creates a new `Address.`
Parameters	`osid.contact.AddressForm`	`addressForm`	the form for this `Address`
Return	`osid.contact.Address`		the new `Address`
Errors	ILLEGAL_STATE		`addressForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`addressForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`addressForm` did not originate from `getAddressFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAddresses
Description	Tests if this user can update `Addresses.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Address` 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 `Address` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressFormForUpdate
Description	Gets the address form for updating an existing address. A new address form should be requested for each update transaction.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address`
Return	`osid.contact.AddressForm`		the address form
Errors	NOT_FOUND		`addressId` is not found
	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAddress
Description	Updates an existing address.
Parameters	`osid.contact.AddressForm`	`addressForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`addressForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`addressId` or `addressForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`addressForm` did not originate from `getAddressFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAddresses
Description	Tests if this user can delete `Addresses` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Address` 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 `Address` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAddress
Description	Deletes an `Address.`
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address` to remove
Errors	NOT_FOUND		`addressId` not found
	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAddressAliases
Description	Tests if this user can manage `Id` aliases for `Addresses.` 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 `Address` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAddress
Description	Adds an `Id` to an `Address` for the purpose of creating compatibility. The primary `Id` of the `Address` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another address, it is reassigned to the given address `Id.`
Parameters	`osid.id.Id`	`addressId`	the `Id` of an `Address`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`addressId` not found
	NULL_ARGUMENT		`addressId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.