ToiAssetManagerService Interface Reference

Description

Service:
This is a service and can be accessed through toi.assetManagerService

The ToiAssetManagerService interface provides access to locally stored media assets and metadata associated with these assets.

If no local media storage is available, then this service will not be available in the system.

import "ToiAssetManagerService.idl";

List of all members.

Public Member Functions

ToiOperationManager getAssetOperationManager ()
TToiDirectoryId createDirectory (in TToiDirectoryId parentId, in string title) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void moveDirectory (in TToiDirectoryId dirId, in TToiDirectoryId newParentId) raises (TToiInvalidArgumentException)
void setDirectoryProperties (in TToiDirectoryId dirId, in TToiPropertySequence properties) raises (TToiInvalidArgumentException)
void removeDirectoryProperties (in TToiDirectoryId dirId, in TToiPropertyIdSequence properties) raises (TToiInvalidArgumentException)
void removeDirectory (in TToiDirectoryId dirId, in boolean recursiveFlag, in boolean removeAssetsFlag) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
ToiAssetManagerServiceDirectoryInfo getDirectoryInfo (in TToiDirectoryId dirId) raises (TToiInvalidArgumentException)
TToiDirectoryIdSequence getDirectories (in TToiDirectoryId dirId) raises (TToiInvalidArgumentException)
TToiPropertyIdSequence getDefinedProperties ()
ToiAssetManagerServicePropertyDefinition getPropertyDefinition (in TToiPropertyId propertyId) raises (TToiInvalidArgumentException)
void createPropertyDefinition (in TToiPropertyId propertyId, in TToiPropertyType type, in boolean hasMultipleValueSupport) raises (TToiInvalidArgumentException)
void removePropertyDefinition (in TToiPropertyId propertyId) raises (TToiInvalidArgumentException)
TToiAssetId createAsset (in TToiAssetType assetType) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void importAsset (in ToiOperationManager::TToiOperationId operationId, in TToiAssetId assetId, in string uri, in TToiImportPolicy importPolicy) raises (TToiInvalidArgumentException, TToiNoDataException)
void removeAsset (in ToiOperationManager::TToiOperationId operationId, in TToiAssetId assetId) raises (TToiInvalidArgumentException, TToiNoDataException, TToiPermissionDeniedException)
void copyAsset (in ToiOperationManager::TToiOperationId operationId, in TToiAssetId sourceAssetId, in unsigned long startOffset, in unsigned long duration, in TToiAssetId destinationAssetId) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
void linkAssets (in TToiDirectoryId dirId, in TToiAssetIdSequence assetIds) raises (TToiInvalidArgumentException)
void unlinkAssets (in TToiDirectoryId dirId, in TToiAssetIdSequence assetIds) raises (TToiInvalidArgumentException)
void runQuery (in ToiOperationManager::TToiOperationId operationId, in TToiQueryConditionSequence queryConditions, in TToiPropertyIdSequence requestedProperties, in TToiSortConditionSequence sortConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void runQueryForDirectory (in ToiOperationManager::TToiOperationId operationId, in TToiDirectoryId directoryId, in TToiQueryConditionSequence queryConditions, in TToiPropertyIdSequence requestedProperties, in TToiSortConditionSequence sortConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
void runCountQuery (in ToiOperationManager::TToiOperationId operationId, in TToiQueryConditionSequence queryConditions) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)
ToiMultipleResult getAssetInfoResult (in ToiOperationManager::TToiOperationId operationId, in unsigned long maxCount) raises (TToiInvalidArgumentException, TToiNoDataException)
unsigned long getLongResult (in ToiOperationManager::TToiOperationId operationId) raises (TToiInvalidArgumentException, TToiNoDataException)
TToiPropertySequence getProperties (in TToiAssetId assetId, in TToiPropertyIdSequence requestedProperties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
TToiPropertySequence getAllProperties (in TToiAssetId assetId) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void setProperties (in TToiAssetId id, in TToiPropertySequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void removeProperties (in TToiAssetId id, in TToiPropertyIdSequence properties) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void removeMultiValuedPropertyValue (in TToiAssetId id, in ToiAssetManagerServiceProperty property) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)
void addEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)
void removeEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)

Public Attributes

const TToiDirectoryId ROOT_DIRECTORY = -1
Events

const long ON_ASSETS_ADDED = 300
const long ON_ASSETS_REMOVED = 301
const long ON_ASSETS_CHANGED = 302
const long ON_DIRECTORIES_ADDED = 303
const long ON_DIRECTORIES_REMOVED = 304
const long ON_DIRECTORIES_CHANGED = 305
Operation results

