OSID - osid.hierarchy.HierarchyAdminSession Service Interface Definition

Interface	osid.hierarchy.HierarchyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Hierarchies.` 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 `Hierarchy,` a `HierarchyForm` is requested using `getHierarchyFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `HierarchyForm` 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 `HierarchyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `HierarchyForm` corresponds to an attempted transaction. For updates, `HierarchyForms` are requested to the `Hierarchy` `Id` that is to be updated using `getHierarchyFormForUpdate().` Similarly, the `HierarchyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `HierarchyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Hierarchies.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateHierarchies
Description	Tests if this user can create `Hierarchy` objects. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Hierarchy` 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 `Hierarchy` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateHierarchyWithRecordTypes
Description	Tests if this user can create a single `Hierarchy` using the desired record types. While `HierarchyManager.getHierarchyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Hierarchy.` Providing an empty array tests if a `Hierarchy` can be created with no records.
Parameters	`osid.type.Type[]`	`hierarchyRecordTypes`	array of hierarchy record types
Return	`boolean`		`true` if `Hierarchy` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`hierarchyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyFormForCreate
Description	Gets the hierarchy form for creating new hierarchies. A new form should be requested for each create transaction. This method is used for creating new hierarchies, where only the `Hierarchy` `Type` is known.
Parameters	`osid.type.Type[]`	`hierarchyRecordTypes`	array of hierarchy record types
Return	`osid.hierarchy.HierarchyForm`		the hierarchy form
Errors	NULL_ARGUMENT		`hierarchyRecordTypes` 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	createHierarchy
Description	Creates a new `Hierarchy.`
Parameters	`osid.hierarchy.HierarchyForm`	`hierarchyForm`	the form for this `Hierarchy`
Return	`osid.hierarchy.Hierarchy`		the new `Hierarchy`
Errors	ILLEGAL_STATE		`hierarchyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`hierarchyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`hierarchyForm` did not originate from `getHierarchyFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateHierarchies
Description	Tests if this user can update `Hierarchy` objects. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Hierarchy` 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 `Hierarchy` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyFormForUpdate
Description	Gets the hierarchy form for updating an existing hierarchy. A new hierarchy form should be requested for each update transaction.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the `Hierarchy`
Return	`osid.hierarchy.HierarchyForm`		the hierarchy form
Errors	NOT_FOUND		`hierarchyId` is not found
	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateHierarchy
Description	Updates an existing hierarchy.
Parameters	`osid.hierarchy.HierarchyForm`	`hierarchyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`hierarchyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`hierarchyId` or `hierarchyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`hierarchyForm` did not originate from `getHierarchyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteHierarchies
Description	Tests if this user can delete `Hierarchy` objects. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Hierarchy` 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 `Hierarchy` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteHierarchy
Description	Deletes a `Hierarchy.`
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the `Hierarchy` to remove
Errors	NOT_FOUND		`hierarchyId` not found
	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageHierarchyAliases
Description	Tests if this user can manage `Id` aliases for `Hierarchy` objects. 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 `Hierarchy` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasHierarchy
Description	Adds an `Id` to a `Hierarchy` for the purpose of creating compatibility. The primary `Id` of the `Hierarchy` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another vault it is reassigned to the given vault `Id.`
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of an `Hierarchy`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`hierarchyId` not found
	NULL_ARGUMENT		`hierarchyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.