costrading.idl

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

/** This operation removes a link to a federated trader. 
 *
 * @param name - The name of the linked trader. 
 *
 * @raises IllegalLinkName - If the specified link name has invalid syntax.
 * @raises UnknownLinkName - If the specified link cannot be found.
 */

      void remove_link
      (
         in LinkName name
      )
      raises
      (
         IllegalLinkName,
         UnknownLinkName
      );

/** This operation describes a link to a federated trader,
 * returning a structure containing the link description.
 *
 * @returns - A link infromation structure.
 * @param name - The name of the linked trader. 
 *
 * @raises IllegalLinkName - If the specified link name has invalid syntax.
 * @raises UnknownLinkName - If the specified link cannot be found.
 */

      LinkInfo describe_link
      (
         in LinkName name
      )
      raises
      (
         IllegalLinkName,
         UnknownLinkName
      );

/** This operation returns a sequence of links. */

      LinkNameSeq list_links ();

/** This operation modifies a link to a federated trader,
 * changing the follow options that are applied to the link.
 *
 * @param name - The name of the linked trader. 
 * @param def_pass_on_follow_rule - The default lookup policy to propagate 
 *                                  if none was specified in the query.
 * @param limiting_follow_rule - The most permissive link policy that can
 *                               be applied to the link. 
 *
 * @raises IllegalLinkName - If the specified link name has invalid syntax.
 * @raises UnknownLinkName - If the specified link cannot be found.
 * @raises DefaultFollowTooPermissive - If the default lookup policy for the
 *                                      link is more premissive than the limiting
 *                                      lookup policy for the link.
 * @raises LimitingFollowTooPermissive - If the link default lookup policy is
 *                                       more permissive that the corresponding
 *                                       trader maximum allowed value.
 */

      void modify_link
      (
         in LinkName name,
         in FollowOption def_pass_on_follow_rule,
         in FollowOption limiting_follow_rule
      )
      raises
      (
         IllegalLinkName,
         UnknownLinkName,
         DefaultFollowTooPermissive,
         LimitingFollowTooPermissive
      );
   };

/** This interface supports proxy offers.
 * It is not yet supported.
 */

   interface Proxy : TraderComponents, SupportAttributes
   {
      typedef Istring ConstraintRecipe;

      struct ProxyInfo
      {
         ServiceTypeName type;
         Lookup target;
         PropertySeq properties;
         boolean if_match_all;
         ConstraintRecipe recipe;
         PolicySeq policies_to_pass_on;
      };

      exception IllegalRecipe
      {
         ConstraintRecipe recipe;
      };

      exception NotProxyOfferId
      {
         OfferId id;
      };
      
      /* doc: 51 */		
      OfferId export_proxy
      (
         in Lookup target,
         in ServiceTypeName type,
         in PropertySeq properties,
         in boolean if_match_all,
         in ConstraintRecipe recipe,
         in PolicySeq policies_to_pass_on
      )
      raises
      (
         IllegalServiceType,
         UnknownServiceType,
         InvalidLookupRef,
         IllegalPropertyName,
         PropertyTypeMismatch,
         ReadonlyDynamicProperty,
         MissingMandatoryProperty,
         IllegalRecipe,
         DuplicatePropertyName,
         DuplicatePolicyName
      );
      /* enddoc */

      void withdraw_proxy
      (
         in OfferId id
      )
      raises
      (
         IllegalOfferId,
         UnknownOfferId,
         NotProxyOfferId
      );
 
      ProxyInfo describe_proxy
      (
         in OfferId id
      )
      raises
      (
         IllegalOfferId,
         UnknownOfferId,
         NotProxyOfferId
      );
   };

