// Copyright 2005-2008 THALES, BAE Systems, Raytheon

#include "ALMAS_Client.idl"
#include "ALMAS_DataModel.idl"
#ifndef __ALMAS_Management_DEF
#define __ALMAS_Management_DEF
#pragma prefix "omg.org"

module ALMAS_Management {

 typedef sequence<ALMAS_DataModel::ALMAS_Alert> ALMAS_AlertSet;

 typedef sequence<ALMAS_DataModel::ALMAS_TemplateIDType> ALMAS_TemplateIDTypeSet;

 interface ALMAS_Manager {

  attribute string ALMAS_SystemID;

  // alert retrieval methods

  ALMAS_DataModel::ALMAS_CallStatus GetAlert (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    out ALMAS_DataModel::ALMAS_Alert Alert);

  ALMAS_DataModel::ALMAS_CallStatus GetAlerts (
    in string Filter,
    out ALMAS_AlertSet AlertSet);

  // ALMAS-wide control methods

  ALMAS_DataModel::ALMAS_CallStatus SetAlertInhibited (
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    in boolean Inhibition);

  ALMAS_DataModel::ALMAS_CallStatus UpdateDynamicMessageData (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    in string ObjectValue,
    in ALMAS_DataModel::ALMAS_DynamicMessageDataType OldValue);

  ALMAS_DataModel::ALMAS_CallStatus RegisterNotificationListener ( 
    in ALMAS_Client::ALMAS_NotificationListener Handle);

  // Template management methods

  ALMAS_DataModel::ALMAS_CallStatus GetTemplate ( 
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    out ALMAS_DataModel::ALMAS_AlertTemplateType Template);

  ALMAS_DataModel::ALMAS_CallStatus GetAllTemplateIDs ( 
    in string Filter,
    out ALMAS_TemplateIDTypeSet TemplateIDSet);
 };

 interface ALMAS_ManagerExtensions : ALMAS_Manager {

  ALMAS_DataModel::ALMAS_CallStatus RemoveAlertsWithDynamicData ( 
    in string CancellerID,
    in string DataType,
    in string DataValue);

  ALMAS_DataModel::ALMAS_CallStatus AttachCategorisationRule (
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    in long RuleID);

  ALMAS_DataModel::ALMAS_CallStatus DetachCategorisationRule (
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    in long RuleID);
 };

 interface ALMAS_Producer {

  ALMAS_DataModel::ALMAS_CallStatus RaiseAlertFromOverrides ( 
    in string ProducerID,
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    in ALMAS_DataModel::ALMAS_CategoryType Category,
    in boolean ValidCategory,
    in short Priority,
    in boolean ValidPriority,
    in ALMAS_DataModel::ALMAS_StatusType Status,
    in boolean ValidStatus,
    in ALMAS_DataModel::ALMAS_ScopeType Scope,
    in boolean ValidScope,
    in ALMAS_DataModel::ALMAS_TimeoutType Timeout,
    in boolean ValidTimeout,
    in boolean ConfirmationRequired,
    in boolean ValidConfirmationRequired,
    in string SecondaryGrouping,
    in boolean ValidSecondaryGrouping,
    in boolean Persistent,
    in boolean ValidPersistent,
    in boolean ReliablyDistributed,
    in boolean ValidReliablyDistributed,
    in ALMAS_DataModel::ALMAS_TimeoutActionType TimeoutAction,
    in boolean ValidTimeoutAction,
    in ALMAS_DataModel::ALMAS_AckModelType AcknowledgementModel,
    in boolean ValidAcknowledgementModel,
    in ALMAS_DataModel::ALMAS_StaticMessageSet StaticMessages,
    in boolean ValidStaticMessages,
    in ALMAS_DataModel::ALMAS_DynamicMessageDataTypeSet DynamicMessageData,
    in boolean ValidDynamicMessageData,
    in ALMAS_DataModel::ALMAS_ReceiverKindTypeSet AlertReceivers,
    in boolean ValidAlertReceiverSet,
    out ALMAS_DataModel::ALMAS_AlertIDType AlertID);
  
  ALMAS_DataModel::ALMAS_CallStatus RaiseAlertFromData (
    in string ProducerID,
    in ALMAS_DataModel::ALMAS_AlertTemplateType AlertInfo,
    out ALMAS_DataModel::ALMAS_AlertIDType AlertID);

  ALMAS_DataModel::ALMAS_CallStatus RaiseAlertFromTemplate (
    in string ProducerID,
    in ALMAS_DataModel::ALMAS_TemplateIDType TemplateID,
    out ALMAS_DataModel::ALMAS_AlertIDType AlertID);

  ALMAS_DataModel::ALMAS_CallStatus UpdateAlertPriority (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    in string ProducerID,
    in short Priority);

  ALMAS_DataModel::ALMAS_CallStatus CancelAlert (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    in string CancellerID,
    in string CancellationReason);
 };

 interface ALMAS_Responder {

  ALMAS_DataModel::ALMAS_CallStatus RegisterReceiver ( 
    in ALMAS_Client::ALMAS_Receiver ReceiverHandle,
    in string ReceiverID,
    in string RKType);

  ALMAS_DataModel::ALMAS_CallStatus UnregisterReceiver (
    in string ReceiverID);

  ALMAS_DataModel::ALMAS_CallStatus AcknowledgeAlert (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    in string ReceiverID);
  
  ALMAS_DataModel::ALMAS_CallStatus HandleAlert (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    in string ReceiverID);

  ALMAS_DataModel::ALMAS_CallStatus ConfirmReceipt (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID, 
    in string ReceiverID);
 };

 interface ALMAS_ResponderExtensions : ALMAS_Responder {

  ALMAS_DataModel::ALMAS_CallStatus SetLanguage (
    in string ReceiverID,
    in string Language);
  
  ALMAS_DataModel::ALMAS_CallStatus GetFilledMessageText (
    in ALMAS_DataModel::ALMAS_AlertIDType AlertID,
    out string MessageText);
 };

 interface ALMAS_Configuration {

  ALMAS_DataModel::ALMAS_CallStatus LoadReceiverHierarchy (
    in string Filename );
  
  ALMAS_DataModel::ALMAS_CallStatus LoadTemplateSet (
    in string Filename );
  
  ALMAS_DataModel::ALMAS_CallStatus LoadConfiguration (
    in string Filename );
 };
};

#endif