public class

SiebelBusObjectConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.siebel.SiebelBusObjectConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Oracle Siebel Java Data Beans connector

Summary

Fields
private SiebelDataBeanClient client Siebel Client
private String dataSenseFilterQueryBusComp Query for filtering DataSense Business Components results
private String dataSenseFilterQueryBusObjects Query for filtering DataSense Business Objects results
private Boolean dataSenseHierarchicalDiscovery Indicates if the fields discovery will recreate hierarchical objects within business components
private int defaultViewModeBusComp default view mode for DataSense purposes
private int defaultViewModeBusObjects default view mode for Business Objects discovery
private String user
Public Constructors
SiebelBusObjectConnector()
Public Methods
void connect(String user, String password, String server, String port, String serverName, String objectManager, String language, String fileEncoding)
Login to Siebel server
String connectionId()
Connection identifier
CreateResult createBusinessComponent(String businessObjectComponentType, Map<String, Object> businessComponentFields)
Creates a new business component
boolean deleteBusinessComponent(String businessObjectComponentType, String businessComponentId, Integer viewMode)
Deletes a Siebel business component record from Id
void disconnect()
Disconnect
SiebelDataBeanClient getClient()
String getDataSenseFilterQueryBusComp()
String getDataSenseFilterQueryBusObjects()
Boolean getDataSenseHierarchicalDiscovery()
int getDefaultViewModeBusComp()
int getDefaultViewModeBusObjects()
MetaData getMetaData(MetaDataKey key)
List<MetaDataKey> getMetaDataKeys()
String getUser()
boolean isConnected()
Check if it's connected
List<Map<String, Object>> queryBusinessComponents(String businessObjectComponentType, List<String> fieldsToRetrieve, Map<String, String> searchSpec, String searchExpression, Integer viewMode)
Retrieves a list of business components depending on a given search spec or search expression
List<Map<String, Object>> queryJoinBusinessComponents(String businessObjectComponentType, List<String> fieldsToRetrieve, Map<String, String> searchSpec, String searchExpression, String businessObjectComponentTypeToJoin, List<String> fieldsToRetrieveToJoin, Map<String, String> joinCondition, Integer viewMode)
Allows retrieving two different business object, joining them according to an specified criteria
void setClient(SiebelDataBeanClient client)
void setDataSenseFilterQueryBusComp(String dataSenseFilterQueryBusComp)
void setDataSenseFilterQueryBusObjects(String dataSenseFilterQueryBusObjects)
void setDataSenseHierarchicalDiscovery(Boolean dataSenseHierarchicalDiscovery)
void setDefaultViewModeBusComp(int defaultViewModeBusComp)
void setDefaultViewModeBusObjects(int defaultViewModeBusObjects)
void setUser(String user)
UpdateResult updateBusinessComponent(String businessObjectComponentType, Map<String, String> searchSpec, Map<String, Object> businessComponentFields, Integer viewMode)
Updates Siebel business component from values map
UpsertResult upsertBusinessComponent(String businessObjectComponentType, Map<String, Object> businessComponentFields, List<String> idFields, Integer viewMode)
Creates or updates a business component depending if it exists or no.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private SiebelDataBeanClient client

Siebel Client

private String dataSenseFilterQueryBusComp

Query for filtering DataSense Business Components results

private String dataSenseFilterQueryBusObjects

Query for filtering DataSense Business Objects results

private Boolean dataSenseHierarchicalDiscovery

Indicates if the fields discovery will recreate hierarchical objects within business components

private int defaultViewModeBusComp

default view mode for DataSense purposes

private int defaultViewModeBusObjects

default view mode for Business Objects discovery

private String user

Public Constructors

public SiebelBusObjectConnector ()

Public Methods

public void connect (String user, String password, String server, String port, String serverName, String objectManager, String language, String fileEncoding)

Login to Siebel server

Parameters
user Siebel username
password Siebel password
server Siebel server
port Siebel port
serverName Siebel Enterprise server name
objectManager Siebel Object Manager
language Connection language
fileEncoding Connection file encoding
Throws
ConnectionException

public String connectionId ()

Connection identifier

public CreateResult createBusinessComponent (String businessObjectComponentType, Map<String, Object> businessComponentFields)

Creates a new business component

Parameters
businessObjectComponentType Siebel's business object component type
businessComponentFields Map with the list of values to be added to the new component
Returns
  • created business component id
Throws
SiebelException when the service fails

