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   
00280   const TToiPropertyId PROPERTY_DATE = 40;
00281   
00286   const TToiPropertyId PROPERTY_DESCRIPTION = 50;
00287   
00292   const TToiPropertyId PROPERTY_LANGUAGE = 60;
00293   
00298   const TToiPropertyId PROPERTY_RES = 70;
00299   
00304   const TToiPropertyId PROPERTY_RES_ATTR_BITRATE = 71;
00305   
00310   const TToiPropertyId PROPERTY_RES_ATTR_BITS_PER_SAMPLE = 72;
00311   
00316   const TToiPropertyId PROPERTY_RES_ATTR_COLOR_DEPTH = 73;
00317   
00322   const TToiPropertyId PROPERTY_RES_ATTR_DURATION = 74;
00323   
00328   const TToiPropertyId PROPERTY_RES_ATTR_IMPORT_URI = 75;
00329   
00334   const TToiPropertyId PROPERTY_RES_ATTR_AUDIO_CHANNELS_COUNT = 76;
00335   
00340   const TToiPropertyId PROPERTY_RES_ATTR_PROTOCOL_INFO = 77;
00341   
00346   const TToiPropertyId PROPERTY_RES_ATTR_RESOLUTION = 78;
00347   
00352   const TToiPropertyId PROPERTY_RES_ATTR_SAMPLE_FREQUENCY = 79;
00353   
00359   const TToiPropertyId PROPERTY_RES_ATTR_SIZE = 80;
00360   
00365   const TToiPropertyId PROPERTY_RES_ATTR_PROTECTION = 81;
00366   
00372   const TToiPropertyId PROPERTY_RES_RENDER_SUPPORTED = 82;
00373   
00378   const TToiPropertyId PROPERTY_SEARCH_CLASS = 90;
00379   
00384   const TToiPropertyId PROPERTY_SEARCH_CLASS_ATTR_INCLUDE_DERIVED = 91;
00385   
00390   const TToiPropertyId PROPERTY_SEARCH_CLASS_ATTR_NAME = 92;
00391   
00396   const TToiPropertyId PROPERTY_ACTOR = 100;
00397   
00402   const TToiPropertyId PROPERTY_ALBUM = 110;
00403   
00408   const TToiPropertyId PROPERTY_ARTIST = 120;
00409   
00414   const TToiPropertyId PROPERTY_AUTHOR = 130;
00415   
00420   const TToiPropertyId PROPERTY_PRODUCER = 140;
00421   
00426   const TToiPropertyId PROPERTY_DIRECTOR = 150;
00427   
00432   const TToiPropertyId PROPERTY_PUBLISHER = 160;
00433   
00438   const TToiPropertyId PROPERTY_CONTRIBUTOR = 170;
00439   
00444   const TToiPropertyId PROPERTY_GENRE = 180;
00445   
00450   const TToiPropertyId PROPERTY_ICON = 190;
00451   
00456   const TToiPropertyId PROPERTY_ORIGINAL_TRACK_NUMBER = 200;
00457   
00462   const TToiPropertyId PROPERTY_PLAYLIST = 210;
00463   
00468   const TToiPropertyId PROPERTY_RATING = 220;
00469   
00474   const TToiPropertyId PROPERTY_SCHEDULED_START_TIME = 230;
00475   
00480   const TToiPropertyId PROPERTY_SCHEDULED_END_TIME = 240;
00481   
00486   const TToiPropertyId PROPERTY_CHANNEL_NAME = 250;
00487   
00492   const TToiPropertyId PROPERTY_CHANNEL_NR = 260;
00493   
00498   const TToiPropertyId PROPERTY_STORAGE_FREE = 270;
00499   
00504   const TToiPropertyId PROPERTY_STORAGE_MAX_PARTITION = 280;
00505   
00510   const TToiPropertyId PROPERTY_STORAGE_MEDIUM = 290;
00511   
00516   const TToiPropertyId PROPERTY_STORAGE_TOTAL = 300;
00517   
00522   const TToiPropertyId PROPERTY_STORAGE_USED = 310;
00523   
00528   const TToiPropertyId PROPERTY_WRITE_STATUS = 320;
00529   
00534   const TToiPropertyId PROPERTY_REGION = 330;
00535   
00540   const TToiPropertyId PROPERTY_LONG_DESCRIPTION = 340;
00541   
00546   const TToiPropertyId PROPERTY_RADIO_CALL_SIGN = 350;
00547   
00552   const TToiPropertyId PROPERTY_RADIO_STATION_ID = 360;
00553   
00558   const TToiPropertyId PROPERTY_RADIO_BAND = 370;
00559   
00564   const TToiPropertyId PROPERTY_USER_ANNOTATION = 380;
00565   
00570   const TToiPropertyId PROPERTY_CLASS = 390;
00571   
00576   const TToiPropertyId PROPERTY_TITLE = 400;
00577   
00583   const TToiPropertyId PROPERTY_RES_PI_PROTOCOL = 410;
00584   
00590   const TToiPropertyId PROPERTY_RES_PI_MIME_TYPE = 411;
00591   
00597   const TToiPropertyId PROPERTY_RES_PI_PROFILE_NAME = 412;
00598   
00604   const TToiPropertyId PROPERTY_RES_PI_OPERATIONS = 413;
00605   
00611   const TToiPropertyId PROPERTY_RES_PI_PLAY_SPEED = 414;
00612   
00618   const TToiPropertyId PROPERTY_RES_PI_CONVERSION_INDICATOR = 415;
00619   
00625   const TToiPropertyId PROPERTY_RES_PI_FLAGS = 416;
00626   
00632   const TToiPropertyId PROPERTY_RES_PI_MAX_RTSP_SPEED = 417;
00633   
00635   typedef sequence < ToiDlnaContentDirectoryServiceCdsObject > TToiCdsObjectSequence;
00636   
00639   //@ [Enum]
00640   typedef long TToiPropertyType;
00643   
00649   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_STRING)]
00650   const TToiPropertyType TYPE_STRING = 0;
00651   
00657   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_INTEGER)]
00658   const TToiPropertyType TYPE_INTEGER = 1;
00659   
00665   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_BOOLEAN)]
00666   const TToiPropertyType TYPE_BOOLEAN = 2;
00667   
00673   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_DATE)]
00674   const TToiPropertyType TYPE_DATE = 3;
00675   
00682   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_RESOLUTION)]
00683   const TToiPropertyType TYPE_RESOLUTION = 4;
00684   
00690   //@ [Enumerator(Enum=TToiPropertyType,Name=TYPE_DURATION)]
00691   const TToiPropertyType TYPE_DURATION = 5;
00692   
00694 
00698   //@ [Enum]
00699   typedef long TToiCdsActionCapability;
00702   
00709   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_CREATE_OBJECT)]
00710   const TToiCdsActionCapability CDS_CAPABILITY_CREATE_OBJECT = 0x1;
00711   
00718   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_DESTROY_OBJECT)]
00719   const TToiCdsActionCapability CDS_CAPABILITY_DESTROY_OBJECT = 0x2;
00720   
00727   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_SEARCH)]
00728   const TToiCdsActionCapability CDS_CAPABILITY_SEARCH = 0x4;
00729   
00736   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_IMPORT_RESOURCE)]
00737   const TToiCdsActionCapability CDS_CAPABILITY_IMPORT_RESOURCE = 0x8;
00738   
00745   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_EXPORT_RESOURCE)]
00746   const TToiCdsActionCapability CDS_CAPABILITY_EXPORT_RESOURCE = 0x10;
00747   
00754   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_STOP_TRANSFER_PROGRESS)]
00755   const TToiCdsActionCapability CDS_CAPABILITY_STOP_TRANSFER_PROGRESS = 0x20;
00756   
00763   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_GET_TRANSFER_PROGRESS)]
00764   const TToiCdsActionCapability CDS_CAPABILITY_GET_TRANSFER_PROGRESS = 0x40;
00765   
00772   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_IMAGE_UPLOAD)]
00773   const TToiCdsActionCapability CDS_CAPABILITY_IMAGE_UPLOAD = 0x80;
00774   
00781   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_AUDIO_UPLOAD)]
00782   const TToiCdsActionCapability CDS_CAPABILITY_AUDIO_UPLOAD = 0x100;
00783   
00790   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_AV_UPLOAD)]
00791   const TToiCdsActionCapability CDS_CAPABILITY_AV_UPLOAD = 0x200;
00792   
00799   //@ [Enumerator(Enum=TToiCdsActionCapability,Name=CDS_CAPABILITY_X_GET_DLNA_UPLOAD_PROFILES)]
00800   const TToiCdsActionCapability CDS_CAPABILITY_X_GET_DLNA_UPLOAD_PROFILES = 0x400;
00801   
00803 
00810   //@ [OutParam(Name=objectId,Position=1,IsBinary=0, Bound=0)]
00811   string getRootContainerId();
00812   
00831   void getCapabilities(in ToiOperationManager::TToiOperationId operationId)
00832    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException);
00833   
00880   void browse(in ToiOperationManager::TToiOperationId operationId, 
00881         in string containerId, 
00882         in TToiPropertyIdSequence propertyFilter, 
00883         in TToiSortIdSequence sortCriteria, 
00884         in long startIndex, 
00885         in long count)
00886    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException);
00887   
00911   void getObjectById(in ToiOperationManager::TToiOperationId operationId, 
00912         in string objectId, 
00913         in TToiPropertyIdSequence propertyFilter)
00914    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException);
00915   
00967   void search(in ToiOperationManager::TToiOperationId operationId, 
00968         in string containerId, 
00969         in string searchCriteria, 
00970         in TToiPropertyIdSequence propertyFilter, 
00971         in TToiSortIdSequence sortCriteria, 
00972         in long startIndex, 
00973         in long count)
00974    raises (TToiInvalidArgumentException, TToiOperationNotSupportedException);
00975   
00990   //@ [ToiMultipleResult=ToiDlnaContentDirectoryServiceGetPropertyInfoByIdRet]
00991   ToiMultipleResult getPropertyInfoById(in TToiPropertyId id)
00992    raises (TToiInvalidArgumentException);
00993   
01005   //@ [OutParam(Name=id,Position=2,IsBinary=0, Bound=0)]
01006   TToiPropertyId getPropertyIdByName(in string name)
01007    raises (TToiInvalidArgumentException);
01008   
01036   //@ [ToiMultipleResult=ToiDlnaContentDirectoryServiceGetOperationObjectResultRet]
01037   ToiMultipleResult getOperationObjectResult(in ToiOperationManager::TToiOperationId operationId, 
01038         in long maxCount)
01039    raises (TToiInvalidArgumentException, TToiNoDataException);
01040   
01059   //@ [OutParam(Name=capabilities,Position=2,IsBinary=0, Bound=0)]
01060   ToiDlnaContentDirectoryServiceCdsCapabilities getOperationCapabilityResult(in ToiOperationManager::TToiOperationId operationId)
01061    raises (TToiInvalidArgumentException, TToiNoDataException);
01062   
01081   //@ [ReturnAddress(Type=IToiOperationManager)]
01082   
01083   
01084   //@ [OutParam(Name=address,Position=1,IsBinary=0, Bound=0)]
01085   ToiOperationManager getCdsOperationManager();
01086   
01093   //@ [OutParam(Name=uuid,Position=1,IsBinary=0, Bound=0)]
01094   string getServerUuid();
01095   
01100   //@ [ReleaseInstance]
01101   
01102   
01103   void releaseInstance();
01104   
01105 };
01106 
01107 #endif