The result types defined for the Asset Manager operations. See ToiOperationManager for generic result types.

const
ToiOperationManager::TToiOperationResult 		OP_RESULT_ASSET_INFO = 1

const
ToiOperationManager::TToiOperationResult 		OP_RESULT_LONG = 2
TToiConditionOperation

const TToiConditionOperation EQUALS = 0
const TToiConditionOperation NOT_EQUAL = 1
const TToiConditionOperation GREATER = 2
const TToiConditionOperation LESS = 3
const TToiConditionOperation GREATER_OR_EQUAL = 4
const TToiConditionOperation LESS_OR_EQUAL = 5
const TToiConditionOperation CONTAINS = 6
TToiPropertyType

const TToiPropertyType TYPE_BOOLEAN = 0
const TToiPropertyType TYPE_STRING = 1
const TToiPropertyType TYPE_INTEGER = 2
const TToiPropertyType TYPE_DATE = 3
const TToiPropertyType TYPE_ASSETLINK = 4
Property constants

Constants for standard and recommended asset property identifiers. Properties named system.* are set by the platform while info.* properties can be set by applications.

const string PROPERTY_SYSTEM_DURATION = "system.duration"

const string PROPERTY_SYSTEM_FILESIZE = "system.filesize"

const string PROPERTY_SYSTEM_PLAYBACKURI = "system.playbackuri"

const string PROPERTY_SYSTEM_FILENAME = "system.filename"

const string PROPERTY_SYSTEM_TYPE = "system.type"

const string PROPERTY_SYSTEM_INTEGRITY_STATUS = "system.integritystatus"

const string PROPERTY_INFO_TITLE = "info.title"

const string PROPERTY_INFO_DATE = "info.date"

const string PROPERTY_INFO_DESCRIPTION = "info.description"

const string PROPERTY_INFO_LONGDESCRIPTION = "info.longdescription"

const string PROPERTY_INFO_CHANNELNAME = "info.channelname"

const string PROPERTY_INFO_RECORDINGSTATUS = "info.recordingstatus"

const string PROPERTY_INFO_MATURITYRATING = "info.maturityrating"

const string PROPERTY_INFO_SHARED = "info.shared"

const string PROPERTY_INFO_COVER = "info.cover"

const string PROPERTY_INFO_CHILDREN = "info.children"
TToiAssetType

const TToiAssetType ASSET_PVR = 0
const TToiAssetType ASSET_IMAGE = 1
const TToiAssetType ASSET_AUDIO = 2
const TToiAssetType ASSET_VIDEO = 3
TToiAssetIntegrityStatus

const TToiAssetIntegrityStatus INTEGRITY_UNKNOWN = 0
const TToiAssetIntegrityStatus INTEGRITY_OK = 1
const TToiAssetIntegrityStatus INTEGRITY_COULD_NOT_UPGRADE = 2
const TToiAssetIntegrityStatus INTEGRITY_COULD_NOT_REPAIR = 3
TToiImportPolicy

const TToiImportPolicy IMPORT_POLICY_COPY = 0
const TToiImportPolicy IMPORT_POLICY_MOVE = 1



typedef long TToiAssetType
const string PROPERTY_INFO_LOST_AND_FOUND = "info.lostandfound"

Public Types

typedef long TToiConditionOperation
typedef long TToiQueryId
typedef string TToiAssetId
typedef sequence< TToiAssetId > TToiAssetIdSequence
typedef long TToiPropertyType
typedef string TToiPropertyId
typedef sequence< TToiPropertyId > TToiPropertyIdSequence
typedef sequence< string > TToiPropertyValueSequence
typedef sequence
< ToiAssetManagerServiceProperty > 		TToiPropertySequence
typedef sequence
< ToiAssetManagerServiceAssetInfo > 		TToiAssetInfoSequence
typedef long TToiDirectoryId
typedef sequence< TToiDirectoryId > TToiDirectoryIdSequence
typedef long TToiAssetIntegrityStatus
typedef sequence
< ToiAssetManagerServiceSortCondition > 		TToiSortConditionSequence
typedef sequence
< ToiAssetManagerServiceQueryCondition > 		TToiQueryConditionSequence
typedef long TToiImportPolicy

Member Typedef Documentation

typedef string ToiAssetManagerService::TToiAssetId

Identifier that uniquely identifies an asset.

typedef sequence< TToiAssetId > ToiAssetManagerService::TToiAssetIdSequence

Sequence of asset identifiers.

