Common code type framework
The common code type framework provides consistent and easy use of code table functions.
The InfoSphere® MDM common code type framework includes two different sets of APIs:
- admin code type service APIs are designed to provide administrators with the ability to store code table data directly to database and to inquire code table data directly from database.
- operational code type service APIs, provide the operational service consumers the ability to inquire code table data, which uses the data caching mechanism.
Code types are divided into three different categories based on
how they are used in InfoSphere MDM:
- Category 1 (C1): Represents the restricted design-time
code types. InfoSphere MDM design and runtime are based on the existence of a pre-populated
and fixed set of records on these code types. Category 1 code types
are considered fixed system code types. Some examples of these code
types are:
CdAcessorKey
,CdAccessorTp
,CdAttributeTp
, andCdErrTypeTp
. - Category 2 (C2): Represents the general design-time code
types. The default InfoSphere MDM setup is based on the existence of a pre-populated set of records
on these code types. Category 2 code types are considered non-fixed
system code types. You can add your own code types which will be used
by your software components. Some examples of these code types are:
CdOperatorTp
,CdBusinessTxTp
, andCdSuspectTp
. - Category 3 (C3): Represents the domain operational code
types. You can modify these code types at your discretion. There is
no hard coded logic in InfoSphere MDM that relies on a specific record in these code types. Some
examples of these code types are:
CdHierarchyTp
,CdHoldingTp
,CdRelTp
, andCdContractRelTp
.
These two set of code type service APIs share some common characteristics,
and they also have some differences.
Characteristics that are common to both code type service APIs: | Characteristics that differ for both code type service APIs: |
---|---|
|
|
The following are admin code type service APIs; refer to the transaction
reference documentation for details on using them:
- addAdminCodeType
- updateAdminCodeType
- getAdminCodeType
- getAllAdminCodeTypes
- getAllAdminCodeTypesByLangId
- getAllAdminCodeTypesByLocale
- getCodeTypeMetadata
- getAllCodeTypeMetadata
- getOperationalCodeType
- getAllOperationalCodeTypes
- getAllOperationalCodeTypesByLangId
- getAllOperationalCodeTypesByLocale
- reloadAllOperationalCodeTypes
- isCodeValid
- getCodeTypeByCode
- getCodeTypeByValue
- isCodeValuePairValid