/extra/kbs/check_outs/co_356297/STABLE_geranium_lpm_cornsilk_10/dist/idl/js/toi/ToiAssetManagerService.idl

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *--------------------------------------------------------------------
 *
 * ToiAssetManagerService.idl
 *
 * This file was created by the Motorola IDL backend, 
 * which is based on the OmniORB IDL parser.
 * Please do not modify.
 *
 * Copyright (c) 2009 Motorola Inc. All Rights Reserved.
 *
 *--------------------------------------------------------------------
 */

#ifndef TOIASSETMANAGERSERVICE_IDL
#define TOIASSETMANAGERSERVICE_IDL

#include "TToiInvalidArgumentException.idl"
#include "TToiNotEnoughResourcesException.idl"
#include "TToiUnhandledValueException.idl"
#include "ToiApplicationService.idl"
#include "ToiOperationManager.idl"
#include "TToiPermissionDeniedException.idl"
#include "TToiNoDataException.idl"
#include "TToiOperationNotSupportedException.idl"
#include "ToiMultipleResult.idl"
#include "ToiEventTarget.idl"

//@ [Struct(Interface=IToiAssetManagerService,Name=TToiPropertyDefinition)]
interface ToiAssetManagerServicePropertyDefinition;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiProperty)]
interface ToiAssetManagerServiceProperty;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiAssetInfo)]
interface ToiAssetManagerServiceAssetInfo;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiDirectoryInfo)]
interface ToiAssetManagerServiceDirectoryInfo;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiSortCondition)]
interface ToiAssetManagerServiceSortCondition;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiQueryCondition)]
interface ToiAssetManagerServiceQueryCondition;
//@ [Struct(Interface=IToiAssetManagerService,Name=TToiAssetStorageInfo)]
interface ToiAssetManagerServiceAssetStorageInfo;

//@ [Service(Name=AssetManagerService)]
//@ [EventTarget(EventObserver=IToiAssetManagerObserver)]
interface ToiAssetManagerService : ToiEventTarget {

  
  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;
  
  const long ON_ASSET_STORAGE_ADDED = 306;
  
  const long ON_ASSET_STORAGE_REMOVED = 307;
  
  
  
  const ToiOperationManager::TToiOperationResult OP_RESULT_ASSET_INFO = 1;
  
  
  
