Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

CosTrading::Lookup Interface Reference

This interface is used to query the trader and retrieve offers which match specified conditions and constraints. More...

import "CosTrading.idl";

Inherits CosTrading::TraderComponents, CosTrading::SupportAttributes, and CosTrading::ImportAttributes.

List of all members.

Public Types

typedef Istring Preference
enum  HowManyProps { none, some, all }
 This enum is used to determine whether to return property information with returned offers. More...


Public Methods

void query (in ServiceTypeName type, in Constraint constr, in Preference pref, in PolicySeq policies, in SpecifiedProps desired_props, in unsigned long how_many, out OfferSeq offers, out OfferIterator offer_iter, out PolicyNameSeq limits_applied) raises ( IllegalServiceType, UnknownServiceType, IllegalConstraint, IllegalPreference, IllegalPolicyName, PolicyTypeMismatch, InvalidPolicyValue, IllegalPropertyName, DuplicatePropertyName, DuplicatePolicyName )
 This operation querys the trader for offers. More...


Detailed Description

This interface is used to query the trader and retrieve offers which match specified conditions and constraints.


Member Typedef Documentation

typedef Istring CosTrading::Lookup::Preference
 


Member Enumeration Documentation

enum CosTrading::Lookup::HowManyProps
 

This enum is used to determine whether to return property information with returned offers.

 none  - Do not return properties.
 some  - Return specified properties.
 all  - Return all properties.
 
Enumeration values:
none 
some 
all 


Member Function Documentation

void CosTrading::Lookup::query in ServiceTypeName    type,
in Constraint    constr,
in Preference    pref,
in PolicySeq    policies,
in SpecifiedProps    desired_props,
in unsigned long    how_many,
out OfferSeq    offers,
out OfferIterator    offer_iter,
out PolicyNameSeq    limits_applied
raises ( IllegalServiceType, UnknownServiceType, IllegalConstraint, IllegalPreference, IllegalPolicyName, PolicyTypeMismatch, InvalidPolicyValue, IllegalPropertyName, DuplicatePropertyName, DuplicatePolicyName )
 

This operation querys the trader for offers.

The various call parameters determine how the trader finds offers to satisfy the query.

Parameters:
type  - The servivce type of the returned offers.
constr  - The constraint string used for restricting suitable offers.
pref  - The preference string used to order returned offers.
policies  - Policies used to override default trader query policies.
desired_props  - Specifies which properties to return with offers.
how_many  - The maximum number of offers to be returned.
offers  - The sequence of returned offers.
offer_iter  - A reference to an OfferIterator object used to access offers not directly returned in the offer sequence.
limit_applied  - The limits applied by the trader while processing the query.
@raises IllegalServiceType - If the specified service type name is invalid. @raises UnknownServiceType - If the specified service type has not been registered. @raises IllegalConstraint - If the constraint string is invalid. @raises IllegalPreference - If the preference string is invalid. @raises IllegalPolicyName - If an invalid policy name was specified. @raises PolicyTypeMismatch - If the type of a specified policy does not match that of the specification. @raises InvalidPolicyValue - If the value of a policy is invalid. @raises IllegalPropertyName - If a property name is illegal. @raises DuplicatePropertyName - If duplicate property names are specified. @raises DuplicatePolicyName - If duplicate policy names are specified.