s63_media_file_interface.h

Go to the documentation of this file.

 
#ifndef SDK_S63_MEDIA_FILE_INTERFACE_H_
#define SDK_S63_MEDIA_FILE_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/collection/collection_interface.h>
#include <datalayer/inc/s63_base/s63_cell_permits_interface.h>
 
namespace sdk {
namespace s63 {
 
FWD_DECL_INTERFACE(IS63MediaFileRecord);
FWD_DECL_INTERFACE(IS63MediaFileRecordsEnum);
FWD_DECL_INTERFACE(IS63MediaFile);
 
typedef enum MediaFileMediaType
{
  kMediaFileMediaType_Unknown = 0, 
  kMediaFileMediaType_Base    = 1, 
  kMediaFileMediaType_Update  = 2, 
} MediaFileMediaType;
 
typedef SDKUInt8 MediaFileWeekOfIssue;
static const MediaFileWeekOfIssue kUnknownMediaWeekOfIssue = 0U;
 
typedef SDKUInt32 MediaFileYearOfIssue;
static const MediaFileYearOfIssue kUnknownMediaYearOfIssue = 0UL;
 
typedef SDKUInt8 MediaFileMediaNumber;
static const MediaFileMediaNumber kUnknownMediaFileMediaNumber = 0U;
 
class IS63MediaFileRecord : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetExchangeSetLocation(
    SDKString& exchange_set_location) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetExchangeSetIssueDate(
    SDKTime& ex_set_issue_date) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMediaSetNumber(
    SDKString& media_set_number) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRegionalInformation(
    SDKString& regional_information) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetComments(
    SDKString& comments) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS63MediaFileRecord)
  SDK_END_INTERFACE(IS63MediaFileRecord)
};
SDK_DECLARE_IID(IS63MediaFileRecord)
 
class IS63MediaFileRecordsEnum : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(
    IS63MediaFileRecordSP& media_file_record) const throw() = 0;
 
  // ALSO CAN IMPLEMENT sdk::ICollectionSDKComponent interface
 
  SDK_IMPLEMENT_IID(IS63MediaFileRecordsEnum)
  SDK_END_INTERFACE(IS63MediaFileRecordsEnum)
};
SDK_DECLARE_IID(IS63MediaFileRecordsEnum)
 
class IS63MediaFile : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetDataserverID(
    DataServerID& dataserver_id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetWeekOfIssue(
    MediaFileWeekOfIssue& week_of_issue, 
    MediaFileYearOfIssue& year_of_issue) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetDateOfIssue(
    SDKTime& date_of_issue) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMediaType(
    MediaFileMediaType& media_type) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMediaLabelID(
    MediaFileMediaNumber& curr_media_number,
    MediaFileMediaNumber& total_media_number) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMediaID(
    SDKString& media_id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMediaName(
    SDKString& media_name) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRegionalInformation(
    SDKString& regional_information) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetIterator(
    IS63MediaFileRecordsEnumSP& iterator) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS63MediaFile)
  SDK_END_INTERFACE(IS63MediaFile)
};
SDK_DECLARE_IID(IS63MediaFile)
 
} // namespace s63
} // namespace sdk 
 
#endif // SDK_S63_MEDIA_FILE_INTERFACE_H_