Motorola Mobility Confidential Restricted.
/extra/kbs/check_outs/co_206438/STABLE_geranium_lpm_cornsilk_1/dist/idl/js/toi/ToiDlnaContentDirectoryService.idl
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *--------------------------------------------------------------------
00003  *
00004  * ToiDlnaContentDirectoryService.idl
00005  *
00006  * This file was created by the Motorola IDL backend, 
00007  * which is based on the OmniORB IDL parser.
00008  * Please do not modify.
00009  *
00010  * Copyright (c) 2009 Motorola Inc. All Rights Reserved.
00011  *
00012  *--------------------------------------------------------------------
00013  */
00014 
00015 #ifndef TOIDLNACONTENTDIRECTORYSERVICE_IDL
00016 #define TOIDLNACONTENTDIRECTORYSERVICE_IDL
00017 
00018 #include "TToiInvalidArgumentException.idl"
00019 #include "TToiOperationNotSupportedException.idl"
00020 #include "TToiNoDataException.idl"
00021 #include "TToiNotEnoughResourcesException.idl"
00022 #include "TToiUnhandledValueException.idl"
00023 #include "ToiApplicationService.idl"
00024 #include "ToiOperationManager.idl"
00025 #include "ToiMultipleResult.idl"
00026 #include "ToiEventTarget.idl"
00027 
00028 //@ [Struct(Interface=IToiDlnaContentDirectoryService,Name=TToiProperty)]
00029 interface ToiDlnaContentDirectoryServiceProperty;
00030 //@ [Struct(Interface=IToiDlnaContentDirectoryService,Name=TToiCdsObject)]
00031 interface ToiDlnaContentDirectoryServiceCdsObject;
00032 //@ [Struct(Interface=IToiDlnaContentDirectoryService,Name=TToiCdsCapabilities)]
00033 interface ToiDlnaContentDirectoryServiceCdsCapabilities;
00034 
00117 //@ [EventTarget(EventObserver=IToiDlnaContentDirectoryObserver)]
00118 
00119 //@ [ReleaseInstance(Method=ReleaseInstance)]
00120 interface ToiDlnaContentDirectoryService : ToiEventTarget {
00121 
00124   
00128   const long ON_CONTAINER_CHANGED = 500;
00129   
00131   
00138   
00144   const ToiOperationManager::TToiOperationResult OP_RESULT_OBJECT = 1;
00145   
00151   const ToiOperationManager::TToiOperationResult OP_RESULT_CAPABILITY = 2;
00152   
00154   
00161   
00166   const ToiOperationManager::TToiOperationError OP_ERROR_INVALID_ARGUMENTS = -3;
00167   
00172   const ToiOperationManager::TToiOperationError OP_ERROR_INVALID_ACTION = -4;
00173   
00178   const ToiOperationManager::TToiOperationError OP_ERROR_UNSUPPORTED_SEARCH_CRITERIA = -5;
00179   
00184   const ToiOperationManager::TToiOperationError OP_ERROR_UNSUPPORTED_SORT_CRITERIA = -6;
00185   
00190   const ToiOperationManager::TToiOperationError OP_ERROR_NO_SUCH_CONTAINER = -7;
00191   
00196   const ToiOperationManager::TToiOperationError OP_ERROR_RESTRICTED = -8;
00197   
00202   const ToiOperationManager::TToiOperationError OP_ERROR_CAN_NOT_PROCESS_REQUEST = -9;
00203   
00205   
00207   typedef long TToiPropertyId;
00208   
00210   typedef sequence < TToiPropertyId > TToiPropertyIdSequence;
00211   
00213   typedef sequence < ToiDlnaContentDirectoryServiceProperty > TToiPropertySequence;
00214   
00219   typedef sequence < long > TToiSortIdSequence;
00220   
00227   
00232   const TToiPropertyId PROPERTY_OBJECT_ATTR_CHILD_COUNT = 11;
00233   
00238   const TToiPropertyId PROPERTY_OBJECT_ATTR_SEARCHABLE = 12;
00239   
00244   const TToiPropertyId PROPERTY_OBJECT_ATTR_REF_ID = 13;
00245   
00250   const TToiPropertyId PROPERTY_OBJECT_ATTR_RESTRICTED = 14;
00251   
00256   const TToiPropertyId PROPERTY_CREATE_CLASS = 20;
00257   
00262   const TToiPropertyId PROPERTY_CREATE_CLASS_ATTR_INCLUDE_DERIVED = 21;
00263   
00268   const TToiPropertyId PROPERTY_CREATE_CLASS_ATTR_NAME = 22;
00269   
00274   const TToiPropertyId PROPERTY_CREATOR = 30;
00275   
00281   const TToiPropertyId PROPERTY_DATE = 40;
00282   
00287   const TToiPropertyId PROPERTY_DESCRIPTION = 50;
00288   
00293   const TToiPropertyId PROPERTY_LANGUAGE = 60;
00294   
00299   const TToiPropertyId PROPERTY_RES = 70;
00300   
00305   const TToiPropertyId PROPERTY_RES_ATTR_BITRATE = 71;
00306   
00311   const TToiPropertyId PROPERTY_RES_ATTR_BITS_PER_SAMPLE = 72;
00312   
00317   const TToiPropertyId PROPERTY_RES_ATTR_COLOR_DEPTH = 73;
00318   
00332   const TToiPropertyId PROPERTY_RES_ATTR_DURATION = 74;
00333   
00338   const TToiPropertyId PROPERTY_RES_ATTR_IMPORT_URI = 75;
00339   
00344   const TToiPropertyId PROPERTY_RES_ATTR_AUDIO_CHANNELS_COUNT = 76;
00345   
00350   const TToiPropertyId PROPERTY_RES_ATTR_PROTOCOL_INFO = 77;
00351   
00356   const TToiPropertyId PROPERTY_RES_ATTR_RESOLUTION = 78;
00357   
00362   const TToiPropertyId PROPERTY_RES_ATTR_SAMPLE_FREQUENCY = 79;
00363   
00369   const TToiPropertyId PROPERTY_RES_ATTR_SIZE = 80;
00370   
00375   const TToiPropertyId PROPERTY_RES_ATTR_PROTECTION = 81;
00376   
00382   const TToiPropertyId PROPERTY_RES_RENDER_SUPPORTED = 82;
00383   
00388   const TToiPropertyId PROPERTY_SEARCH_CLASS = 90;
00389   
00394   const TToiPropertyId PROPERTY_SEARCH_CLASS_ATTR_INCLUDE_DERIVED = 91;
00395   
00400   const TToiPropertyId PROPERTY_SEARCH_CLASS_ATTR_NAME = 92;
00401   
00406   const TToiPropertyId PROPERTY_ACTOR = 100;
00407   
00412   const TToiPropertyId PROPERTY_ALBUM = 110;
00413   
00418   const TToiPropertyId PROPERTY_ARTIST = 120;
00419   
00424   const TToiPropertyId PROPERTY_AUTHOR = 130;
00425   
00430   const TToiPropertyId PROPERTY_PRODUCER = 140;
00431   
00436   const TToiPropertyId PROPERTY_DIRECTOR = 150;
00437   
00442   const TToiPropertyId PROPERTY_PUBLISHER = 160;
00443   
00448   const TToiPropertyId PROPERTY_CONTRIBUTOR = 170;
00449   
00454   const TToiPropertyId PROPERTY_GENRE = 180;
00455   
00460   const TToiPropertyId PROPERTY_ICON = 190;
00461   
00466   const TToiPropertyId PROPERTY_ORIGINAL_TRACK_NUMBER = 200;
00467   
00472   const TToiPropertyId PROPERTY_PLAYLIST = 210;
00473   
00478   const TToiPropertyId PROPERTY_RATING = 220;
00479   
00484   const TToiPropertyId PROPERTY_SCHEDULED_START_TIME = 230;
00485   
00490   const TToiPropertyId PROPERTY_SCHEDULED_END_TIME = 240;
00491   
00496   const TToiPropertyId PROPERTY_CHANNEL_NAME = 250;
00497   
00502   const TToiPropertyId PROPERTY_CHANNEL_NR = 260;
00503   
00508   const TToiPropertyId PROPERTY_STORAGE_FREE = 270;
00509   
00514   const TToiPropertyId PROPERTY_STORAGE_MAX_PARTITION = 280;
00515   
00520   const TToiPropertyId PROPERTY_STORAGE_MEDIUM = 290;
00521   
00526   const TToiPropertyId PROPERTY_STORAGE_TOTAL = 300;
00527   
00532   const TToiPropertyId PROPERTY_STORAGE_USED = 310;
00533   
00538   const TToiPropertyId PROPERTY_WRITE_STATUS = 320;
00539   
00544   const TToiPropertyId PROPERTY_REGION = 330;
00545   
00550   const TToiPropertyId PROPERTY_LONG_DESCRIPTION = 340;
00551   
00556   const TToiPropertyId PROPERTY_RADIO_CALL_SIGN = 350;
00557   
00562   const TToiPropertyId PROPERTY_RADIO_STATION_ID = 360;
00563   
00568   const TToiPropertyId PROPERTY_RADIO_BAND = 370;
00569   
00574   const TToiPropertyId PROPERTY_USER_ANNOTATION = 380;
00575   
00580   const TToiPropertyId PROPERTY_CLASS = 390;
00581   
00586   const TToiPropertyId PROPERTY_TITLE = 400;
00587   
00593   const TToiPropertyId PROPERTY_RES_PI_PROTOCOL = 410;
00594   
00600   const TToiPropertyId PROPERTY_RES_PI_MIME_TYPE = 411;
00601   
00607   const TToiPropertyId PROPERTY_RES_PI_PROFILE_NAME = 412;
00608   
00614   const TToiPropertyId PROPERTY_RES_PI_OPERATIONS = 413;
00615   
00621   const TToiPropertyId PROPERTY_RES_PI_PLAY_SPEED = 414;
00622   
00628   const TToiPropertyId PROPERTY_RES_PI_CONVERSION_INDICATOR = 415;
00629   
00635   const TToiPropertyId PROPERTY_RES_PI_FLAGS = 416;
00636   
00642   const TToiPropertyId PROPERTY_RES_PI_MAX_RTSP_SPEED = 417;
00643   
00645   typedef sequence < ToiDlnaContentDirectoryServiceCdsObject > TToiCdsObjectSequence;
00646   
00649   //@ [Enum]
00650   typedef long TToiPropertyType;
00653   
00659   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_STRING)]
00660   const TToiPropertyType TYPE_STRING = 0;
00661   
00667   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_INTEGER)]
00668   const TToiPropertyType TYPE_INTEGER = 1;
00669   
00675   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_BOOLEAN)]
00676   const TToiPropertyType TYPE_BOOLEAN = 2;
00677   
00683   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_DATE)]
00684   const TToiPropertyType TYPE_DATE = 3;
00685   
00692   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_RESOLUTION)]
00693   const TToiPropertyType TYPE_RESOLUTION = 4;
00694   
00700   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_DURATION)]
00701   const TToiPropertyType TYPE_DURATION = 5;
00702   
00704 
00708   //@ [Enum]
00709   typedef long TToiCdsActionCapability;
00712   
00719   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_CREATE_OBJECT)]
00720   const TToiCdsActionCapability CDS_CAPABILITY_CREATE_OBJECT = 0x1;
00721   
00728   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_DESTROY_OBJECT)]
00729   const TToiCdsActionCapability CDS_CAPABILITY_DESTROY_OBJECT = 0x2;
00730   
00737   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_SEARCH)]
00738   const TToiCdsActionCapability CDS_CAPABILITY_SEARCH = 0x4;
00739   
00746   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_IMPORT_RESOURCE)]
00747   const TToiCdsActionCapability CDS_CAPABILITY_IMPORT_RESOURCE = 0x8;
00748   
00755   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_EXPORT_RESOURCE)]
00756   const TToiCdsActionCapability CDS_CAPABILITY_EXPORT_RESOURCE = 0x10;
00757   
00764   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_STOP_TRANSFER_PROGRESS)]
00765   const TToiCdsActionCapability CDS_CAPABILITY_STOP_TRANSFER_PROGRESS = 0x20;
00766   
00773   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_GET_TRANSFER_PROGRESS)]
00774   const TToiCdsActionCapability CDS_CAPABILITY_GET_TRANSFER_PROGRESS = 0x40;
00775   
00782   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_IMAGE_UPLOAD)]
00783   const TToiCdsActionCapability CDS_CAPABILITY_IMAGE_UPLOAD = 0x80;
00784   
00791   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_AUDIO_UPLOAD)]
00792   const TToiCdsActionCapability CDS_CAPABILITY_AUDIO_UPLOAD = 0x100;
00793   
00800   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_AV_UPLOAD)]
00801   const TToiCdsActionCapability CDS_CAPABILITY_AV_UPLOAD = 0x200;
00802   
00809   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_X_GET_DLNA_UPLOAD_PROFILES)]
00810   const TToiCdsActionCapability CDS_CAPABILITY_X_GET_DLNA_UPLOAD_PROFILES = 0x400;
00811   
00813 
00820   //@ [OutParam(Name=objectId,Position=1,IsBinary=0, Bound=0)]
00821   string getRootContainerId();
00822   
00841   void getCapabilities(in ToiOperationManager::TToiOperationId operationId)
00842    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException);
00843   
00894   void browse(in ToiOperationManager::TToiOperationId operationId, 
00895         in string containerId, 
00896         in TToiPropertyIdSequence propertyFilter, 
00897         in TToiSortIdSequence sortCriteria, 
00898         in long startIndex, 
00899         in long count)
00900    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiNotEnoughResourcesException);
00901   
00929   void getObjectById(in ToiOperationManager::TToiOperationId operationId, 
00930         in string objectId, 
00931         in TToiPropertyIdSequence propertyFilter)
00932    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiNotEnoughResourcesException);
00933   
00992   void search(in ToiOperationManager::TToiOperationId operationId, 
00993         in string containerId, 
00994         in string searchCriteria, 
00995         in TToiPropertyIdSequence propertyFilter, 
00996         in TToiSortIdSequence sortCriteria, 
00997         in long startIndex, 
00998         in long count)
00999    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException, TToiNotEnoughResourcesException);
01000   
01015   //@ [ToiMultipleResult=ToiDlnaContentDirectoryServiceGetPropertyInfoByIdRet]
01016   ToiMultipleResult getPropertyInfoById(in TToiPropertyId id)
01017    raises (TToiInvalidArgumentException);
01018   
01030   //@ [OutParam(Name=id,Position=2,IsBinary=0, Bound=0)]
01031   TToiPropertyId getPropertyIdByName(in string name)
01032    raises (TToiInvalidArgumentException);
01033   
01061   //@ [ToiMultipleResult=ToiDlnaContentDirectoryServiceGetOperationObjectResultRet]
01062   ToiMultipleResult getOperationObjectResult(in ToiOperationManager::TToiOperationId operationId, 
01063         in long maxCount)
01064    raises (TToiInvalidArgumentException, TToiNoDataException);
01065   
01084   //@ [OutParam(Name=capabilities,Position=2,IsBinary=0, Bound=0)]
01085   ToiDlnaContentDirectoryServiceCdsCapabilities getOperationCapabilityResult(in ToiOperationManager::TToiOperationId operationId)
01086    raises (TToiInvalidArgumentException, TToiNoDataException);
01087   
01109   //@ [ReturnAddress(Type=IToiOperationManager)]
01110   
01111   
01112   //@ [OutParam(Name=address,Position=1,IsBinary=0, Bound=0)]
01113   ToiOperationManager getCdsOperationManager();
01114   
01121   //@ [OutParam(Name=uuid,Position=1,IsBinary=0, Bound=0)]
01122   string getServerUuid();
01123   
01128   //@ [ReleaseInstance]
01129   
01130   
01131   void releaseInstance();
01132   
01133 };
01134 
01135 #endif