testmanagementirpconstdefs.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

// File: TestManagementIRPConstDefs.idl

#ifndef _TESTMANAGEMENTIRPCONSTDEFS_IDL_
#define _TESTMANAGEMENTIRPCONSTDEFS_IDL_

#include "CosNotification.idl"
#include "ManagedGenericIRPConstDefs.idl"

// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"

/* ## Module: TestManagementIRPConstDefs
This module contains commonly used definitions for Test Management IRP
======================================================================
*/
module TestManagementIRPConstDefs
{
   /*
   This defines the notification type of this Test Management 
      IRP.
   */
   const string NOTIFY_TM_TEST_RESULT = "x1";


   /*
   This enum defines the test state
   */
   enum TestStateType {
      NotInitialized,
      Idle,
      Initializing,
      Testing,
      Terminating,
      Disabled
   };

   /*
   This enum defines the test outcome
   */
   enum TestOutcomeType {
      Inconclusive,
      Pass,
      Fail,
      TimeOut,
      PrematureTermination
   };


   /*
   This block defines notification attributes of this IRP.
   These attribute values should not clash with those used
       in Notification header (see IDL of Notification IRP).
   */
   interface AttributeNameValue
	{
    const string TEST_INVOCATION_INITIATOR = "f";
    const string TEST_INVOCATION_ID = "g";
    const string TEST_ACTUAL_START_TIME = "h";
    const string TEST_ACTUAL_STOP_TIME = "i";
    const string TEST_OUTCOME = "j";
    const string MORT = "k";
    const string PROPOSED_REPAIR_ACTIONS = "l";
    const string ADDITIONAL_INFORMATION = "m";
    const string FILE_REFERENCE = "n";
    const string FILE_EXPIRY_DATE = "o";
	};   

   typedef string TestInvocationInitiator;
   typedef string ToBeMonitoredTO;

   typedef CosNotification::PropertySeq NVPairs;

   /*
   Define a seq of to-be-initiated-test
   */
   struct ToBeInitiatedTest 
   {
       unsigned long max_testing_state_duration;//seconds;0->no limit 
       string  toBeTestedMORT; //MORT DN
       string  tOClass;        //Tester object class
       string  tODN;           //Tester object DN
       NVPairs tONVPair;       //Tester object attributes in NV pairs
   };
   typedef sequence <ToBeInitiatedTest> ToBeInitiatedTestSeq;

   /*
   Define the structure returned by initiate_tests
   */
   struct InitiateTestsResponseElement 
   {
      // If failureReason is NULL, the test is initiated successfully and
      //     testInvocationId contains the invocation id. In case the tester object name is not
      //     provided in the request, it shall be carried by testerObjectDN. In case the tester
      //     object name is provided in the request tODN shall be NULL.
      // Else, the test initiation fails and failureReason contains 
      //     the failure reason and testInvocationId contains garbage.
      string failureReason;  
      string testInvocationId; 
      string tODN;
   };
   typedef sequence <InitiateTestsResponseElement> InitiateTestsResponse;



   /*
   Define a seq of to-be-terminated-test
   */
   typedef string TestInvocationId;
   typedef sequence <TestInvocationId> ToBeTerminatedTestSeq;   

   /*
   Define the structure returned by terminate_tests
   */
   struct TerminateTestsResponseElement 
   {
      // If failureReason is NULL, the test has terminated successfully and
      //     testInvocationId identifies the terminated invocation.
      // Else, the test termination fails and failureReason contains 
      //     the failure reason and testInvocationId contains garbage.
      string failureReason;  
      string testInvocationId;
   };
   typedef sequence <TerminateTestsResponseElement> TerminateTestsResponse;  

   /*
   Define the structure of a TOAttributes.
   */
   struct TOAttributes
   {
       TestStateType   testState;   
       TestOutcomeType testOutcome; 
       NVPairs         attributesInNVPairs;
   };

};
#endif // _TESTMANAGEMENTIRPCONSTDEFS_IDL_