XPGInfrastructureItf SendToXPDM
Usage: you must use this class as is. You should never derive it.
public class SendToXPDM
Class to provide service for sending export event.
Should not be inherited.
PLM Component and XPDM target site must be set before sending export event.
Role: This class provides methods to set export options and a method to send export event.
Constructor and Destructor Index
- o
SendToXPDM()
- Constructs a SendToXPDM object.
- o
~SendToXPDM()
- Destructs SendToXPDM object.
Method Index
- o
Send(CATString&,CATError*&)
- Send the event to XPDM.
- o
SetCustomParams(CATListOfCATUnicodeString)
- Sets the list of custom name/values parameters that will be added to the resulting event.
- o
SetDescription(CATUnicodeString&)
- Sets the description of the resulting event.
- o
SetQueueName(CATUnicodeString&)
- Sets the name of Queue in which resulting event will be sent.
- o
SetSourceObjectID(CATIAdpPLMIdentificator*)
- Sets the PLM Component to be exported to XPDM.
- o
SetTargetSiteID(CATUnicodeString&)
- Sets the XPDM target site.
- o
SetTransferOption(CATUnicodeString&)
- Sets the option string which enables selection of right connection parameter file.
Constructor and Destructor
o SendToXPDM
-
Constructs a SendToXPDM object.
o ~SendToXPDM
-
Destructs SendToXPDM object.
Methods
o Send
| public Send( | | oEventUid, |
| | opReturnError) |
-
Send the event to XPDM.
Role: This method will send the event with event parameters already set by the other set methods of this class.
- Parameters:
-
- oEventUid
- [out] Unique ID of resulting event. Returned if send event is successful. Can be used for monitoring.
- opReturnError
- [out, CATBaseUnknown#Release] Error ID and Message for failure reason. Returned if send event is not successful.
If send event is successful for all the objects then opReturnError will be NULL.
- Returns:
-
- E_FAIL
- If Send Event has failed.
- S_FALSE
- If selectec objects are not supported. Note that event is fired for some of the objects.
- S_OK
- If Send Event is successful.
o SetCustomParams
| public SetCustomParams( | | iCustomParams) |
-
Sets the list of custom name/values parameters that will be added to the resulting event.
This is an optional method.
Role: Set the description of resulting event.
- Parameters:
-
- iCustomParams
- [in] list of custom name/values. example :
List Index 1: Key 1
List Index 2: Value 1
List Index 3: Key 2
List Index 4: Value 2
- Returns:
-
- E_INVALIDARG
- If list size is odd.
- S_OK
- If custom parameter is successfully set.
o SetDescription
| public SetDescription( | const | iDescription) |
-
Sets the description of the resulting event.
This is an optional method.
Role: Set the description of resulting event.
- Parameters:
-
- iDescription
- [in] string description of resulting event
- Returns:
-
- S_OK
- If description is successfully set.
o SetQueueName
| public SetQueueName( | const | iQueueName) |
-
Sets the name of Queue in which resulting event will be sent.
This is an optional method. If not called, Queue name will be name of the user logged in to 3DEXPERIENCE session.
Role: Set the Queue name.
- Parameters:
-
- iQueueName
- [in] Queue name
- Returns:
-
- S_OK
- If queue name is successfully set.
o SetSourceObjectID
| public SetSourceObjectID( | | ipObjectId) |
-
Sets the PLM Component to be exported to XPDM.
Role: Sets a single object to export.
- Parameters:
-
- ipObjectId
- [in] PLM Component to export. Object is replaced with previously set objects if any.
- Returns:
-
- E_INVALIDARG
- If ipObjectId is NULL.
- S_OK
- if object identifier have been successfully set.
o SetTargetSiteID
| public SetTargetSiteID( | const | iTargetSiteID) |
-
Sets the XPDM target site. It must match site IDs defined during Event Bus deployment.
Role: Set the XPDM target site.
- Parameters:
-
- iTargetSiteID
- [in] XPDM target site
- Returns:
-
- E_INVALIDARG
- If target site is empty.
- S_OK
- If target site is successfully set.
o SetTransferOption
| public SetTransferOption( | const | iTransferoption) |
-
Sets the option string which enables selection of right connection parameter file.
Option string is defined by administrator during setup of Adapter for X-PDM.
This is an optional method.
Role: Set the option string.
- Parameters:
-
- iTransferoption
- [in] Option string
- Returns:
-
- S_OK
- If option string is successfully set.
This object is included in the file: SendToXPDM.h
If needed, your Imakefile.mk should include the module: SendToXPDMAPI
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.