typedef sequence< ToiAssetManagerServiceAssetInfo > ToiAssetManagerService::TToiAssetInfoSequence

List of ToiAssetManagerServiceAssetInfo structures

typedef long ToiAssetManagerService::TToiAssetIntegrityStatus

Identifies integrity status of an asset.

typedef long ToiAssetManagerService::TToiAssetType

Identifies different types of asset. This asset type is provided by the application while creating the asset.

typedef long ToiAssetManagerService::TToiConditionOperation

The ToiAssetManagerService::TToiConditionOperation enumerates possible operations that can be used to define a query condition.

typedef long ToiAssetManagerService::TToiDirectoryId

Identifer that uniquely identifies a directory.

typedef sequence< TToiDirectoryId > ToiAssetManagerService::TToiDirectoryIdSequence

Sequence of directory identifiers.

typedef long ToiAssetManagerService::TToiImportPolicy

Policy to be applied when importing an asset. Note that not all policies may be valid for all URIs which are imported.

typedef string ToiAssetManagerService::TToiPropertyId

Identifier for a metadata property.

typedef sequence< TToiPropertyId > ToiAssetManagerService::TToiPropertyIdSequence

Sequence of property identifiers.

typedef sequence< ToiAssetManagerServiceProperty > ToiAssetManagerService::TToiPropertySequence

Sequence of properties.

typedef long ToiAssetManagerService::TToiPropertyType

Different kind of property value types.

typedef sequence< string > ToiAssetManagerService::TToiPropertyValueSequence

Sequence of property values.

typedef sequence< ToiAssetManagerServiceQueryCondition > ToiAssetManagerService::TToiQueryConditionSequence

Sequence of query conditions.

typedef long ToiAssetManagerService::TToiQueryId

Query identifier.

typedef sequence< ToiAssetManagerServiceSortCondition > ToiAssetManagerService::TToiSortConditionSequence

List of sort conditions. The list is used for sorting asset results and the sort conditions are applied in order.

Member Function Documentation

void ToiEventTarget::addEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Parameters:
type The event type of the event to subscribe to.
listener The JavaScript function that will receive events.
Exceptions:
TInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.
void ToiAssetManagerService::copyAsset ( in ToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  sourceAssetId,
in unsigned long  startOffset,
in unsigned long  duration,
in TToiAssetId  destinationAssetId 
) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
Technical Preview:
This method is a TECHNICAL PREVIEW, it may change. Copies data from an existing source asset to a destination asset.
Parameters:
operationId The operation identifier created by ToiOperationManager
sourceAssetId The asset identifier for the source asset.
startOffset Offset (in milliseconds) relative to the source asset beginning to start the copy operation from.
duration The duration (in milliseconds) to be copied.
destinationAssetId The asset identifier for the destination asset.
Exceptions:
TToiInvalidArgumentException Raised if

  • the operation identifier is invalid
  • one or more of the asset identifiers are invalid
  • one or more of the asset types are not ASSET_PVR
  • the destination asset is not empty
  • duration is equal to zero or startOffset is not less than the source asset duration
TToiPermissionDeniedException Raised if the destination asset is locked.
TToiAssetId ToiAssetManagerService::createAsset ( in TToiAssetType  assetType  )  raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Creates an asset. If the type is ASSET_PVR, the identifier of the asset can be used with a media recorder to save a media stream to disk.

