TAO/examples/Quoter/Quoter.idl

   1
   2 //=============================================================================
   3 /**
   4  *  @file    Quoter.idl
   5  *
   6  *  Quoter example that illustrate the use of the global POA and
   7  *  the CosLifeCycle service.
   8  *
   9  *
  10  *  @author Darrell Brunsch (brunsch@cs.wustl.edu) Michael Kircher (mk1@cs.wustl.edu)
  11  */
  12 //=============================================================================
  13
  14
  15 #include "orbsvcs/CosLifeCycle.idl"
  16
  17 module Stock
  18 {
  19   exception Invalid_Stock {};
  20   exception Invalid_Quoter {};
  21
  22   interface Quoter : CosLifeCycle::LifeCycleObject
  23     {
  24       // = TITLE
  25       //   Access Stock information.
  26
  27       // Returns the current stock value or throws an exception.
  28       long get_quote (in string stock_name)
  29         raises (Invalid_Stock, Invalid_Quoter);
  30
  31       // LifeCycleObject copy(in FactoryFinder there,
  32       //                      in Criteria the_criteria)
  33       //    raises(NoFactory, NotCopyable, InvalidCriteria, CannotMeetCriteria);
  34       // copies this object to a location "there" using the "the_criteria"
  35
  36       // void move(in FactoryFinder there,
  37       //     in Criteria the_criteria)
  38       //     raises(NoFactory, NotMovable, InvalidCriteria,  CannotMeetCriteria);
  39       // moves this object to a location "there" using the "the_criteria"
  40
  41       // void remove()
  42       //     raises(NotRemovable);
  43       // removes/deletes this object
  44
  45     };
  46
  47   interface Quoter_Factory
  48     {
  49       // = TITLE
  50       //   Creation of Quoter objects
  51
  52       Quoter create_quoter (in string name)
  53         raises (Invalid_Quoter);
  54       // Returns a new Quoter selected by name e.g., "Dow Jones,"
  55       // "Reuters,", etc
  56     };
  57
  58   interface Quoter_Factory_Finder : CosLifeCycle::FactoryFinder
  59     {
  60       // = TITLE
  61       //   Wrapper for the CosLifeCycle FactoryFinder
  62       //
  63       // inherits:
  64       // Factories find_factories(in Key factory_key) raises(NoFactory);
  65     };
  66
  67   interface Quoter_Generic_Factory : CosLifeCycle::GenericFactory
  68     {
  69       // = TITLE
  70       //   Wrapper for the CosLifeCycle GenericFactory
  71       //
  72       // inherits:
  73       // boolean supports(in Key k);
  74       // Object create_object(in Key k, in Criteria the_criteria)
  75       //      raises (NoFactory, InvalidCriteria, CannotMeetCriteria);
  76     };
  77
  78   interface Quoter_Life_Cycle_Service : CosLifeCycle::GenericFactory
  79     {
  80       // = TITLE
  81       //   Wrapper for the CosLifeCycle GenericFactory
  82       //
  83       // inherits:
  84       // boolean supports(in Key k);
  85       // Object create_object(in Key k, in Criteria the_criteria)
  86       //      raises (NoFactory, InvalidCriteria, CannotMeetCriteria);
  87
  88       void register_factory (in string name,
  89                              in string location,
  90                              in string description,
  91                              in Object _object);
  92       // provide an method for registering factories with their properties
  93     };
  94
  95   interface Criteria_Evaluator
  96     {
  97       // = TITLE
  98       //   Criteria Evaluator
  99       //
 100       // = DESCRIPTION
 101       //   Interface description for an evaluator of CosLifeCycle
 102       //   Criterias. It is mainly a wrapper, which should make
 103       //   access easier
 104       //
 105       typedef sequence <CosLifeCycle::NameValuePair> SeqNamedValuePair;
 106
 107       typedef CosLifeCycle::Criteria Criteria;
 108
 109       exception NotAvailable { string reason; };
 110       // raised if the questioned configuration is not available
 111
 112       SeqNamedValuePair getInitialization ();
 113       // get the initialization
 114
 115       string getFilter ();
 116       // get a filter string
 117
 118       SeqNamedValuePair getLogicalLocation ();
 119       // get the logical location
 120
 121       string getPreferences ();
 122       // get the preferences, not implemented
 123
 124       void setCriteria (in Criteria criteria_);
 125       // set the Criteria which is searched for keywords
 126     };
 127 };
 128