OSID - osid.repository.AssetAdminSession Service Interface Definition

Interface	osid.repository.AssetAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Assets.` 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 an `Asset,` an `AssetForm` is requested using `getAssetFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AssetyForm` 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 `AssetForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AssetForm` corresponds to an attempted transaction. For updates, `AssetForms` are requested to the `Asset` `Id` that is to be updated using `getAssetFormForUpdate().` Similarly, the `AssetForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AssetForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Assets.` To unmap an `Asset` from the current `Repository,` the `AssetRepositoryAssignmentSession` should be used. These delete operations attempt to remove the `Bid` itself thus removing it from all known `Repository` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id. The view of the administrative methods defined in this session is determined by the provider. For an instance of this session where no repository has been specified, it may not be parallel to the `AssetLookupSession.` For example, a default `AssetLookupSession` may view the entire repository hierarchy while the default `AssetAdminSession` uses an isolated `Repository` to create new `Assets` or a specific repository to operate on a predetermined set of `Assets.` Another scenario is a federated provider who does not wish to permit administrative operations for the federation unaware. Example create: if (!session.canCreateAssets()) { return "asset creation not permitted"; } Type types[1]; types[0] = assetPhotographType; if (!session.canCreateAssetWithRecordTypes(types)) { return "creating an asset with a photograph type is not supported"; } AssetForm form = session.getAssetFormForCreate(); Metadata metadata = form.getDisplayNameMetadata(); if (metadata.isReadOnly()) { return "cannot set display name"; } form.setDisplayName("my photo"); PhotographRecordForm photoForm = (PhotographRecordForn) form.getRecordForm(assetPhotogaphType); Metadata metadata = form.getApertureMetadata(); if (metadata.isReadOnly()) { return ("cannot set aperture"); } photoForm.setAperture("5.6"); if (!form.isValid()) { return form.getValidationMessage(); } Asset newAsset = session.createAsset(form);
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the `Repository` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssets
Description	Tests if this user can create `Assets.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Asset` 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 `Asset` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssetWithRecordTypes
Description	Tests if this user can create a single `Asset` using the desired record types. While `RepositoryManager.getAssetRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Asset.` Providing an empty array tests if an `Asset` can be created with no records.
Parameters	`osid.type.Type[]`	`assetRecordTypes`	array of asset record types
Return	`boolean`		`true` if `Asset` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetFormForCreate
Description	Gets the asset form for creating new assets. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`assetRecordTypes`	array of asset record types
Return	`osid.repository.AssetForm`		the asset form
Errors	NULL_ARGUMENT		`assetRecordTypes` 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	createAsset
Description	Creates a new `Asset.`
Parameters	`osid.repository.AssetForm`	`assetForm`	the form for this `Asset`
Return	`osid.repository.Asset`		the new `Asset`
Errors	ILLEGAL_STATE		`assetForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`assetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assetForm` did not originate from `getAssetFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAssets
Description	Tests if this user can update `Assets.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Asset` 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 `Asset` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetFormForUpdate
Description	Gets the asset form for updating an existing asset. A new asset form should be requested for each update transaction.
Parameters	`osid.id.Id`	`assetId`	the `Id` of the `Asset`
Return	`osid.repository.AssetForm`		the asset form
Errors	NOT_FOUND		`assetId` is not found
	NULL_ARGUMENT		`assetId` is null
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAsset
Description	Updates an existing asset.
Parameters	`osid.repository.AssetForm`	`assetForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`assetForm` already used in anupdate transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`assetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assetForm` did not originate from `getAssetFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssets
Description	Tests if this user can delete `Assets.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Asset` 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 `Asset` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAsset
Description	Deletes an `Asset.`
Parameters	`osid.id.Id`	`assetId`	the `Id` of the `Asset` to remove
Errors	NOT_FOUND		`assetId` not found
	NULL_ARGUMENT		`assetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAssetAliases
Description	Tests if this user can manage `Id` aliases for `Assets.` 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 `Asset` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAsset
Description	Adds an `Id` to an `Asset` for the purpose of creating compatibility. The primary `Id` of the `Asset` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another asset, it is reassigned to the given asset `Id.`
Parameters	`osid.id.Id`	`assetId`	the `Id` of an `Asset`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`assetId` not found
	NULL_ARGUMENT		`assetId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssetContent
Description	Tests if this user can create content for `Assets.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AssetContent` 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 `Asset` content creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAssetContentWithRecordTypes
Description	Tests if this user can create an `AssetContent` using the desired record types. While `RepositoryManager.getAssetContentRecordTypes()` can be used to test which records are supported, this method tests which records are required for creating a specific `AssetContent.` Providing an empty array tests if an `AssetContent` can be created with no records.
Parameters	`osid.type.Type[]`	`assetContentRecordTypes`	array of asset content record types
Return	`boolean`		`true` if `AssetContent` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`assetContentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentFormForCreate
Description	Gets an asset content form for creating new assets.
Parameters	`osid.id.Id`	`assetId`	the `Id` of an `Asset`
Parameters	`osid.type.Type[]`	`assetContentRecordTypes`	array of asset content record types
Return	`osid.repository.AssetContentForm`		the asset content form
Errors	NOT_FOUND		`assetId` is not found
	NULL_ARGUMENT		`assetId` or `assetContentRecordTypes` 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	createAssetContent
Description	Creates new `AssetContent` for a given asset.
Parameters	`osid.repository.AssetContentForm`	`assetContentForm`	the form for this `AssetContent`
Return	`osid.repository.AssetContent`		the new `AssetContent`
Errors	ILLEGAL_STATE		`assetContentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`assetContentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assetContentForm` did not originate from `getAssetContentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAssetContents
Description	Tests if this user can update `AssetContent.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AssetContent` 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 `AssetContent` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentFormForUpdate
Description	Gets the asset content form for updating an existing asset content. A new asset content form should be requested for each update transaction.
Parameters	`osid.id.Id`	`assetContentId`	the `Id` of the `AssetContent`
Return	`osid.repository.AssetContentForm`		the asset content form
Errors	NOT_FOUND		`assetContentId` is not found
	NULL_ARGUMENT		`assetContentId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateAssetContent
Description	Updates an existing asset content.
Parameters	`osid.repository.AssetContentForm`	`assetContentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`assetContentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`assetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assetContentForm` did not originate from `getAssetContentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAssetContents
Description	Tests if this user can delete `AssetsContents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AssetContent` 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 `AssetContent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAssetContent
Description	Deletes content from an `Asset.`
Parameters	`osid.id.Id`	`assetContentId`	the `Id` of the `AssetContent`
Errors	NOT_FOUND		`assetContentId` is not found
	NULL_ARGUMENT		`assetContentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.