OSID - osid.personnel.OrganizationAdminSession Service Interface Definition

Interface	osid.personnel.OrganizationAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.personnel.batch.OrganizationBatchAdminSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session creates, updates, and deletes `Organizations`. 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 `Organization`, an `OrganizationForm` is requested using `getOrganizationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OrganizationForm` 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 `OrganizationForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OrganizationForm` corresponds to an attempted transaction. For updates, `OrganizationForms` are requested to the `Organization` `Id` that is to be updated using `getOrganizationFormForUpdate()`. Similarly, the `OrganizationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OrganizationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Organizations`. To unmap an `Organization` from the current `Realm`, the `OrganizationRealmAssignmentSession` should be used. These delete operations attempt to remove the `Organization` itself thus removing it from all known `Realm` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOrganizations
Description	Tests if this user can create organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Organization` 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 `Organization` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOrganizationWithRecordTypes
Description	Tests if this user can create a single `Organization` using the desired record types. While `PersonnelManager.getOrganizationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Organization`. Providing an empty array tests if an `Organization` can be created with no records.
Parameters	`osid.type.Type[]`	`organizationRecordTypes`	array of organization record types
Return	`boolean`		`true` if `Organization` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`organizationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationFormForCreate
Description	Gets the organization form for creating new organizations. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`organizationRecordTypes`	array of organization record types to be included in the create operation or an empty list if none
Return	`osid.personnel.OrganizationForm`		the organization form
Errors	NULL_ARGUMENT		`organizationRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createOrganization
Description	Creates a new `Organization`.
Parameters	`osid.personnel.OrganizationForm`	`organizationForm`	the form for this `Organization`
Return	`osid.personnel.Organization`		the new `Organization`
Errors	ILLEGAL_STATE		`organizationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`organizationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`organizationForm` did not originate from `getOrganizationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOrganizations
Description	Tests if this user can update organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Organization` 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 `Organization` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationFormForUpdate
Description	Gets the organization form for updating an existing organization. A new organization form should be requested for each update transaction.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization`
Return	`osid.personnel.OrganizationForm`		the organization form
Errors	NOT_FOUND		`organizationId` is not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOrganization
Description	Updates an existing organization.
Parameters	`osid.personnel.OrganizationForm`	`organizationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`organizationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`organizationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`organizationForm` did not originate from `getOrganizationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOrganizations
Description	Tests if this user can delete organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Organization` 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 `Organization` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOrganization
Description	Deletes an `Organization`.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` to remove
Errors	NOT_FOUND		`organizationId` not found
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOrganizationAliases
Description	Tests if this user can manage `Id` aliases for `Organizations`. 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 `Organization` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOrganization
Description	Adds an `Id` to an `Organization` for the purpose of creating compatibility. The primary `Id` of the `Organization` is determined by the provider. The new `Id` is an alias to the primary `Id`. If the alias is a pointer to another organization, it is reassigned to the given organization `Id`.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of an `Organization`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`organizationId` not found
	NULL_ARGUMENT		`organizationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.