JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Master Index Processing Reference     Java CAPS Documentation
search filter icon
search icon

Document Information

Oracle Java CAPS Master Index Processing Reference

Understanding Operational Processes

The Database Structure

Working with the Java API

Overview

Java Class Types

Static Classes

Dynamic Web Services Classes

Dynamic Web Service Methods

Dynamic API Method Descriptions

activateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

activateSystemRecord

Description

Syntax

Parameters

Returns

Throws

addSystemRecord

Description

Syntax

Parameters

Returns

Throws

deactivateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

deactivateSystemRecord

Description

Syntax

Parameters

Returns

Throws

executeMatch

Syntax

Parameters

Returns

Throws

executeMatchUpdate

Syntax

Parameters

Returns

Throws

getEnterpriseRecordByEUID

Description

Syntax

Parameters

Returns

Throws

getEnterpriseRecordByLID

Description

Syntax

Parameters

Returns

Throws

getEUID

Description

Syntax

Parameters

Returns

Throws

getLIDs

Description

Syntax

Parameters

Returns

Throws

getLIDsByStatus

Description

Syntax

Parameters

Returns

Throws

getSBR

Description

Syntax

Parameters

Returns

Throws

getSystemRecord

Description

Syntax

Parameters

Returns

Throws

getSystemRecordsByEUID

Description

Syntax

Parameters

Returns

Throws

getSystemRecordsByEUIDStatus

Description

Syntax

Parameters

Returns

Throws

lookupLIDs

Description

Syntax

Parameters

Returns

Throws

lookupPotentialDuplicates

Description

Syntax

Parameters

Returns

Throws

mergeEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

mergeSystemRecord

Description

Syntax

Parameters

Returns

Throws

searchBlock

Description

Syntax

Parameters

Returns

Throws

searchExact

Description

Syntax

Parameters

Returns

Throws

searchPhonetic

Description

Syntax

Parameters

Returns

Throws

transferSystemRecord

Description

Syntax

Parameters

Returns

Throws

updateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

updateSystemRecord

Description

Syntax

Parameters

Returns

Throws

Web Services Helper Classes

Enterprise Object Classes

Definition

Methods

EnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

countSystemObjectName

Description

Syntax

Parameters

Returns

Throws

deleteSystemObject

Description

Syntax

Parameters

Returns

Throws

deleteSystemObjectBean

Description

Syntax

Parameters

Returns

Throws

getEUID

Description

Syntax

Parameters

Returns

Throws

getSBRObjectName

Description

Syntax

Parameters

Returns

Throws

getStatus

Description

Syntax

Parameters

Returns

Throws

getSystemObjectName

Description

Syntax

Parameters

Returns

Throws

getSystemObjectName

Description

Syntax

Parameters

Returns

Throws

getSystemObjectNameCount

Description

Syntax

Parameters

Returns

Throws

removeSystemObject

Description

Syntax

Parameters

Returns

Throws

removeSystemObjectBean

Description

Syntax

Parameters

Returns

Throws

setEUID

Description

Syntax

Parameters

Returns

Throws

setStatus

Description

Syntax

Parameters

Returns

Throws

setSystemObjectName

Description

Syntax

Parameters

Returns

Throws

SystemObjectName

Definition

Methods

Inherited Methods

Clear Field Indicator

SystemObjectName

Description

Syntax

Parameters

Returns

Throws

getClearFieldIndicator

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getObjectName

Description

Syntax

Parameters

Returns

Throws

setClearFieldIndicator

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setObjectName

Description

Syntax

Parameters

Returns

Throws

Parent Beans

Definition

Methods

Inherited Methods

ObjectNameBean

Description

Syntax

Parameters

Returns

Throws

countChild

Description

Syntax

Parameters

Returns

Throws

countChildren

Description

Syntax

Parameters

Returns

Throws

countChildren

Description

Syntax

Parameters

Returns

Throws

deleteChild

Description

Syntax

Parameters

Returns

Throws

getChild

Description

Syntax

Parameters

Returns

Throws

getChild

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getObjectNameId

Description

Syntax

Parameters

Returns

Throws

setChild

Description

Syntax

Parameters

Returns

Throws

setChild

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setObjectNameId

Description

Syntax

Parameters

Returns

Throws

Child Beans

Definition

Methods

Inherited Methods

ChildBean

Description

Syntax

Parameters

Returns

Throws

delete

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getChildId

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setChildId

Description

Syntax

Parameters

Returns

Throws

DestinationEO

Definition

Methods

getEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

setEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

MergeObjectNameResult

Definition

Methods

MergeObjectNameResult

Description

Syntax

Parameters

Returns

Throws

getDestinationEO

Description

Syntax

Parameters

Returns

Throws

getSourceEO

Description

Syntax

Parameters

Returns

Throws

setDestinationEO

Description

Syntax

Parameters

Returns

Throws

setSourceEO

Description

Syntax

Parameters

Returns

Throws

SBRObjectName

Definition

Methods

SBRObjectName

Description

Syntax

Parameters

Returns

Throws

SBRObjectName

Description

Syntax

Parameters

Returns

Throws

getObjectName

Description

Syntax

Parameters

Returns

Throws

getStatus

Description

Syntax

Parameters

Returns

Throws

setObjectName

Description

Syntax

Parameters

Returns

Throws

setStatus

Description

Syntax

Parameters

Returns

Throws

SearchObjectNameResult

Definition

Methods

getEUID

Description

Syntax

Parameters

Returns

Throws

getComparisonScore

Description

Syntax

Parameters

Returns

Throws

getObjectName

Description

Syntax

Parameters

Returns

Throws

setEUID

Description

Syntax

Parameters

Returns

Throws

setComparisonScore

Description

Syntax

Parameters

Returns

Throws

setObjectName

Description

Syntax

Parameters

Returns

Throws

SourceEO

Definition

Methods

getEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

SetEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

SystemObjectNamePK

Definition

Methods

SystemObjectNamePK

Description

Syntax

Parameters

Returns

Throws

getLocalId

Description

Syntax

Parameters

Returns

Throws

getSystemCode

Description

Syntax

Parameters

Returns

Throws

Inbound Message Processing with Custom Logic

A.  Match Types and Field Names

Java Class Types

Oracle Java CAPS Master Index provides a set of static API classes that can be used with any object structure and any Oracle Java CAPS master index application. Oracle Java CAPS Master Index also generates several dynamic API classes that are specific to the object structure of each master index application. The dynamic classes contain similar methods, but the number and names of methods change depending on the object structure.

Static Classes

Static classes provide the methods you need to perform basic data cleansing and processing functions against incoming data, such as performing searches, reviewing potential duplicates, adding and updating records, and merging and unmerging records. The primary class containing these functions is the MasterController class, which includes the executeMatch methods. Several classes support the MasterController class by defining additional objects and functions. Documentation for the static methods is provided in Javadoc format.

Dynamic Web Services Classes

When you generate a master index Project, several dynamic methods are created in the Master Index EJB project that are specific to the object structure defined for the master index application. This includes classes that define each parent and child object in the object structure and that allow you to work with the data in each object. If the object structure is modified, regenerating the Project updates the dynamic methods for the new structure.

The EJB class that defines the primary web service methods is named after the parent object, and defines the main methods you use to transform and manipulate data between external systems and the master index database. There are also several helper classes that define the objects that are used as parameters and results for the primary web services, and that define the objects involved in Master Index processing.

The dynamic web services classes are located in the Master Index EJB project in the com.sun.mdm.index.webservice package under Source Packages. You can view the primary EJB class under Web Services in the EJB project. Additional supporting API classes are generated in the remaining Java packages under Source Packages.