summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Trader/Offer_Iterator.h
blob: 9f74af2b6e19cc37518b8d4457cbf5a75b059e81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/* -*- C++ -*- */

// ============================================================================
// $Id$
//
// = LIBRARY
//    orbsvcs
// 
// = FILENAME
//    Offer_Iterator.h
//
// = AUTHOR
//    Marina Spivak <marina@cs.wustl.edu>
//    Seth Widoff <sbw1@cs.wustl.edu>
// 
// ============================================================================

#ifndef TAO_OFFER_ITERATOR_H
#define TAO_OFFER_ITERATOR_H

#include "Property_Filter.h"

class TAO_Export TAO_Offer_Iterator :
  public POA_CosTrading::OfferIterator
  // = TITLE
  //     This class implements CosTrading::OfferIterator IDL
  //     interface. 

  // = DESCRIPTION
  //     This is an abstract base class  to allow for different
  //     implementations of OfferIterator.
  // BEGIN SPEC
  //   The OfferIterator interface is used to return a set of service
  //   offers from the query operation by enabling the service offers
  //   to be extracted by successive operations on the OfferIterator
  //   interface.
  // END SPEC
{
public:
  // = Initialization and termination methods.

  TAO_Offer_Iterator (const TAO_Property_Filter& property_filter);

  virtual ~TAO_Offer_Iterator (void);
  
  virtual void destroy (CORBA::Environment& _env)  
    TAO_THROW_SPEC ((CORBA::SystemException));
  // BEGIN SPEC
  // The destroy operation destroys the iterator. No further
  // operations can be invoked on an iterator after it has been
  // destroyed. 
  // END SPEC
  
  virtual void add_offer (CosTrading::OfferId offer_id,
			  CosTrading::Offer* offer) = 0;
  // Add an offer to the collection of offers the iterator will
  // iterate over. 

  virtual CORBA::ULong max_left (CORBA::Environment &env) = 0
    TAO_THROW_SPEC ((CORBA::SystemException,
		    CosTrading::UnknownMaxLeft));

  // BEGIN SPEC
  // The max_left operation returns the number of service offers
  // remaining in the iterator. The exception UnknownMaxLeft is raised
  // if the iterator cannot determine the remaining number of service
  // offers (e.g., if the iterator determines its set of service
  // offers through lazy evaluation). 
  // END SPEC
  
  virtual CORBA::Boolean next_n (CORBA::ULong n,
				 CosTrading::OfferSeq_out offers,
				 CORBA::Environment &env) = 0
    TAO_THROW_SPEC ((CORBA::SystemException));
  // BEGIN SPEC
  // The next_n operation returns a set of service offers in the
  // output parameter "offers." The operation returns n service offers
  // if there are at least n service offers remaining in the
  // iterator. If there are fewer than n service offers in the
  // iterator, then all remaining service offers are returned. The
  // actual number of service offers returned can be determined from
  // the length of the "offers" sequence. The next_n operation returns
  // TRUE if there are further service offers to be extracted from the
  // iterator. It returns FALSE if there are no further service offers
  // to be extracted.  
  // END SPEC
 protected:

  TAO_Property_Filter pfilter_;
};

#endif /* TAO_OFFER_ITERATOR */