OSID - osid.cataloging.rules.CatalogEnablerAdminSession Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes catalog enablers. The data for create and update is provided via the `CatalogEnablerForm.`
Method	getCatalogId
Description	Gets the `Catalog` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalog
Description	Gets the `Catalog` associated with this session.
Return	`osid.cataloging.Catalog`		the catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCatalogEnabler
Description	Tests if this user can create catalog enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CatalogEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `CatalogEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCatalogEnablerWithRecordTypes
Description	Tests if this user can create a single `CatalogEnabler` using the desired record types. While `CatalogingRulesManager.getCatalogEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CatalogEnabler.` Providing an empty array tests if a `CatalogEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`catalogEnablerRecordTypes`	array of catalog enabler record types
Return	`boolean`		`true` if `CatalogEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`catalogEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerFormForCreate
Description	Gets the catalog enabler form for creating new catalog enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`catalogEnablerRecordTypes`	array of catalog enabler record types
Return	`osid.cataloging.rules.CatalogEnablerForm`		the catalog enabler form
Errors	NULL_ARGUMENT		`catalogEnablerRecordTypes` 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	createCatalogEnabler
Description	Creates a new `CatalogEnabler.`
Parameters	`osid.cataloging.rules.CatalogEnablerForm`	`catalogEnablerForm`	the form for this `CatalogEnabler`
Return	`osid.cataloging.rules.CatalogEnabler`		the new `CatalogEnabler`
Errors	ILLEGAL_STATE		`catalogEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`catalogEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogEnablerForm` did not originate from `getCatalogEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCatalogEnablers
Description	Tests if this user can update catalog enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CatalogEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `CatalogEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablerFormForUpdate
Description	Gets the catalog enabler form for updating an existing catalog enabler. A new catalog enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler`
Return	`osid.cataloging.rules.CatalogEnablerForm`		the catalog enabler form
Errors	NOT_FOUND		`catalogEnablerId` is not found
	NULL_ARGUMENT		`catalogEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCatalogEnabler
Description	Updates an existing catalog enabler.
Parameters	`osid.cataloging.rules.CatalogEnablerForm`	`catalogEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`catalogEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`catalogEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`catalogEnablerForm` did not originate from `getCatalogEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCatalogEnablers
Description	Tests if this user can delete catalog enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CatalogEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `CatalogEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCatalogEnabler
Description	Deletes a `CatalogEnabler.`
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler` to remove
Errors	NOT_FOUND		`catalogEnablerId` not found
	NULL_ARGUMENT		`catalogEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCatalogEnablerAliases
Description	Tests if this user can manage `Id` aliases for catalog enablers. 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 `CatalogEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCatalogEnabler
Description	Adds an `Id` to a `CatalogEnabler` for the purpose of creating compatibility. The primary `Id` of the `CatalogEnabler` 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 enabler. it is reassigned to the given catalog enabler `Id.`
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of a `CatalogEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`catalogEnablerId` not found
	NULL_ARGUMENT		`catalogEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.