application_action_state.h

Go to the documentation of this file.

#ifndef UPE_CORE_API_APPLICATION_ACTION_STATE_H_
#define UPE_CORE_API_APPLICATION_ACTION_STATE_H_
 
#include <climits>
#include <map>
#include <memory>
#include <utility>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/mip_namespace.h"
#include "mip/upe/action.h"
#include "mip/upe/label.h"
 
MIP_NAMESPACE_BEGIN
 
enum class LabelState : unsigned int {
  NoChange, // Specify No change to existing label state.
  Remove,   // Specify Remove existing label.
  Update,   // Update existing label with a new label, GetNewLabel must not be null.
};
 
constexpr const int kTimeZoneOffsetLocalTime = INT_MAX;
 
class ApplicationActionState {
 
public:
  virtual LabelState GetNewLabelState() const = 0;
 
  virtual std::shared_ptr<Label> GetNewLabel() const = 0;
  
  virtual std::pair<bool, std::string> IsDowngradeJustified() const = 0;
 
  virtual AssignmentMethod GetNewLabelAssignmentMethod() const = 0;
 
  virtual std::vector<std::pair<std::string, std::string>> GetNewLabelExtendedProperties() const { 
    return std::vector<std::pair<std::string, std::string>>();
  }
 
  virtual ActionType GetSupportedActions() const = 0;
 
  virtual bool IsRecommendationEnabled() const = 0;
 
  virtual int GetContentTimeZoneUtcOffset() const { return kTimeZoneOffsetLocalTime; }
 
  virtual ~ApplicationActionState() { }
 
protected:
  ApplicationActionState() { }
};
 
MIP_NAMESPACE_END
#endif // UPE_CORE_API_APPLICATION_ACTION_STATE_H_