OSID - osid.cataloging.CatalogAdminSession Service Interface Definition

Interface	osid.cataloging.CatalogAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Catalogs.` 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 `Catalog,` a `CatalogForm` is requested using `getCatalogFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CatalogForm` 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 `CatalogForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CatalogForm` corresponds to an attempted transaction. For updates, `CatalogForms` are requested to the `Catalog` `Id` that is to be updated using `getCatalogFormForUpdate().` Similarly, the `CatalogForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CatalogForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Catalogs.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateCatalogs
Description	Tests if this user can create `Catalogs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Catalog` 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 `Catalog` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCatalogWithRecordTypes
Description	Tests if this user can create a single `Catalog` using the desired record types. While `CatalogingManager.getCatalogRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Catalog.` Providing an empty array tests if a `Catalog` can be created with no records.
Parameters	`osid.type.Type[]`	`catalogRecordTypes`	array of catalog record types
Return	`boolean`		`true` if `Catalog` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`catalogRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogFormForCreate
Description	Gets the catalog form for creating new catalogs. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`catalogRecordTypes`	array of catalog record types
Return	`osid.cataloging.CatalogForm`		the catalog form
Errors	NULL_ARGUMENT		`catalogRecordTypes` 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	createCatalog
Description	Creates a new `Catalog.`
Parameters	`osid.cataloging.CatalogForm`	`catalogForm`	the form for this `Catalog`
Return	`osid.cataloging.Catalog`		the new `Catalog`
Errors	ILLEGAL_STATE		`catalogForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`catalogForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogForm` did not originate from `getCatalogFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCatalogs
Description	Tests if this user can update `Catalogs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Catalog` 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 `Catalog` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogFormForUpdate
Description	Gets the catalog form for updating an existing catalog. A new catalog form should be requested for each update transaction.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog`
Return	`osid.cataloging.CatalogForm`		the catalog form
Errors	NOT_FOUND		`catalogId` is not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCatalog
Description	Updates an existing catalog.
Parameters	`osid.cataloging.CatalogForm`	`catalogForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`catalogForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`catalogForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogForm` did not originate from `getCatalogFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCatalogs
Description	Tests if this user can delete `Catalogs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Catalog` 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 `Catalog` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCatalog
Description	Deletes a `Catalog.`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` to remove
Errors	NOT_FOUND		`catalogId` not found
	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCatalogAliases
Description	Tests if this user can manage `Id` aliases for `Catalogs.` 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 `Catalog` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCatalog
Description	Adds an `Id` to a `Catalog` for the purpose of creating compatibility. The primary `Id` of the `Catalog` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another catalog, it is reassigned to the given catalog `Id.`
Parameters	`osid.id.Id`	`catalogId`	the `Id` of a `Catalog`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`catalogId` not found
	NULL_ARGUMENT		`catalogId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.