/** This interface is used to manage the various policies
 * and constraints applied by the trader.
 */

   interface Admin :
      TraderComponents,
      SupportAttributes,
      ImportAttributes,
      LinkAttributes
   {
      typedef sequence <octet> OctetSeq;
 
      readonly attribute OctetSeq request_id_stem;
 
/* This operation sets the default search cardinality applied to queries. 
 *
 * @returns - The previous default search cardinality.
 * @param value - The new default serach cardinality.
 */

      unsigned long set_def_search_card (in unsigned long value);

/* This operation sets the maximum search cardinality applied to queries. 
 *
 * @returns - The previous maximum search cardinality.
 * @param value - The new maximum search cardinality.
 */

      unsigned long set_max_search_card (in unsigned long value);
 
/* This operation sets the default match cardinality applied to queries. 
 *
 * @returns - The previous default match cardinality.
 * @param value - The new default match cardinality.
 */

      unsigned long set_def_match_card  (in unsigned long value);

/* This operation sets the maximum match cardinality applied to queries. 
 *
 * @returns - The previous maximum match cardinality.
 * @param value - The new maximum match cardinality.
 */

      unsigned long set_max_match_card  (in unsigned long value);

/* This operation sets the default return cardinality applied to queries. 
 *
 * @returns - The previous default return cardinality.
 * @param value - The new default return cardinality.
 */

      unsigned long set_def_return_card (in unsigned long value);

/* This operation sets the maximum return cardinality applied to queries. 
 *
 * @returns - The previous maximum return cardinality.
 * @param value - The new maximum return cardinality.
 */

      unsigned long set_max_return_card (in unsigned long value);

/* This operation sets the maximum size for an iterator. 
 *
 * @returns - The previous maximum iterator size.
 * @param value - The new maximum iterator size.
 */

      unsigned long set_max_list (in unsigned long value);

/* This operation sets the default hop count used when resolving
 * federated queries. 
 *
 * @returns - The previous default hop count.
 * @param value - The new default hop count.
 */

      unsigned long set_def_hop_count (in unsigned long value);

/* This operation sets the maximum hop count used when resolving
 * federated queries. 
 *
 * @returns - The previous maximum hop count.
 * @param value - The new maximum hop count.
 */

      unsigned long set_max_hop_count (in unsigned long value);

/* This operation sets whether the trader supports modifiable
 * properties.
 *
 * @returns - TRUE if modifiable properties were supported.
 * @param value - TRUE if modifiable properties are to be supported.
 */

      boolean set_supports_modifiable_properties (in boolean value);

/* This operation sets whether the trader supports dynamic
 * properties.
 *
 * @returns - TRUE if dynamic properties were supported.
 * @param value - TRUE if dynamic properties are to be supported.
 */

      boolean set_supports_dynamic_properties (in boolean value);

/* This operation sets whether the trader supports proxy 
 * offers.
 *
 * @returns - TRUE if proxy offers were supported.
 * @param value - TRUE if proxy offers are to be supported.
 */

      boolean set_supports_proxy_offers (in boolean value);

/* This operation sets the default follow option applied to link
 * traversal for query resolution.
 *
 * @returns - The previous default follow option.
 * @param value - The new default follow option.
 */

      FollowOption set_def_follow_policy (in FollowOption policy);

/* This operation sets the maximum follow option applied to link
 * traversal for query resolution.
 *
 * @returns - The previous maximum follow option.
 * @param value - The new maximum follow option.
 */

      FollowOption set_max_follow_policy (in FollowOption policy);

/* This operation sets the maximum follow option that can
 * be applied to links.
 *
 * @returns - The previous maximum link follow option.
 * @param value - The new maximum link follow option.
 */

      FollowOption set_max_link_follow_policy (in FollowOption policy);

/* This operation sets the service type repository for a trader.
 *
 * @returns - The previous service type repository.
 * @param repository - The new service type repository.
 */

      TypeRepository set_type_repos (in TypeRepository repository);

/* This operation sets a request identifier stem value.
 * This is used to generate unique query identifiers to
 * prevent cyclic query resolution amongst federated traders.
 *
 * @returns - The previous identifier stem.
 * @param stem - The new identifier stem.
 */

      OctetSeq set_request_id_stem (in OctetSeq stem);
 
/* This operation returns a list of offers made by the
 * trader. Offer identifiers not returned in the returned
 * sequence can be accessed through the returned iterator.
 *
 * @param how_many - The number of offers to return.
 * @param ids - The sequence of returned offer identifiers.
 * @param id_itr - The returned offer iterator.
 *
 * @raises NotImplemented - If this operation is not implemented by the trader.
 */
      /* doc: 19 */	
      void list_offers
      (
         in unsigned long how_many,
         out OfferIdSeq ids,
         out OfferIdIterator id_itr
      )
      raises
      (
         NotImplemented
      );
      /* enddoc */
 
/* This operation returns a list of proxy offers made by the
 * trader. Offer identifiers not returned in the returned
 * sequence can be accessed through the returned iterator.
 *
 * @param how_many - The number of offers to return.
 * @param ids - The sequence of returned offer identifiers.
 * @param id_itr - The returned offer iterator.
 *
 * @raises NotImplemented - If the proxy interface is not implemented
 *  by the trader
 */

      void list_proxies
      (
         in unsigned long how_many,
         out OfferIdSeq ids,
         out OfferIdIterator id_itr
      ) raises
      (
         NotImplemented
      );
   };
};

#endif