OSID - osid.personnel.RealmAdminSession Service Interface Definition

Interface	osid.personnel.RealmAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Realms.` 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 `Realm,` a `RealmForm` is requested using `getRealmFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RealmForm` 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 `RealmForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RealmForm` corresponds to an attempted transaction. For updates, `RealmForms` are requested to the `Realm` `Id` that is to be updated using `getRealmFormForUpdate().` Similarly, the `RealmForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RealmForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Realms.` It is safer to remove all mappings to the `Realm` catalogs before deletion. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateRealms
Description	Tests if this user can create `Realms.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Realm` 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 `Realm` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRealmWithRecordTypes
Description	Tests if this user can create a single `Realm` using the desired record types. While `PersonnelManager.getRealmRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Realm.` Providing an empty array tests if a `Realm` can be created with no records.
Parameters	`osid.type.Type[]`	`realmRecordTypes`	array of types
Return	`boolean`		`true` if `Realm` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`realmRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRealmFormForCreate
Description	Gets the realm form for creating new realms. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`realmRecordTypes`	array of types
Return	`osid.personnel.RealmForm`		the realm form
Errors	NULL_ARGUMENT		`realmRecordTypes` 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	createRealm
Description	Creates a new `Realm.`
Parameters	`osid.personnel.RealmForm`	`realmForm`	the form for this `Realm`
Return	`osid.personnel.Realm`		the new `Realm`
Errors	ILLEGAL_STATE		`realmForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`realmForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`realmForm` did not originate from `getRealmFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRealms
Description	Tests if this user can update `Realms.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Realm` 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 `Realm` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRealmFormForUpdate
Description	Gets the realm form for updating an existing realm. A new realm form should be requested for each update transaction.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Return	`osid.personnel.RealmForm`		the realm form
Errors	NOT_FOUND		`realmId` is not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRealm
Description	Updates an existing realm.
Parameters	`osid.personnel.RealmForm`	`realmForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`realmForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`realmForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`realmForm did not originate from getRealmtFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRealms
Description	Tests if this user can delete `Realms` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Realm` 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 `Realm` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRealm
Description	Deletes a `Realm.`
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to remove
Errors	NOT_FOUND		`realmId` not found
	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRealmAliases
Description	Tests if this user can manage `Id` aliases for `Realms.` 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 `Realm` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRealm
Description	Adds an `Id` to a `Realm` for the purpose of creating compatibility. The primary `Id` of the `Item` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another realm, it is reassigned to the given realm `Id.`
Parameters	`osid.id.Id`	`realmId`	the `Id` of a `Realm`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`realmId` not found
	NULL_ARGUMENT		`realmId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.