  const ToiOperationManager::TToiOperationResult OP_RESULT_LONG = 2;
  
  
  //@ [Enum]
  typedef long TToiConditionOperation;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=EQUALS)]
  const TToiConditionOperation EQUALS = 0;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=NOT_EQUAL)]
  const TToiConditionOperation NOT_EQUAL = 1;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=GREATER)]
  const TToiConditionOperation GREATER = 2;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=LESS)]
  const TToiConditionOperation LESS = 3;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=GREATER_OR_EQUAL)]
  const TToiConditionOperation GREATER_OR_EQUAL = 4;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=LESS_OR_EQUAL)]
  const TToiConditionOperation LESS_OR_EQUAL = 5;
  
  //@ [Enumerator(Enum=TToiConditionOperation,Name=CONTAINS)]
  const TToiConditionOperation CONTAINS = 6;
  

  typedef long TToiQueryId;
  
  typedef string TToiAssetId;
  
  typedef sequence < TToiAssetId > TToiAssetIdSequence;
  
  //@ [Enum]
  typedef long TToiPropertyType;
  
  //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_BOOLEAN)]
  const TToiPropertyType TYPE_BOOLEAN = 0;
  
  //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_STRING)]
  const TToiPropertyType TYPE_STRING = 1;
  
  //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_INTEGER)]
  const TToiPropertyType TYPE_INTEGER = 2;
  
  //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_DATE)]
  const TToiPropertyType TYPE_DATE = 3;
  
  //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_ASSETLINK)]
  const TToiPropertyType TYPE_ASSETLINK = 4;
  

  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;
  
  const TToiDirectoryId ROOT_DIRECTORY = -1;
  
  
  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_SYSTEM_RECORDINGMODE = "system.recordingmode";
  
  
  
  const string PROPERTY_SYSTEM_BUFFERLENGTH = "system.bufferlength";
  
  
  
  const string PROPERTY_SYSTEM_ASSETSTORAGE = "system.assetstorage";
  
  
  
  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";
  
  
  
  const string PROPERTY_INFO_LOST_AND_FOUND = "info.lostandfound";
  
  //@ [Enum]
  typedef long TToiAssetType;
  
  //@ [Enumerator(Enum=TToiAssetType,Name=ASSET_PVR)]
  const TToiAssetType ASSET_PVR = 0;
  
  //@ [Enumerator(Enum=TToiAssetType,Name=ASSET_IMAGE)]
  const TToiAssetType ASSET_IMAGE = 1;
  
  //@ [Enumerator(Enum=TToiAssetType,Name=ASSET_AUDIO)]
  const TToiAssetType ASSET_AUDIO = 2;
  
  //@ [Enumerator(Enum=TToiAssetType,Name=ASSET_VIDEO)]
  const TToiAssetType ASSET_VIDEO = 3;
  

  //@ [Enum]
  typedef long TToiAssetRecordingMode;
  
  //@ [Enumerator(Enum=TToiAssetRecordingMode,Name=RECORDING_MODE_LINEAR)]
  const TToiAssetRecordingMode RECORDING_MODE_LINEAR = 0;
  
  //@ [Enumerator(Enum=TToiAssetRecordingMode,Name=RECORDING_MODE_CIRCULAR)]
  const TToiAssetRecordingMode RECORDING_MODE_CIRCULAR = 1;
  

  //@ [Enum]
  typedef long TToiAssetIntegrityStatus;
  
  //@ [Enumerator(Enum=TToiAssetIntegrityStatus,Name=INTEGRITY_UNKNOWN)]
  const TToiAssetIntegrityStatus INTEGRITY_UNKNOWN = 0;
  
  //@ [Enumerator(Enum=TToiAssetIntegrityStatus,Name=INTEGRITY_OK)]
  const TToiAssetIntegrityStatus INTEGRITY_OK = 1;
  
  //@ [Enumerator(Enum=TToiAssetIntegrityStatus,Name=INTEGRITY_COULD_NOT_UPGRADE)]
  const TToiAssetIntegrityStatus INTEGRITY_COULD_NOT_UPGRADE = 2;
  
  //@ [Enumerator(Enum=TToiAssetIntegrityStatus,Name=INTEGRITY_COULD_NOT_REPAIR)]
  const TToiAssetIntegrityStatus INTEGRITY_COULD_NOT_REPAIR = 3;
  

  typedef sequence < ToiAssetManagerServiceSortCondition > TToiSortConditionSequence;
  
  typedef sequence < ToiAssetManagerServiceQueryCondition > TToiQueryConditionSequence;
  
  //@ [Enum]
  typedef long TToiImportPolicy;
  
  //@ [Enumerator(Enum=TToiImportPolicy,Name=IMPORT_POLICY_COPY)]
  const TToiImportPolicy IMPORT_POLICY_COPY = 0;
  
  //@ [Enumerator(Enum=TToiImportPolicy,Name=IMPORT_POLICY_MOVE)]
  const TToiImportPolicy IMPORT_POLICY_MOVE = 1;
  

  typedef sequence < ToiAssetManagerServiceAssetStorageInfo > TToiAssetStorageInfoSequence;
  
  //@ [ReturnAddress(Type=IToiOperationManager)]
  
  
  //@ [OutParam(Name=address,Position=1,IsBinary=0, Bound=0)]
  ToiOperationManager getAssetOperationManager();
  
  //@ [OutParam(Name=dirId,Position=3,IsBinary=0, Bound=0)]
  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);
  
  //@ [OutParam(Name=info,Position=2,IsBinary=0, Bound=0)]
  ToiAssetManagerServiceDirectoryInfo getDirectoryInfo(in TToiDirectoryId dirId)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=childDirIds,Position=2,IsBinary=0, Bound=0)]
  TToiDirectoryIdSequence getDirectories(in TToiDirectoryId dirId)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=properties,Position=1,IsBinary=0, Bound=0)]
  TToiPropertyIdSequence getDefinedProperties();
  
  //@ [OutParam(Name=definition,Position=2,IsBinary=0, Bound=0)]
  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);
  
  //@ [OutParam(Name=assetId,Position=2,IsBinary=0, Bound=0)]
  TToiAssetId createAsset(in TToiAssetType assetType)
   raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException);
  
  //@ [OutParam(Name=assetId,Position=2,IsBinary=0, Bound=0)]
  TToiAssetId createAssetFromProperties(in TToiPropertySequence properties)
   raises (TToiOperationNotSupportedException, TToiInvalidArgumentException, TToiNotEnoughResourcesException);
  
  void convertAsset(in ToiOperationManager::TToiOperationId operationId, 
        in TToiAssetId assetId, 
        in TToiAssetRecordingMode newMode, 
        in unsigned long long startOffset)
   raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiPermissionDeniedException);
  
  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 long startOffset, 
        in unsigned long 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);
  
  //@ [ExtendIpcMessage(SoftLimit=100000)]
  
  
  //@ [ToiMultipleResult=ToiAssetManagerServiceGetAssetInfoResultRet]
  ToiMultipleResult getAssetInfoResult(in ToiOperationManager::TToiOperationId operationId, 
        in unsigned long maxCount)
   raises (TToiInvalidArgumentException, TToiNoDataException);
  
  //@ [OutParam(Name=value,Position=2,IsBinary=0, Bound=0)]
  unsigned long getLongResult(in ToiOperationManager::TToiOperationId operationId)
   raises (TToiInvalidArgumentException, TToiNoDataException);
  
  //@ [ExtendIpcMessage(SoftLimit=100000)]
  
  
  //@ [OutParam(Name=properties,Position=3,IsBinary=0, Bound=0)]
  TToiPropertySequence getProperties(in TToiAssetId assetId, 
        in TToiPropertyIdSequence requestedProperties)
   raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException);
  
  //@ [ExtendIpcMessage(SoftLimit=100000)]
  
  
  //@ [OutParam(Name=properties,Position=2,IsBinary=0, Bound=0)]
  TToiPropertySequence getAllProperties(in TToiAssetId assetId)
   raises (TToiInvalidArgumentException, TToiNoDataException, TToiNotEnoughResourcesException);
  
  //@ [OutParam(Name=assetStorages,Position=1,IsBinary=0, Bound=0)]
  TToiAssetStorageInfoSequence getAssetStorages();
  
  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);
  
};

#endif