Parameters:
assetType The type of asset
Return values:
assetId The identifier of the created asset.
Exceptions:
TToiInvalidArgumentException Raised if the type is not supported.
TToiNotEnoughResourcesException Raised if the asset could not be created due to missing system resources.
See also:
ToiMediaRecorder::open()
TToiDirectoryId ToiAssetManagerService::createDirectory ( in TToiDirectoryId  parentId,
in string  title 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Creates a new directory.

Parameters:
parentId The identifier of the parent directory. Use ToiAssetManagerService::ROOT_DIRECTORY to create the top directories.
title The title to use for the directory.
Return values:
dirId The identifier of the created directory.
Exceptions:
TToiInvalidArgumentException Raised if the title is invalid or already taken, or if the parent identifier is invalid.
TToiNotEnoughResourcesException Raised if the directory could not be created due to missing system resources.
void ToiAssetManagerService::createPropertyDefinition ( in TToiPropertyId  propertyId,
in TToiPropertyType  type,
in boolean  hasMultipleValueSupport 
) raises (TToiInvalidArgumentException)

Creates a new property definition. This method is needed for creating properties that can have multiple values.

Parameters:
propertyId The identifier of the new property, a unique name.
type The property type.
hasMultipleValueSupport Whether the property can have multiple values.
Exceptions:
TToiInvalidArgumentException Raised if the name is already in use by a property.
TToiPropertySequence ToiAssetManagerService::getAllProperties ( in TToiAssetId  assetId  )  raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Returns all metadata properties for an asset.

Parameters:
assetId The asset identifier.
Return values:
properties The id/value pairs of all the asset's properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
ToiMultipleResult ToiAssetManagerService::getAssetInfoResult ( in ToiOperationManager::TToiOperationId  operationId,
in unsigned long  maxCount 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Used to get the query results once the applications recieve ToiOperationOperationResultEvent.

Parameters:
operationId The operation identifier of ToiAssetManagerService::runQuery().
maxCount The maximum number of objects the user are interested in, 0 if as many as possible shall be returned.
Return values:
objects The resulting asset information.
hasMore When true, there are some assets info in the cache of asset manager. Additional call to this method required.
Exceptions:
TToiInvalidArgumentException Raised if operation is unknown or does not support capability results.
TToiNoDataException Raised if no result is available.
ToiOperationManager ToiAssetManagerService::getAssetOperationManager (  ) 

Returns the operation manager that handles asynchronous operations for this asset manager. The procedure of executing asynchronous operations is generic and looks like this:

  • Get a handle to the operation manager.
  • Register an observer to get operation events from the operation manager.
  • Create an operation in order to get an operation identifier.
  • Call a asynchronous operation using the operation identifier.
  • Receive progress events for the asynchronous operation.
  • When the operation is completed, get result data (if any).
  • Release the operation or reuse the identifier for another asynchronous call.
Return values:
IToiOperationManager 
address The address to the ToiOperationManager.
TToiPropertyIdSequence ToiAssetManagerService::getDefinedProperties (  ) 

Returns the property identifiers for all defined properties also including all properties that are currently used in the database. This lists usually more properties than only those that have been created by ToiAssetManagerService::createPropertyDefinition().

Return values:
properties All defined property identifiers.
See also:
ToiAssetManagerService::createPropertyDefinition()
TToiDirectoryIdSequence ToiAssetManagerService::getDirectories ( in TToiDirectoryId  dirId  )  raises (TToiInvalidArgumentException)

Returns all direct directory children of given directory.

Parameters:
dirId The directory identifier. If it equals to ROOT all top level directory identifiers will be returned.
Return values:
childDirIds The list of directory identifiers.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
ToiAssetManagerServiceDirectoryInfo ToiAssetManagerService::getDirectoryInfo ( in TToiDirectoryId  dirId  )  raises (TToiInvalidArgumentException)

Returns directory information.

Parameters:
dirId The directory identifier.
Return values:
info The directory and its properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
unsigned long ToiAssetManagerService::getLongResult ( in ToiOperationManager::TToiOperationId  operationId  )  raises (TToiInvalidArgumentException, TToiNoDataException)

Used to get the count result once the applications recieve ToiOperationOperationResultEvent.

Parameters:
operationId The operation identifier.
Return values:
value The resulting long value from the operation.
Exceptions:
TToiInvalidArgumentException Raised if operation is unknown or does not have a long value as result.
TToiNoDataException Raised if no result is available.
TToiPropertySequence ToiAssetManagerService::getProperties ( in TToiAssetId  assetId,
in TToiPropertyIdSequence  requestedProperties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Returns metadata property values for an asset.

Parameters:
assetId The asset identifier.
requestedProperties The identifiers of the wanted properties.
Return values:
properties The id/value pairs of the requested properties.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
ToiAssetManagerServicePropertyDefinition ToiAssetManagerService::getPropertyDefinition ( in TToiPropertyId  propertyId  )  raises (TToiInvalidArgumentException)

Returns the property definition for a given property identifier.

Parameters:
propertyId The property identifier.
Return values:
definition The property definition.
Exceptions:
TToiInvalidArgumentException Raised if the property identifier is invalid.
void ToiAssetManagerService::importAsset ( in ToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  assetId,
in string  uri,
in TToiImportPolicy  importPolicy 
) raises (TToiInvalidArgumentException, TToiNoDataException)

Import an asset from an external source. This is an asynchronous operation and completion of the operation will not provide any result values, i.e. the result will always be ToiOperationManager::OP_RESULT_NONE.

Parameters:
operationId The operation identifier created by ToiOperationManager.
assetId The identifier of the asset. Currently, only assets of type ASSET_IMAGE are supported.
uri URI to the source to be imported. Currently, only file:// URIs are supported.
importPolicy Policy to be applied when importing source. For file URIs only IMPORT_POLICY_COPY and IMPORT_POLICY_MOVE are valid.
Exceptions:
TToiInvalidArgumentException Raised if the asset type, uri, or import policy is invalid.
TToiNoDataException Raised if there is a problem reading from uri or updating the new asset.
void ToiAssetManagerService::linkAssets ( in TToiDirectoryId  dirId,
in TToiAssetIdSequence  assetIds 
) raises (TToiInvalidArgumentException)

Links some assets to a directory, i.e. makes the assets visible as a member of the directory.

Parameters:
dirId The directory to link the assets to.
assetIds The assets to link.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier or one of the asset ids is invalid.
void ToiAssetManagerService::moveDirectory ( in TToiDirectoryId  dirId,
in TToiDirectoryId  newParentId 
) raises (TToiInvalidArgumentException)

Moves the directory to a new parent directory.

Parameters:
dirId The directory identifier.
newParentId The new parent directory identifier.
Exceptions:
TToiInvalidArgumentException Raised if either the directory identifier or the parent identifier is invalid.
void ToiAssetManagerService::removeAsset ( in ToiOperationManager::TToiOperationId  operationId,
in TToiAssetId  assetId 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiPermissionDeniedException)

Removes an asset. An asset can only be erased if the asset is not locked for playback or recording. This is an asynchronous operation and completion of the operation will not provide any result values, i.e. the result will always be ToiOperationManager::OP_RESULT_NONE.

Parameters:
operationId The operation identifier created by ToiOperationManager
assetId The asset identifier.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid.
TToiNoDataException Raised if there is no data to remove.
TToiPermissionDeniedException Raised if the asset is locked.
void ToiAssetManagerService::removeDirectory ( in TToiDirectoryId  dirId,
in boolean  recursiveFlag,
in boolean  removeAssetsFlag 
) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)

Remove a directory. The directory can only be removed if it is empty and does not contain any assets or directories. If the recursive flag is set all assets and directories will also be removed.

Parameters:
dirId The directory identifier.
recursiveFlag If true all child directories are also removed.
removeAssetsFlag If true all assets in the directories are also removed. This completely removes the asset and thus it will be removed from all directories it is linked to.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
TToiPermissionDeniedException Raised if the directory contains directories/assets and the corresponding override flag (recursive/remove) is not set.
void ToiAssetManagerService::removeDirectoryProperties ( in TToiDirectoryId  dirId,
in TToiPropertyIdSequence  properties 
) raises (TToiInvalidArgumentException)

Unsets the properties for a directory.

Parameters:
dirId The directory identifier.
properties The list of properties.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
void ToiEventTarget::removeEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

This method removes an event listener for a specific event.

Parameters:
type The event type of the event to remove the listener from.
listener The JavaScript function that was previously added as an event listener.
Exceptions:
TInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener had not previously been added.
void ToiAssetManagerService::removeMultiValuedPropertyValue ( in TToiAssetId  id,
in ToiAssetManagerServiceProperty  property 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Removes a value from a property that is multi-valued.

Parameters:
id The asset identifier.
property The id/value pair of the property from which the corresponding value should be removed.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be accessed for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void ToiAssetManagerService::removeProperties ( in TToiAssetId  id,
in TToiPropertyIdSequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Removes metadata properties for an asset. All values are erased whether a property has a single or multiple values, i.e., the property is completely removed.

Parameters:
id The asset identifier.
properties The properties to unset.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be accessed for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void ToiAssetManagerService::removePropertyDefinition ( in TToiPropertyId  propertyId  )  raises (TToiInvalidArgumentException)

Removes a user defined property, created using ToiAssetManagerService::createPropertyDefinition().

Parameters:
propertyId The identifier of the property to remove.
Exceptions:
TToiInvalidArgumentException Raised if the property identifier is invalid or not a user defined property.
void ToiAssetManagerService::runCountQuery ( in ToiOperationManager::TToiOperationId  operationId,
in TToiQueryConditionSequence  queryConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds the number of assets that match given conditions. This is an asynchronous operation. When application gets the ToiOperationOperationResultEvent with the operation result ToiAssetManagerService::OP_RESULT_LONG, then the application should get the result by calling the ToiAssetManagerService::getLongResult() function.

Parameters:
operationId The operation identifier created by ToiOperationManager
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be counted.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void ToiAssetManagerService::runQuery ( in ToiOperationManager::TToiOperationId  operationId,
in TToiQueryConditionSequence  queryConditions,
in TToiPropertyIdSequence  requestedProperties,
in TToiSortConditionSequence  sortConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds assets that match given conditions. This is an asynchronous operation. When the application receives a ToiOperationOperationResultEvent call with the operation result ToiAssetManagerService::OP_RESULT_ASSET_INFO, then the application should get the results by calling the ToiAssetManagerService::getAssetInfoResult() function. The resulting ToiAssetManagerServiceAssetInfo will only include property values for the requested properties.

Parameters:
operationId The operation identifier created by ToiOperationManager
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be in the result.
requestedProperties The properties that will be part of the result.
sortConditions Defines the sorting order for the result.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void ToiAssetManagerService::runQueryForDirectory ( in ToiOperationManager::TToiOperationId  operationId,
in TToiDirectoryId  directoryId,
in TToiQueryConditionSequence  queryConditions,
in TToiPropertyIdSequence  requestedProperties,
in TToiSortConditionSequence  sortConditions 
) raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException)

Starts a query that finds assets in the specified directory that match given conditions. This is an asynchronous operation. When the application receives a ToiOperationOperationResultEvent call with the operation result ToiAssetManagerService::OP_RESULT_ASSET_INFO, then the application should get the results by calling the ToiAssetManagerService::getAssetInfoResult() function. The resulting ToiAssetManagerServiceAssetInfo will only include property values for the requested properties.

Parameters:
operationId The operation identifier created by ToiOperationManager
directoryId The directory which assets will be matched.
queryConditions The conditions that define the query to be executed. Only assets with matching properties will be in the result.
requestedProperties The properties that will be part of the result.
sortConditions Defines the sorting order for the result.
Exceptions:
TToiInvalidArgumentException Raised if any of the conditions are invalid, or raised if the operation identifier is illegal.
TToiNotEnoughResourcesException Raised if it was not enough system resources to perform the query.
void ToiAssetManagerService::setDirectoryProperties ( in TToiDirectoryId  dirId,
in TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException)

Sets the properties for a directory.

Parameters:
dirId The directory identifier.
properties The list of properties.
Exceptions:
TToiInvalidArgumentException Raised if the directory identifier is invalid.
void ToiAssetManagerService::setProperties ( in TToiAssetId  id,
in TToiPropertySequence  properties 
) raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException)

Sets metadata property values for an asset. For properties that supports multiple values, any values set with this method are added to existing values.

Parameters:
id The asset identifier.
properties The properties to set data for.
Exceptions:
TToiInvalidArgumentException Raised if the asset identifier is invalid, or if a property identifier is invalid.
TToiNoDataException Raised if no data can be read for the asset.
TToiNotEnoughResourcesException Raised if the needed system resources are not accessible.
void ToiAssetManagerService::unlinkAssets ( in TToiDirectoryId  dirId,
in TToiAssetIdSequence  assetIds 
) raises (TToiInvalidArgumentException)

Removes the links from some assets to a directory.

Parameters:
dirId The directory to unlink the assets from.
assetIds The assets to unlink.
Exceptions:
TToiInvalidArgumentException Raised if the directory is identifier.

Member Data Documentation

const TToiAssetType ToiAssetManagerService::ASSET_AUDIO = 2

Identifier for audio asset type, NOT YET SUPPORTED.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ASSET_AUDIO.

const TToiAssetType ToiAssetManagerService::ASSET_IMAGE = 1

Identifier for image asset type

This constant can also be accessed from toi.consts.ToiAssetManagerService.ASSET_IMAGE.

const TToiAssetType ToiAssetManagerService::ASSET_PVR = 0

Identifier for recording asset type

This constant can also be accessed from toi.consts.ToiAssetManagerService.ASSET_PVR.

const TToiAssetType ToiAssetManagerService::ASSET_VIDEO = 3

Identifier for video (non-recording) asset type, NOT YET SUPPORTED.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ASSET_VIDEO.

const TToiConditionOperation ToiAssetManagerService::CONTAINS = 6

Contains specified value or matching pattern

This constant can also be accessed from toi.consts.ToiAssetManagerService.CONTAINS.

const TToiConditionOperation ToiAssetManagerService::EQUALS = 0

Equal operation, ==

This constant can also be accessed from toi.consts.ToiAssetManagerService.EQUALS.

const TToiConditionOperation ToiAssetManagerService::GREATER = 2

Greater operation, >

This constant can also be accessed from toi.consts.ToiAssetManagerService.GREATER.

const TToiConditionOperation ToiAssetManagerService::GREATER_OR_EQUAL = 4

Greater than or equal operation, >=

This constant can also be accessed from toi.consts.ToiAssetManagerService.GREATER_OR_EQUAL.

const TToiImportPolicy ToiAssetManagerService::IMPORT_POLICY_COPY = 0

Import asset by copying the source. The source is kept.

This constant can also be accessed from toi.consts.ToiAssetManagerService.IMPORT_POLICY_COPY.

const TToiImportPolicy ToiAssetManagerService::IMPORT_POLICY_MOVE = 1

Import asset by moving the source. The source is deleted.

This constant can also be accessed from toi.consts.ToiAssetManagerService.IMPORT_POLICY_MOVE.

const TToiAssetIntegrityStatus ToiAssetManagerService::INTEGRITY_COULD_NOT_REPAIR = 3

Asset has been damaged and could not be repaired. The asset can not be played.

This constant can also be accessed from toi.consts.ToiAssetManagerService.INTEGRITY_COULD_NOT_REPAIR.

const TToiAssetIntegrityStatus ToiAssetManagerService::INTEGRITY_COULD_NOT_UPGRADE = 2

Asset seems to be of an old version but could not be upgraded. The asset can not be played.

This constant can also be accessed from toi.consts.ToiAssetManagerService.INTEGRITY_COULD_NOT_UPGRADE.

const TToiAssetIntegrityStatus ToiAssetManagerService::INTEGRITY_OK = 1

Integrity is ok.

This constant can also be accessed from toi.consts.ToiAssetManagerService.INTEGRITY_OK.

const TToiAssetIntegrityStatus ToiAssetManagerService::INTEGRITY_UNKNOWN = 0

Integrity is unknown.

This constant can also be accessed from toi.consts.ToiAssetManagerService.INTEGRITY_UNKNOWN.

const TToiConditionOperation ToiAssetManagerService::LESS = 3

Less operation, <

This constant can also be accessed from toi.consts.ToiAssetManagerService.LESS.

const TToiConditionOperation ToiAssetManagerService::LESS_OR_EQUAL = 5

Less than or equal operation, <=

This constant can also be accessed from toi.consts.ToiAssetManagerService.LESS_OR_EQUAL.

const TToiConditionOperation ToiAssetManagerService::NOT_EQUAL = 1

Not equal operation, !=

This constant can also be accessed from toi.consts.ToiAssetManagerService.NOT_EQUAL.

const long ToiAssetManagerService::ON_ASSETS_ADDED = 300

This is an Event identifier for ToiAssetManagerAssetsAddedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_ASSETS_ADDED.

const long ToiAssetManagerService::ON_ASSETS_CHANGED = 302

This is an Event identifier for ToiAssetManagerAssetsChangedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_ASSETS_CHANGED.

const long ToiAssetManagerService::ON_ASSETS_REMOVED = 301

This is an Event identifier for ToiAssetManagerAssetsRemovedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_ASSETS_REMOVED.

const long ToiAssetManagerService::ON_DIRECTORIES_ADDED = 303

This is an Event identifier for ToiAssetManagerDirectoriesAddedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_DIRECTORIES_ADDED.

const long ToiAssetManagerService::ON_DIRECTORIES_CHANGED = 305

This is an Event identifier for ToiAssetManagerDirectoriesChangedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_DIRECTORIES_CHANGED.

const long ToiAssetManagerService::ON_DIRECTORIES_REMOVED = 304

This is an Event identifier for ToiAssetManagerDirectoriesRemovedEvent.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ON_DIRECTORIES_REMOVED.

const ToiOperationManager::TToiOperationResult ToiAssetManagerService::OP_RESULT_ASSET_INFO = 1

The asynchronous operation has asset info as result. See ToiAssetManagerService::getAssetInfoResult().

This constant can also be accessed from toi.consts.ToiAssetManagerService.OP_RESULT_ASSET_INFO.

const ToiOperationManager::TToiOperationResult ToiAssetManagerService::OP_RESULT_LONG = 2

The asynchronous operation has a long value as result. See ToiAssetManagerService::getLongResult().

This constant can also be accessed from toi.consts.ToiAssetManagerService.OP_RESULT_LONG.

const string ToiAssetManagerService::PROPERTY_INFO_CHANNELNAME = "info.channelname"

Property name for the channel name of a recorded asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_CHANNELNAME.

const string ToiAssetManagerService::PROPERTY_INFO_CHILDREN = "info.children"

Property name for a list of assets which will be removed automatically when the asset is removed. Relevant for all asset types.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_CHILDREN.

const string ToiAssetManagerService::PROPERTY_INFO_COVER = "info.cover"

Property name for the cover image associated with an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_COVER.

const string ToiAssetManagerService::PROPERTY_INFO_DATE = "info.date"

Property name for the start time of an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_DATE.

const string ToiAssetManagerService::PROPERTY_INFO_DESCRIPTION = "info.description"

Property name for the description of an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_DESCRIPTION.

const string ToiAssetManagerService::PROPERTY_INFO_LONGDESCRIPTION = "info.longdescription"

Property name for an even more detailed description of an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_LONGDESCRIPTION.

const string ToiAssetManagerService::PROPERTY_INFO_LOST_AND_FOUND = "info.lostandfound"

Property name for the lost and found flag. If this flag is set the asset has been created from a lost asset by the platform. This can happen if the asset has been updated from a legacy version or if the database has been damaged. Relevant for all asset types.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_LOST_AND_FOUND.

const string ToiAssetManagerService::PROPERTY_INFO_MATURITYRATING = "info.maturityrating"

Property name for the maturity rating of an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_MATURITYRATING.

const string ToiAssetManagerService::PROPERTY_INFO_RECORDINGSTATUS = "info.recordingstatus"

Property name for the status of a recorded asset. Recommended values are: recording|completed|failed

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_RECORDINGSTATUS.

const string ToiAssetManagerService::PROPERTY_INFO_SHARED = "info.shared"

Property name for the flag indicating that the asset or directory shall be exposed and shared with other devices in the home network if DMS support is activated.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_SHARED.

const string ToiAssetManagerService::PROPERTY_INFO_TITLE = "info.title"

Property name for the title of an asset.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_INFO_TITLE.

const string ToiAssetManagerService::PROPERTY_SYSTEM_DURATION = "system.duration"

Property name for the time duration of an asset in seconds. Supported by all asset types except ASSET_IMAGE.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_DURATION.

const string ToiAssetManagerService::PROPERTY_SYSTEM_FILENAME = "system.filename"

Property name for the file name for imported assets (e.g. images). Supported by all asset types execpt ASSET_PVR.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_FILENAME.

const string ToiAssetManagerService::PROPERTY_SYSTEM_FILESIZE = "system.filesize"

Property name for the file size of an asset. Supported by all asset types.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_FILESIZE.

const string ToiAssetManagerService::PROPERTY_SYSTEM_INTEGRITY_STATUS = "system.integritystatus"

Property name for the integrity status of an asset. Supported by all asset types. See ToiAssetManagerService::TToiAssetIntegrityStatus for possible values.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_INTEGRITY_STATUS.

const string ToiAssetManagerService::PROPERTY_SYSTEM_PLAYBACKURI = "system.playbackuri"

Property name for the URI to use when starting playback of an asset. Supported by all asset types except ASSET_IMAGE.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_PLAYBACKURI.

const string ToiAssetManagerService::PROPERTY_SYSTEM_TYPE = "system.type"

Property name for the type of an asset. Supported by all asset types. See ToiAssetManagerService::TToiAssetType for possible values.

This constant can also be accessed from toi.consts.ToiAssetManagerService.PROPERTY_SYSTEM_TYPE.

const TToiDirectoryId ToiAssetManagerService::ROOT_DIRECTORY = -1

Identifier for the root directory.

This constant can also be accessed from toi.consts.ToiAssetManagerService.ROOT_DIRECTORY.

const TToiPropertyType ToiAssetManagerService::TYPE_ASSETLINK = 4

An asset identifier.

This constant can also be accessed from toi.consts.ToiAssetManagerService.TYPE_ASSETLINK.

const TToiPropertyType ToiAssetManagerService::TYPE_BOOLEAN = 0

Value of true/false.

This constant can also be accessed from toi.consts.ToiAssetManagerService.TYPE_BOOLEAN.

const TToiPropertyType ToiAssetManagerService::TYPE_DATE = 3

A positive integer value, seconds since the epoch.

This constant can also be accessed from toi.consts.ToiAssetManagerService.TYPE_DATE.

const TToiPropertyType ToiAssetManagerService::TYPE_INTEGER = 2

A signed integer value.

This constant can also be accessed from toi.consts.ToiAssetManagerService.TYPE_INTEGER.

const TToiPropertyType ToiAssetManagerService::TYPE_STRING = 1

Any string value.

This constant can also be accessed from toi.consts.ToiAssetManagerService.TYPE_STRING.