public boolean deleteBusinessComponent (String businessObjectComponentType, String businessComponentId, Integer viewMode)

Deletes a Siebel business component record from Id

Parameters
businessObjectComponentType Siebel's business object component type
businessComponentId Id of the business component to be deleted
viewMode Siebel business component view mode
Returns
  • true if the operation was successful
Throws
SiebelException when the service fails

public void disconnect ()

Disconnect

Throws
SiebelException

public SiebelDataBeanClient getClient ()

public String getDataSenseFilterQueryBusComp ()

public String getDataSenseFilterQueryBusObjects ()

public Boolean getDataSenseHierarchicalDiscovery ()

public int getDefaultViewModeBusComp ()

public int getDefaultViewModeBusObjects ()

public MetaData getMetaData (MetaDataKey key)

Parameters
key
Throws
Exception

public List<MetaDataKey> getMetaDataKeys ()

Throws
SiebelException

public String getUser ()

public boolean isConnected ()

Check if it's connected

public List<Map<String, Object>> queryBusinessComponents (String businessObjectComponentType, List<String> fieldsToRetrieve, Map<String, String> searchSpec, String searchExpression, Integer viewMode)

Retrieves a list of business components depending on a given search spec or search expression

Parameters
businessObjectComponentType Siebel's business object component type
fieldsToRetrieve List of fields to retrieve in the query
searchSpec Map with search values to be used as filters in the query
searchExpression Search expression for Siebel's business components
viewMode Siebel business component view mode
Returns
  • list of maps with the components values
Throws
SiebelException when the service fails

public List<Map<String, Object>> queryJoinBusinessComponents (String businessObjectComponentType, List<String> fieldsToRetrieve, Map<String, String> searchSpec, String searchExpression, String businessObjectComponentTypeToJoin, List<String> fieldsToRetrieveToJoin, Map<String, String> joinCondition, Integer viewMode)

Allows retrieving two different business object, joining them according to an specified criteria

Parameters
businessObjectComponentType Siebel's business object component type
fieldsToRetrieve List of fields to retrieve in the query
searchSpec Map with search values to be used as filters in the query
searchExpression Search expression for Siebel's business components
businessObjectComponentTypeToJoin Business object component to join
fieldsToRetrieveToJoin Fields to retrieve for the business component to join
joinCondition Map containing the join condition for the business object. The structure is (key[field in object1], value[field in object 2])
viewMode Siebel business component view mode
Returns
  • list of maps with the components values
Throws
SiebelException when the service fails

public void setClient (SiebelDataBeanClient client)

Parameters
client

public void setDataSenseFilterQueryBusComp (String dataSenseFilterQueryBusComp)

Parameters
dataSenseFilterQueryBusComp

public void setDataSenseFilterQueryBusObjects (String dataSenseFilterQueryBusObjects)

Parameters
dataSenseFilterQueryBusObjects

public void setDataSenseHierarchicalDiscovery (Boolean dataSenseHierarchicalDiscovery)

Parameters
dataSenseHierarchicalDiscovery

public void setDefaultViewModeBusComp (int defaultViewModeBusComp)

Parameters
defaultViewModeBusComp

public void setDefaultViewModeBusObjects (int defaultViewModeBusObjects)

Parameters
defaultViewModeBusObjects

public void setUser (String user)

Parameters
user

public UpdateResult updateBusinessComponent (String businessObjectComponentType, Map<String, String> searchSpec, Map<String, Object> businessComponentFields, Integer viewMode)

Updates Siebel business component from values map

Parameters
businessObjectComponentType Siebel's business object component type
searchSpec Map containing the spec for searching business components to update
businessComponentFields Map with the list of values to be updated in the component
viewMode Siebel business component view mode
Returns
  • true if operation was successful
Throws
SiebelException when the service fails

public UpsertResult upsertBusinessComponent (String businessObjectComponentType, Map<String, Object> businessComponentFields, List<String> idFields, Integer viewMode)

Creates or updates a business component depending if it exists or no. For checking if the record exists, it queries Siebel taking into account the list of idfields. If the list is null, it will take the Id field from the business component fields map.

Parameters
businessObjectComponentType Siebel's business object component type
businessComponentFields Map with the list of values to be updated in the component
idFields List of fields to be taken as identifiers of the record to analyze if it should be created or not
viewMode Siebel business component view mode
Returns
  • id of the created or updated business component
Throws
SiebelException when the service fails