TPMControl Interface

com.bea.control
TPMControl Interface

public interface TPMControl

    extends Control
All Superinterfaces
Control, Control, Serializable

Nested Class Summary
 
Nested classes from interface com.bea.control.Control
Control.Callback
 

Method Summary
public TradingPartnerDocument
getBasicProperties(String partnerId)
Gets the basic properties of a Trading Partner.
public EbxmlBindingDocument
getDefaultEbxmlBinding(String partnerId, String ebxmlVersion)
Gets the default ebXML binding for a Trading Partner.
public TradingPartnerDocument
getDefaultPartner()
Gets the default Trading Partner.
public RosettanetBindingDocument
getDefaultRosettanetBinding(String partnerId, String rnVersion)
Gets the default Rosettanet binding for a Trading Partner.
public ExtendedPropertySetDocument
getExtendedPropertySet(String partnerId, String propertySetName)
Gets an extended property set of a Trading Partner.
public TradingPartnerDocument
getPartnerById(String partnerId)
Gets a Trading Partner.
public TradingPartnerDocument
getPartnerByName(String partnerName)
Gets a Trading Partner.
public ServiceDocument
getService(String serviceName)
Gets a Service.
public ServiceProfileDocument
getServiceProfile(String serviceName, String toPartnerId, String fromPartnerId)
Gets a ServiceProfile.
public EbxmlBindingDocument
getServiceProfileEbxmlBinding(String serviceName, String toPartnerId, String fromPartnerId, boolean toPartnerBinding)
Gets the EbxmlBinding of a ServiceProfile.
public RosettanetBindingDocument
getServiceProfileRosettanetBinding(String serviceName, String toPartnerId, String fromPartnerId, boolean toPartnerBinding)
Gets the RosettanetBinding of a ServiceProfile.
public WebServiceBindingDocument
getServiceProfileWebServiceBinding(String serviceName, String toPartnerId, String fromPartnerId, boolean toPartnerBinding)
Gets the WebServiceBinding of a ServiceProfile.

Method Detail

getBasicProperties(String) Method

public TradingPartnerDocument getBasicProperties(String partnerId)
     throws TPMControlException
Gets the basic properties of a Trading Partner.

Parameters

partnerId
Business Id of the Trading Partner

Returns

TradingPartnerDocument XBean encapsulating the attributes of the TradingPartner schema in TPM

Exceptions

TPMControlException

getDefaultEbxmlBinding(String, String) Method

public EbxmlBindingDocument getDefaultEbxmlBinding(String partnerId, 
                                                   String ebxmlVersion)
     throws TPMControlException
Gets the default ebXML binding for a Trading Partner.

Parameters

partnerId
Business Id of the Trading Partner
ebxmlVersion
ebXML version of the binding

Returns

EbxmlBindingDocument XBean encapsulating the XML fragment conforming to the EbxmlBinding schema in TPM

Exceptions

TPMControlException

getDefaultPartner() Method

public TradingPartnerDocument getDefaultPartner()
     throws TPMControlException
Gets the default Trading Partner.

Returns

TradingPartnerDocument XBean encapsulating the XML fragment conforming to the TradingPartner schema in TPM

Exceptions

TPMControlException

getDefaultRosettanetBinding(String, String) Method

public RosettanetBindingDocument getDefaultRosettanetBinding(String partnerId, 
                                                             String rnVersion)
     throws TPMControlException
Gets the default Rosettanet binding for a Trading Partner.

Parameters

partnerId
Business Id of the Trading Partner
rnVersion
Rosettanet version of the binding

Returns

RosettanetBindingDocument XBean encapsulating the XML fragment conforming to the RosettanetBinding schema in TPM

Exceptions

TPMControlException

getExtendedPropertySet(String, String) Method

public ExtendedPropertySetDocument getExtendedPropertySet(String partnerId, 
                                                          String propertySetName)
     throws TPMControlException
Gets an extended property set of a Trading Partner.

Parameters

partnerId
Business Id of the Trading Partner
propertySetName
Name of the property set

