/extra/builds/39807/build/dist/idl/IPlatformService.idl

// Copyright (c) 2011 Motorola, Inc. All rights reserved.
// Copyright (c) 2012-2013 Motorola Mobility, Inc. All rights reserved.
// Copyright (c) 2013-2015 ARRIS Enterprises, Inc. All rights reserved.
// Copyright (c) 2016 ARRIS Enterprises, LLC. All rights reserved.
//
// This program is confidential and proprietary to ARRIS Enterprises, LLC.
// (ARRIS), and may not be copied, reproduced, modified, disclosed to others,
// published or used, in whole or in part, without the express prior written
// permission of ARRIS.

#ifndef IPLATFORMSERVICE_IDL
#define IPLATFORMSERVICE_IDL

#include "IToiPlatformService.idl"
#include "IToiApplicationService.idl"
#include "TToiInvalidArgumentException.idl"
#include "TToiNotEnoughResourcesException.idl"

interface IPlatformService : IToiPlatformService
{
  const string FLASH_APPLICATION_PATH = "/flash/applications";
  const string FLASH_SERVICE_PATH = "/flash/services";

  enum TStartupType
  {
    STARTUP_TYPE_POWER_ON,

    STARTUP_TYPE_REBOOT,

    STARTUP_TYPE_WAKE_UP,

    STARTUP_TYPE_PLATFORM_FAILURE,

    STARTUP_TYPE_PLATFORM_RESTART,

    STARTUP_TYPE_RESET_LEVEL_0,

    STARTUP_TYPE_RESET_LEVEL_1,

    STARTUP_TYPE_RESET_LEVEL_2,

    STARTUP_TYPE_RESET_LEVEL_3
  };

  enum TStatusCode
  {
    STATUS_CODE_OK,

    STATUS_CODE_PENDING,

    STATUS_CODE_NO_NETWORK,

    STATUS_CODE_NO_IP_ADDRESS
  };

  void ReportComponent(in long serviceId, in string address)
    raises (TToiInvalidArgumentException);

  void UnloadDone(in long serviceId)
    raises (TToiInvalidArgumentException);

  oneway void ReportPing(in long serviceId);

  void IsInStandby(out boolean value);

  void GetStartupType(out TStartupType type);

  oneway void SetStartupType(in TStartupType startupType);

  oneway void RestartPlatformNow();

  oneway void ReportApplicationShutdownComplete();

  void RegisterFactoryResetHandler(in string storagePath,
                                   in string address,
                                   out long handlerId)
    raises (TToiInvalidArgumentException);

  void UnregisterFactoryResetHandler(in long handlerId)
    raises (TToiInvalidArgumentException);

  oneway void FactoryResetHandlerDone(in long handlerId);

  void CreatePowerControlInstanceInternal(in IToiPowerControl::
                                          TToiPowerProfileAccess access,
                                          in string serviceName,
                                          out string address);


  void RegisterStartupHandler(out long id);

  void ReportStartupStatus(in long id, in TStatusCode statusCode);

  void RegisterObserverInternal(in string address)
    raises (TToiInvalidArgumentException);

  void AddAppDataPathForRemoval(in IToiApplicationService::
                                TToiApplicationId appId,
                                in long flags,
                                in string path)
    raises (TToiInvalidArgumentException,
            TToiPermissionDeniedException);

  void ClearFastbootFlag()
    raises (TToiNotEnoughResourcesException);

  void GetUpTime(out long time);
};

#endif