public class

OracleEBSConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.oracle.OracleEBSConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Extracts a particular OrgCustomer business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Summary

Fields
private Config config
private ServiceBeanHeader header
private boolean loop Set to false when testing.
Public Constructors
OracleEBSConnector()
Public Methods
void businessEvents(SourceCallback callback)
Subscribes to the WF_JMS_JMS_OUT topic and retrieves any business event enqueued to it.
Email createEmail(Email email, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Creates a Email business object.
Location createLocation(Location location, String createdByModule, String objSource, String validateObjFlag)
Creates a Location business object.
Organization createOrganization(Organization organization, String createdByModule, String objSource, String validateObjFlag)
Creates a Organization business object.
OrgContact createOrganizationContact(OrgContact contact, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String validateObjFlag, String objSource, String createdByModule)
Creates a OrgContact business object.
OrgCustomer createOrganizationCustomer(OrgCustomer customer, String createdByModule, String objSource, String validateObjFlag)
Creates an Organization Customer business object.
PartySite createPartySite(PartySite partySite, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String objSource, String validateObjFlag)
Creates a Party Site business object.
Person createPerson(Person person, String createdByModule, String objSource, String validateObjFlag)
Creates a Person business object.
PersonCustomer createPersonCustomer(PersonCustomer personCustomer, String createdByModule, String objSource, String validateObjFlag)
Creates a Person Customer business object.
Phone createPhone(Phone phone, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Creates a Phone business object.
Relationship createRelationship(Relationship relationship, String createdByModule)
Creates a Relationship business object.
Web createWeb(Web web, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Creates a Web business object.
List<MatchedParty> findParties(DqmSearchServiceFindParties body)
Takes a list of Search Party objects and returns a list of Matched Party objects based on the search criteria and match rule id.
Config getConfig()
Email getEmail(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Email business object from TCA.
Location getLocation(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Location business object from TCA.
Organization getOrganization(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Organization business object from TCA.
OrgContact getOrganizationContact(BigDecimal id, String origSys, String origSysRef)
Extracts a particular OrgContact business object from TCA.
OrgCustomer getOrganizationCustomer(BigDecimal id, String origSys, String origSysRef)
Extracts a particular OrgCustomer business object from TCA.
List<OrgCustomer> getOrganizationCustomersCreated(BigDecimal eventId)
Extracts a particular Organization Customer object from TCA.
List<OrgCustomer> getOrganizationCustomersUpdated(BigDecimal eventId)
Extracts a particular Organization customers object from TCA.
List<Organization> getOrganizationsCreated(BigDecimal eventId)
Extracts a particular Organization business object from TCA.
List<Organization> getOrganizationsUpdated(BigDecimal eventId)
Extracts a particular Organization business object from TCA.
static String getOuterXml(XMLStreamReader xmlr)
Converts an XML to String.
PartySite getPartySite(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Party Site business object from TCA.
Person getPerson(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Person business object from TCA.
PersonCustomer getPersonCustomer(BigDecimal id, String origSys, String origSysRef)
Extracts a particular PersonCustomer business object from TCA.
List<PersonCustomer> getPersonCustomersCreated(BigDecimal eventId)
Extracts a particular Person Customer Created business object from TCA.
List<PersonCustomer> getPersonCustomersUpdated(BigDecimal eventId)
Extracts a particular Person Customer Updated business object from TCA.
List<Person> getPersonsCreated(BigDecimal eventId)
Extracts a particular Person Created business object from TCA.
List<Person> getPersonsUpdated(BigDecimal eventId)
Extracts a particular Person Updated business object from TCA.
Phone getPhone(BigDecimal id, String origSys, String origSysRef)
Extracts a particular Phone business object from TCA.
Relationship getRelationship(BigDecimal id)
Extracts a particular Relationship business object from TCA.
Web getWeb(BigDecimal id, String origSys, String sysRef)
Extracts a particular Web business object from TCA.
XMLStreamReader invokePlSql(String type, XMLStreamReader input)
Calls a PL/SQL web service.
Email saveEmail(Email email, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Saves a Email business object.
Location saveLocation(Location location, String createdByModule, String objSource, String validateObjFlag)
Saves a Location business object.
Organization saveOrganization(Organization organization, String createdByModule, String objSource, String validateObjFlag)
Saves a Organization business object.
OrgContact saveOrganizationContact(OrgContact contact, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String validateObjFlag, String objSource)
Saves a OrgContact business object.
OrgCustomer saveOrganizationCustomer(OrgCustomer customer, String createdByModule, String objSource, String validateObjFlag)
Saves a OrgCustomer business object.
PartySite savePartySite(PartySite partySite, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String objSource, String validateObjFlag)
Saves a Party Site business object.
Person savePerson(Person person, String createdByModule, String objSource, String validateObjFlag)
Saves a Person business object.
PersonCustomer savePersonCustomer(PersonCustomer personCustomer, String createdByModule, String objSource, String validateObjFlag)
Saves a Person Customer business object.
Phone savePhone(Phone phone, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Saves a Phone business object.
Relationship saveRelationship(Relationship relationship, String createdByModule)
Saves a Relationship business object.
Web saveWeb(Web web, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)
Saves a Phone business object.
void setConfig(Config config)
void setLoop(boolean loop)
Set to false when testing.
void shutdown()
Closes all connections that were opened, if any.
Email updateEmail(Email email, String createdByModule, String objSrc)
Updates a Email business object.
Location updateLocation(Location location, String createdByModule, String objSource)
Updates a Location business object.
Organization updateOrganization(Organization organization, String createdByModule, String objSource)
Updates a Organization business object.
OrgContact updateOrganizationContact(OrgContact contact, String createdByModule, String objSource)
Updates a OrgContact business object.
OrgCustomer updateOrganizationCustomer(OrgCustomer customer, String createdByModule, String objSource)
Updates a OrgCustomer business object.
PartySite updatePartySite(PartySite partySite, String createdByModule, String objSource)
Updates a Party Site business object.
Person updatePerson(Person person, String createdByModule, String objSource)
Updates a Person business object.
PersonCustomer updatePersonCustomer(PersonCustomer personCustomer, String createdByModule, String objSource)
Updates a Person Customer business object.
Phone updatePhone(Phone phone, String createdByModule, String objSource)
Updates a Phone business object.
Relationship updateRelationship(Relationship relationship)
Updates a Relationship business object.
Web updateWeb(Web web, String createdByModule, String objSrc)
Updates a Web business object.
ReceiveDocumentResponse xmlGateway(String messageType, String messageStandard, String transactionType, String transactionSubtype, String documentNumber, String partyId, String partySiteId, XMLStreamReader body)
Enqueues a message via XML Gateway Inbound.
void xmlGatewayOutbound(SourceCallback callback)
Subscribes to the ECX_OUTBOUND queue and retrieves any messages enqueued to it.
Protected Methods
void validateInput(BigDecimal parentId, String parentOrigSys, String parentOrigSysRef)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private Config config

private ServiceBeanHeader header

private boolean loop

Set to false when testing. This prevents infinite loops from being infinite.

Public Constructors

public OracleEBSConnector ()

Public Methods

public void businessEvents (SourceCallback callback)

Subscribes to the WF_JMS_JMS_OUT topic and retrieves any business event enqueued to it.

Parameters
callback The SourceCallback callback to call when a business event is retrieved.

public Email createEmail (Email email, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Creates a Email business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
email The Email business object to be created
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
Returns
  • The Email business object that was created, returned as an output parameter

public Location createLocation (Location location, String createdByModule, String objSource, String validateObjFlag)

Creates a Location business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
location The Location business object to be created.
createdByModule The module Saving this business object.
objSource Source system invokes the service on this Organization.
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being saved.
Returns
  • Create location result

public Organization createOrganization (Organization organization, String createdByModule, String objSource, String validateObjFlag)

Creates a Organization business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
organization The Organization business object to be created.
createdByModule The module creating this business object.
objSource Source system invokes the service on this Organization.
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Organization business object that was created.

public OrgContact createOrganizationContact (OrgContact contact, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String validateObjFlag, String objSource, String createdByModule)

Creates a OrgContact business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
contact The Organization Contact business object to be created
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
createdByModule The module saving this business object
Returns
  • The Organization Contact business object that was created, returned as an output parameter

public OrgCustomer createOrganizationCustomer (OrgCustomer customer, String createdByModule, String objSource, String validateObjFlag)

Creates an Organization Customer business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
customer The Organization Customer business object to be created
createdByModule The module updating this business object
objSource The originating source system of the object save operation
validateObjFlag Indicates if the passed business object is to be validated for completeness. Default value: true
Returns
  • The Organization Customer business object that was created, returned as an output parameter

public PartySite createPartySite (PartySite partySite, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String objSource, String validateObjFlag)

Creates a Party Site business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
partySite The Party Site business object to be created
createdByModule The module creating this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
objSource The originating source system of the object create operation
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Party Site business object that was created, returned as an output parameterThe Party Site business object that was created, returned as an output parameter

public Person createPerson (Person person, String createdByModule, String objSource, String validateObjFlag)

Creates a Person business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
person The Person business object to be created
createdByModule The module creating this business object
objSource The originating source system of the object create operation
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Person business object that was created, returned as an output parameter

public PersonCustomer createPersonCustomer (PersonCustomer personCustomer, String createdByModule, String objSource, String validateObjFlag)

Creates a Person Customer business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
personCustomer The Person Customer business object to be created
createdByModule The module saving this business object
objSource Indicates if the passed business object is to be validated for completeness if it is being created
validateObjFlag The originating source system of the object create operation
Returns
  • The Person Customer business object that was created, returned as an output parameter

public Phone createPhone (Phone phone, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Creates a Phone business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
phone The Phone business object to be created
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
Returns
  • The Phone business object that was created, returned as an output parameter

public Relationship createRelationship (Relationship relationship, String createdByModule)

Creates a Relationship business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
relationship The Relationship business object to be created
createdByModule The module creating this business object
Returns
  • The Relationship business object that was created, returned as an output parameter

public Web createWeb (Web web, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Creates a Web business object. You pass object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes lower-level embedded child entities or objects that can be simultaneously created.

Parameters
web The Web business object to be created
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
Returns
  • The Web business object that was created, returned as an output parameter

public List<MatchedParty> findParties (DqmSearchServiceFindParties body)

Takes a list of Search Party objects and returns a list of Matched Party objects based on the search criteria and match rule id.

Parameters
body The request
Returns
  • List of Matched Party objects.

public Config getConfig ()

public Email getEmail (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Email business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Email business object
origSys Email original system name
origSysRef Email original system reference
Returns
  • The retrieved Email business object

public Location getLocation (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Location business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Location business object.
origSys Location original system name.
origSysRef Location original system reference.
Returns
  • Get location result

public Organization getOrganization (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Organization business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Organization business object
origSys Organization original system name
origSysRef Organization original system reference
Returns
  • The retrieved ORGANIZATION business object.

public OrgContact getOrganizationContact (BigDecimal id, String origSys, String origSysRef)

Extracts a particular OrgContact business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Organization Contact business object
origSys Organization Contact original system name
origSysRef Organization Contact original system reference
Returns
  • The retrieved Organization Contact business object

public OrgCustomer getOrganizationCustomer (BigDecimal id, String origSys, String origSysRef)

Extracts a particular OrgCustomer business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Organization Customer business object
origSys Parent object original system name.
origSysRef Parent object original system reference.
Returns
  • The retrieved Organization Customer business object

public List<OrgCustomer> getOrganizationCustomersCreated (BigDecimal eventId)

Extracts a particular Organization Customer object from TCA. You pass the Oracle Business Event System event's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId TCA identifier for the Organization Customer business object
Returns
  • The retrieved Organization Customer business object

public List<OrgCustomer> getOrganizationCustomersUpdated (BigDecimal eventId)

Extracts a particular Organization customers object from TCA. You pass the Oracle Business Event System event's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId TCA identifier for the Organization Customer business object
Returns
  • The retrieved Organization Customer business object

public List<Organization> getOrganizationsCreated (BigDecimal eventId)

Extracts a particular Organization business object from TCA. You pass the Oracle Business Event System event's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId ID of BES event's raised when this business object was created.
Returns
  • The retrieved Organization business object

public List<Organization> getOrganizationsUpdated (BigDecimal eventId)

Extracts a particular Organization business object from TCA. You pass the Oracle Business Event System event's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId ID of BES event's raised when this business object was updated.
Returns
  • The retrieved organization business object.

public static String getOuterXml (XMLStreamReader xmlr)

Converts an XML to String.

Parameters
xmlr A XMLStreamReader representing the XML file to convert.
Returns
  • A String with the converted XML.
Throws
TransformerException If the XML cannot be parsed.

public PartySite getPartySite (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Party Site business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Party Site business object
origSys Party Site original system name
origSysRef Party Site original system reference
Returns
  • The retrieved Party Site business object

public Person getPerson (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Person business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Person business object
origSys Person original system name
origSysRef Person original system reference
Returns
  • The retrieved Person business object

public PersonCustomer getPersonCustomer (BigDecimal id, String origSys, String origSysRef)

Extracts a particular PersonCustomer business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Person Customer business object
origSys Person Customer original system name
origSysRef Person Customer original system reference
Returns
  • The retrieved Person Customer business object

public List<PersonCustomer> getPersonCustomersCreated (BigDecimal eventId)

Extracts a particular Person Customer Created business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId ID of BES event's raised when this object was created.
Returns
  • The retrieved Person Customer business object

public List<PersonCustomer> getPersonCustomersUpdated (BigDecimal eventId)

Extracts a particular Person Customer Updated business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId ID of BES event's raised when this object was updated.
Returns
  • The retrieved Person Customer business object

public List<Person> getPersonsCreated (BigDecimal eventId)

Extracts a particular Person Created business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId ID of BES event's raised when this business object was created
Returns
  • The retrieved Person business object

public List<Person> getPersonsUpdated (BigDecimal eventId)

Extracts a particular Person Updated business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
eventId Of BES event's raised when this business object was updated
Returns
  • The retrieved Person business object

public Phone getPhone (BigDecimal id, String origSys, String origSysRef)

Extracts a particular Phone business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Phone business object
origSys Phone original system name
origSysRef Phone original system reference
Returns
  • The retrieved Phone business object

public Relationship getRelationship (BigDecimal id)

Extracts a particular Relationship business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Relationship business object
Returns
  • The retrieved Relationship business object

public Web getWeb (BigDecimal id, String origSys, String sysRef)

Extracts a particular Web business object from TCA. You pass the object's identification information to the operation, and it returns the identified business object as it exists in TCA.

Parameters
id TCA identifier for the Web business object
origSys Web original system name
sysRef Web original system reference
Returns
  • The retrieved Web business object

public XMLStreamReader invokePlSql (String type, XMLStreamReader input)

Calls a PL/SQL web service.

Parameters
type A String with the following format: WSDL_NAME||WSDL_OPERATION_NAME
input Content to be processed. Cannot be null.
Returns
  • An XMLStreamReader with the service response.

public Email saveEmail (Email email, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Saves a Email business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createEmail or updateEmail). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
email The Email business object to be saved
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
Returns
  • The Email business object that was saved, returned as an output parameter

public Location saveLocation (Location location, String createdByModule, String objSource, String validateObjFlag)

Saves a Location business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createLocation or updateLocation). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
location The Location business object to be saved.
createdByModule The module saving this business object.
objSource Source system invokes the service on this Organization.
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being saved.
Returns
  • The Location business object that was saved.

public Organization saveOrganization (Organization organization, String createdByModule, String objSource, String validateObjFlag)

Saves a Organization business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createOrganization or updateOrganization). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
organization The Organization business object to be saved.
createdByModule The module Saving this business object.
objSource Source system invokes the service on this Organization.
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being saved.
Returns
  • The Organization business object that was saved.

public OrgContact saveOrganizationContact (OrgContact contact, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String validateObjFlag, String objSource)

Saves a OrgContact business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createOrgContact or updateOrgContact). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
contact The Organization Contact business object to be saved
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object save operation
Returns
  • The Organization Contact business object that was saved, returned as an output parameter

public OrgCustomer saveOrganizationCustomer (OrgCustomer customer, String createdByModule, String objSource, String validateObjFlag)

Saves a OrgCustomer business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createOrgCustomer or updateOrgCustomer). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
customer The Organization Customer business object to be saved
createdByModule The module saving this business object
objSource The originating source system of the object save operation
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Organization Customer business object that was saved.

public PartySite savePartySite (PartySite partySite, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String objSource, String validateObjFlag)

Saves a Party Site business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createPartySite or updatePartySite). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
partySite The Party Site business object to be saved
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
objSource The originating source system of the object save operation
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Party Site business object that was saved, returned as an output parameter

public Person savePerson (Person person, String createdByModule, String objSource, String validateObjFlag)

Saves a Person business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createPerson or updatePerson). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
person The Person business object to be saved
createdByModule The module saving this business object
objSource The originating source system of the object save operation
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
Returns
  • The Person business object that was saved, returned as an output parameter

public PersonCustomer savePersonCustomer (PersonCustomer personCustomer, String createdByModule, String objSource, String validateObjFlag)

Saves a Person Customer business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createPersonCustomer or updatePersonCustomer). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
personCustomer The Person Customer business object to be saved
createdByModule The module Saving this business object.
objSource Source system invokes the service on this Organization.
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being saved.
Returns
  • The Person Customer business object that was saved, returned as an output parameter

public Phone savePhone (Phone phone, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Saves a Phone business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createPhone or updatePhone). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
phone The Phone business object to be saved
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object save operation
Returns
  • The Phone business object that was saved, returned as an output parameter

public Relationship saveRelationship (Relationship relationship, String createdByModule)

Saves a Relationship business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createRelationship or updateRelationship). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
relationship The Relationship business object to be saved
createdByModule The module saving this business object
Returns
  • The Relationship business object that was saved, returned as an output parameter

public Web saveWeb (Web web, String createdByModule, BigDecimal parentId, String parentOrigSys, String parentOrigSysRef, String parentObjType, String validateObjFlag, String objSource)

Saves a Phone business object. You pass new or modified object data to the operation, packaged within an object type defined specifically for the business operation. The service then determines if the object exists in TCA, based upon the provided identification information, and creates or updates the object. For either case, the object type that you provide will be processed as if the respective API procedure is being called (createWeb or updateWeb). Please see those operations for more details. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
web The Web business object to be saved
createdByModule The module saving this business object
parentId TCA identifier for parent object. Either this parameter, or both the parentOrigSys and parentOrigSysRef parameters, must be given
parentOrigSys Parent object original system name
parentOrigSysRef Parent object original system reference
parentObjType Parent object type. Validated against HZ_BUSINESS_OBJECTS lookup type
validateObjFlag Indicates if the passed business object is to be validated for completeness if it is being created
objSource The originating source system of the object create operation
Returns
  • Save party site result

public void setConfig (Config config)

Parameters
config The config to set

public void setLoop (boolean loop)

Set to false when testing. This prevents infinite loops from being infinite.

Parameters
loop The boolean to set

public void shutdown ()

Closes all connections that were opened, if any.

public Email updateEmail (Email email, String createdByModule, String objSrc)

Updates a Email business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
email The Email business object to be updated
createdByModule The module saving this business object
objSrc The originating source system of the object update operation
Returns
  • The Email business object that was updated, returned as an output parameter

public Location updateLocation (Location location, String createdByModule, String objSource)

Updates a Location business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
location The Location business object to be updated.
createdByModule The module updating this business object.
objSource The originating source system of the object update operation.
Returns
  • The Location business object that was updated.

public Organization updateOrganization (Organization organization, String createdByModule, String objSource)

Updates a Organization business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
organization The Organization business object to be updated.
createdByModule The module Saving this business object.
objSource Source system invokes the service on this Organization.
Returns
  • The Organization business object that was updated.

public OrgContact updateOrganizationContact (OrgContact contact, String createdByModule, String objSource)

Updates a OrgContact business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
contact The Organization Contact business object to be updated
createdByModule The module saving this business object
objSource The originating source system of the object update operation
Returns
  • The Organization Contact business object that was updated, returned as an output parameter

public OrgCustomer updateOrganizationCustomer (OrgCustomer customer, String createdByModule, String objSource)

Updates a OrgCustomer business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
customer The Organization Customer business object to be updated
createdByModule The module updating this business object
objSource The originating source system of the object update operation
Returns
  • The Organization Customer business object that was updated.

public PartySite updatePartySite (PartySite partySite, String createdByModule, String objSource)

Updates a Party Site business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
partySite The Party Site business object to be updated
createdByModule The module saving this business object
objSource The originating source system of the object update operation
Returns
  • The Party Site business object that was updated, returned as an output parameter

public Person updatePerson (Person person, String createdByModule, String objSource)

Updates a Person business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
person The Person business object to be updated
createdByModule The module saving this business object
objSource The originating source system of the object update operation
Returns
  • The Person business object that was updated, returned as an output parameter

public PersonCustomer updatePersonCustomer (PersonCustomer personCustomer, String createdByModule, String objSource)

Updates a Person Customer business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
personCustomer The Person Customer business object to be updated
createdByModule The module Saving this business object.
objSource Source system invokes the service on this Organization.
Returns
  • The Person Customer business object that was updated, returned as an output parameter

public Phone updatePhone (Phone phone, String createdByModule, String objSource)

Updates a Phone business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
phone The Phone business object to be updated
createdByModule The module saving this business object
objSource The originating source system of the object update operation
Returns
  • The Phone business object that was updated, returned as an output parameter

public Relationship updateRelationship (Relationship relationship)

Updates a Relationship business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
relationship The Relationship business object to be updated
Returns
  • The Relationship business object that was updated, returned as an output parameter

public Web updateWeb (Web web, String createdByModule, String objSrc)

Updates a Web business object. You pass any modified object data to the operation, packaged within an object type defined specifically for the business operation. In addition to the object's business object attributes, the object type also includes embedded child business entities or objects that can be simultaneously created or updated.

Parameters
web The Web business object to be updated
createdByModule The module saving this business object
objSrc The originating source system of the object update operation
Returns
  • The Web business object that was updated, returned as an output parameter

public ReceiveDocumentResponse xmlGateway (String messageType, String messageStandard, String transactionType, String transactionSubtype, String documentNumber, String partyId, String partySiteId, XMLStreamReader body)

Enqueues a message via XML Gateway Inbound.

Parameters
messageType Payload message format. This defaults to XML. Oracle XML Gateway currently supports only XML.
messageStandard Message format standard as displayed in the Define Transactions form and entered in the Define XML Standards form. This defaults to OAG.
transactionType External Transaction Type for the business document from the Trading Partner table.
transactionSubtype External Transaction Subtype for the business document from the Trading Partner table.
documentNumber The document identifier used to identify the transaction, such as a purchase order or invoice number. This parameter is not used by the XML Gateway, but it may be passed on inbound messages. Optional.
partyId The party identifier. Optional.
partySiteId The party site identifier for the inbound XML document.
body The payload to be enqueued.
Returns
  • The response from the web service in charge of enqueuing the document.
Throws
TransformerException If the XML body cannot be parsed.

public void xmlGatewayOutbound (SourceCallback callback)

Subscribes to the ECX_OUTBOUND queue and retrieves any messages enqueued to it.

Parameters
callback The SourceCallback callback to call when a business event is retrieved.

Protected Methods

protected void validateInput (BigDecimal parentId, String parentOrigSys, String parentOrigSysRef)

Parameters
parentId
parentOrigSys
parentOrigSysRef