OSID - osid.repository.RepositoryAdminSession Service Interface Definition

Interface	osid.repository.RepositoryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Repositories.` 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 `Repository,` a `RepositoryForm` is requested using `getRepositoryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RepositoryForm` 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 `RepositoryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RepositoryForm` corresponds to an attempted transaction. For updates, `RepositoryForms` are requested to the `Repository` `Id` that is to be updated using `getRepositoryFormForUpdate().` Similarly, the `RepositoryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RepositoryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Repositories.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateRepositories
Description	Tests if this user can create `Repositories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Repository` 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 `Repository` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRepositoryWithRecordTypes
Description	Tests if this user can create a single `Repository` using the desired record types. While `RepositoryManager.getRepositoryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Repository.` Providing an empty array tests if a `Repository` can be created with no records.
Parameters	`osid.type.Type[]`	`repositoryRecordTypes`	array of repository record types
Return	`boolean`		`true` if `Repository` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`repositoryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryFormForCreate
Description	Gets the repository form for creating new repositories. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`repositoryRecordTypes`	array of repository record types
Return	`osid.repository.RepositoryForm`		the repository form
Errors	NULL_ARGUMENT		`repositoryRecordTypes` 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	createRepository
Description	Creates a new `Repository.`
Parameters	`osid.repository.RepositoryForm`	`repositoryForm`	the form for this `Repository`
Return	`osid.repository.Repository`		the new `Repository`
Errors	ILLEGAL_STATE		`repositoryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`repositoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`repositoryForm` did not originate from `getRepositoryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRepositories
Description	Tests if this user can update `Repositories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Repository` 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 `Repository` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryFormForUpdate
Description	Gets the repository form for updating an existing repository. A new repository form should be requested for each update transaction.
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository`
Return	`osid.repository.RepositoryForm`		the repository form
Errors	NOT_FOUND		`repositoryId` is not found
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRepository
Description	Updates an existing repository.
Parameters	`osid.repository.RepositoryForm`	`repositoryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`repositoryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`repositoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`repositoryForm` did not originate from `getRepositoryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRepositories
Description	Tests if this user can delete `Repositories.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Repository` 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 `Repository` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRepository
Description	Deletes a `Repository.`
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of the `Repository` to remove
Errors	NOT_FOUND		`repositoryId` not found
	NULL_ARGUMENT		`repositoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRepositoryAliases
Description	Tests if this user can manage `Id` aliases for repositories. 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 `Repository` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRepository
Description	Adds an `Id` to a `Repository` for the purpose of creating compatibility. The primary `Id` of the `Repository` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another repository, it is reassigned to the given repository `Id.`
Parameters	`osid.id.Id`	`repositoryId`	the `Id` of a `Repository`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`repositoryId` not found
	NULL_ARGUMENT		`repositoryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.