CosTrading::Link Interface Reference

This interface is used to federate traders together and manage the links between them. More...

import "CosTrading.idl";

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

List of all members.

Public Member Functions

void add_link (in LinkName name, in Lookup target, in FollowOption def_pass_on_follow_rule, in FollowOption limiting_follow_rule) raises ( IllegalLinkName, DuplicateLinkName, InvalidLookupRef, DefaultFollowTooPermissive, LimitingFollowTooPermissive )
 This operation links a federated trader.
void remove_link (in LinkName name) raises ( IllegalLinkName, UnknownLinkName )
 This operation removes a link to a federated trader.
LinkInfo describe_link (in LinkName name) raises ( IllegalLinkName, UnknownLinkName )
 This operation describes a link to a federated trader, returning a structure containing the link description.
LinkNameSeq list_links ()
 This operation returns a sequence of links.
void modify_link (in LinkName name, in FollowOption def_pass_on_follow_rule, in FollowOption limiting_follow_rule) raises ( IllegalLinkName, UnknownLinkName, DefaultFollowTooPermissive, LimitingFollowTooPermissive )
 This operation modifies a link to a federated trader, changing the follow options that are applied to the link.

Classes

exception  DefaultFollowTooPermissive
exception  DuplicateLinkName
exception  IllegalLinkName
exception  LimitingFollowTooPermissive
struct  LinkInfo
 This structure holds information about federated trader interfaces. More...
exception  UnknownLinkName


Detailed Description

This interface is used to federate traders together and manage the links between them.


Member Function Documentation

void CosTrading::Link::add_link ( in LinkName  name,
in Lookup  target,
in FollowOption  def_pass_on_follow_rule,
in FollowOption  limiting_follow_rule 
) raises ( IllegalLinkName, DuplicateLinkName, InvalidLookupRef, DefaultFollowTooPermissive, LimitingFollowTooPermissive )

This operation links a federated trader.

Parameters:
name - The name of the linked trader.
target - The Lookup interface to link.
def_pass_on_follow_rule - The default lookup policy to propagate if none was specified in the query.
limiting_follow_rule - The most permissive link policy that can be applied to the link.
IllegalLinkName - If the specified link name has invalid syntax. DuplicateLinkName - If a link with the same name already exists. InvalidLookupRef - If the specified target reference is nil. DefaultFollowTooPermissive - If the default lookup policy for the link is more premissive than the limiting lookup policy for the link. LimitingFollowTooPermissive - If the link default lookup policy is more permissive that the corresponding trader maximum allowed value.

LinkInfo CosTrading::Link::describe_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.
Parameters:
name - The name of the linked trader.
IllegalLinkName - If the specified link name has invalid syntax. UnknownLinkName - If the specified link cannot be found.

LinkNameSeq CosTrading::Link::list_links (  ) 

This operation returns a sequence of links.

void CosTrading::Link::modify_link ( in LinkName  name,
in FollowOption  def_pass_on_follow_rule,
in FollowOption  limiting_follow_rule 
) raises ( IllegalLinkName, UnknownLinkName, DefaultFollowTooPermissive, LimitingFollowTooPermissive )

This operation modifies a link to a federated trader, changing the follow options that are applied to the link.

Parameters:
name - The name of the linked trader.
def_pass_on_follow_rule - The default lookup policy to propagate if none was specified in the query.
limiting_follow_rule - The most permissive link policy that can be applied to the link.
IllegalLinkName - If the specified link name has invalid syntax. UnknownLinkName - If the specified link cannot be found. DefaultFollowTooPermissive - If the default lookup policy for the link is more premissive than the limiting lookup policy for the link. LimitingFollowTooPermissive - If the link default lookup policy is more permissive that the corresponding trader maximum allowed value.

void CosTrading::Link::remove_link ( in LinkName  name  )  raises ( IllegalLinkName, UnknownLinkName )

This operation removes a link to a federated trader.

Parameters:
name - The name of the linked trader.
IllegalLinkName - If the specified link name has invalid syntax. UnknownLinkName - If the specified link cannot be found.