Returns

ExtendedPropertySetDocument XBean encapsulating the XML fragment conforming to the ExtendedPropertySet schema in TPM

Exceptions

TPMControlException

getPartnerById(String) Method

public TradingPartnerDocument getPartnerById(String partnerId)
     throws TPMControlException
Gets a Trading Partner.

Parameters

partnerId
Business Id of the Trading Partner

Returns

TradingPartnerDocument XBean encapsulating the XML fragment conforming to the TradingPartner schema in TPM

Exceptions

TPMControlException

getPartnerByName(String) Method

public TradingPartnerDocument getPartnerByName(String partnerName)
     throws TPMControlException
Gets a Trading Partner.

Parameters

partnerName
Name of the Trading Partner

Returns

TradingPartnerDocument XBean encapsulating the XML fragment conforming to the TradingPartner schema in TPM

Exceptions

TPMControlException

getService(String) Method

public ServiceDocument getService(String serviceName)
     throws TPMControlException
Gets a Service.

Parameters

serviceName
Name of the Service

Returns

ServiceDocument XBean encapsulating the XML fragment conforming to the Service schema in TPM

Exceptions

TPMControlException

getServiceProfile(String, String, String) Method

public ServiceProfileDocument getServiceProfile(String serviceName, 
                                                String toPartnerId, 
                                                String fromPartnerId)
     throws TPMControlException
Gets a ServiceProfile.

Parameters

serviceName
Name of the Service
toPartnerId
Business Id of the receiving Trading Partner
fromPartnerId
Business Id of the sending Trading Partner

Returns

ServiceProfileDocument XBean encapsulating the XML fragment conforming to the ServiceProfile schema in TPM

Exceptions

TPMControlException

getServiceProfileEbxmlBinding(String, String, String, boolean) Method

public EbxmlBindingDocument getServiceProfileEbxmlBinding(String serviceName, 
                                                          String toPartnerId, 
                                                          String fromPartnerId, 
                                                          boolean toPartnerBinding)
     throws TPMControlException
Gets the EbxmlBinding of a ServiceProfile.

Parameters

serviceName
Name of the Service
toPartnerId
Business Id of the receiving Trading Partner
fromPartnerId
Business Id of the sending Trading Partner
toPartnerBinding
'true' if requesting receiving Trading Partner Binding

Returns

EbxmlBindingDocument XBean encapsulating the XML fragment conforming to the EbxmlBinding schema in TPM

Exceptions

TPMControlException

getServiceProfileRosettanetBinding(String, String, String, boolean) Method

public RosettanetBindingDocument getServiceProfileRosettanetBinding(String serviceName, 
                                                                    String toPartnerId, 
                                                                    String fromPartnerId, 
                                                                    boolean toPartnerBinding)
     throws TPMControlException
Gets the RosettanetBinding of a ServiceProfile.

Parameters

serviceName
Name of the Service
toPartnerId
Business Id of the receiving Trading Partner
fromPartnerId
Business Id of the sending Trading Partner
toPartnerBinding
'true' if requesting receiving Trading Partner Binding

Returns

RosettanetBindingDocument XBean encapsulating the XML fragment conforming to the RosettanetBinding schema in TPM

Exceptions

TPMControlException

getServiceProfileWebServiceBinding(String, String, String, boolean) Method

public WebServiceBindingDocument getServiceProfileWebServiceBinding(String serviceName, 
                                                                    String toPartnerId, 
                                                                    String fromPartnerId, 
                                                                    boolean toPartnerBinding)
     throws TPMControlException
Gets the WebServiceBinding of a ServiceProfile.

Parameters

serviceName
Name of the Service
toPartnerId
Business Id of the receiving Trading Partner
fromPartnerId
Business Id of the sending Trading Partner
toPartnerBinding
'true' if requesting receiving Trading Partner Binding

Returns

WebServiceBindingDocument XBean encapsulating the XML fragment conforming to the WebServiceBinding schema in TPM

Exceptions

TPMControlException