Skip navigation links


Thor.API.Operations
Interface tcFormDefinitionOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf

public interface tcFormDefinitionOperationsIntf
extends tcUtilityOperationsIntf

Method Summary
 Thor.API.tcResultSet activateFormVersion(long plFormKey, int pnFormVersion)
          Sets the specified version of the specified form as the active version of that form.
 void addAdministrator(long plFormKey, long plGroupKey, boolean pbWrite, boolean pbDelete)
          Adds a group as having administrative control over a form
 void addFormDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceName, java.lang.String targetName)
          Adds a new data flow mapping
 long addFormField(long plFormKey, int pnFormVersion, java.lang.String psFieldName, java.lang.String psFieldType, java.lang.String psVariantType, int pnFieldLength, int pnOrder, java.lang.String psDefaultValue, java.lang.String pbProfileEnabled, boolean pbSecure)
          Updates information about the specified field of a form.
 void addFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName, java.lang.String psPropertyValue)
          Adds the specified property with specified value to the form's field
 void addReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, java.lang.String targetName, boolean isKeyField)
          Adds a new reconciliation data flow mapping
 void addReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, java.lang.String targetName, boolean isKeyField, boolean isCaseInsensitive)
          Adds a new reconciliation data flow mapping
 void assignToObject(long plFormKey, long plObjectKey)
          Assign the specified form to an object.
 void createForm(java.util.Map phAttributeList)
          Create a new form.
 void createNewVersion(long plFormKey, int pnFormVersion, java.lang.String psVersionLabel)
          Creates a new version of the specified form (in the form of a tcResultSet).
 void deleteFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName)
          Deletes the specified property from the specified form's field
 void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, boolean isKeyField)
          Edits an existing reconciliation data flow mapping to change the key field mapping information
 void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, boolean isKeyField, boolean iskeyCaseInsensitiveField)
          Edits an existing reconciliation data flow mapping to change the key field mapping information
 void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, int isKeyField, int iskeyCaseInsensitiveField)
          Edits an existing reconciliation data flow mapping to change the key field mapping information
 Thor.API.tcResultSet findForms(java.util.Map phAttributes)
          Returns a list of forms (in the form of a tcResultSet) that match the provided attribute list, and are object forms.
 Thor.API.tcResultSet findFormVersion(long plFormKey, java.lang.String psLabel)
          Returns version information about the specified form (in the form of a tcResultSet).
 Thor.API.tcResultSet getAdministrators(long plFormKey)
          Returns administration information about the specified form (in the form of a tcResultSet).
 Thor.API.tcResultSet getDataFlow(long plObjectKey)
          Returns data flow information about the specified object (in the form of a tcResultSet).
 Thor.API.tcResultSet getDataFlowForProcess(long plProcessKey)
          Returns data flow information about the specified process (in the form of a tcResultSet).
 Thor.API.tcResultSet getFormFieldLookupValues(long plFormFieldKey)
          Returns a list of lookup values (in the form of a tcResultSet) t
 java.lang.String getFormFieldPropertyValue(long plFormFieldKey, java.lang.String psPropertyName)
          Gets the value of the specified property of the specified form's field
 Thor.API.tcResultSet getFormFields(long plFormKey, int plVersion)
          Returns information about the user-defined and system fields of a specified form (in the form of a tcResultSet).
 Thor.API.tcResultSet getFormFieldsAttestation(long plFormKey, long plFormUDFKey)
          Returns information about the user-defined and system fields of a specified form (in the form of a tcResultSet).
 java.lang.String[] getFormFieldTypes()
          Returns a list of form field types defined in the Xellerate system.
 Thor.API.tcResultSet getFormVersions(long plFormKey)
          Returns version information about the specified form (in the form of a tcResultSet).
 java.lang.String getITResourceServerType(long plFormFieldKey)
          Returns the ITResourceServerType from the specified form's field
 java.lang.String getLookupPropertyType(long plFormFieldKey)
          Returns the property type of the specified form field.
 Thor.API.tcResultSet getObjects(long plFormKey)
          Gets a list of all the objects that use this form.
 Thor.API.tcResultSet getReconDataFlowForProcess(long plProcessKey)
          Returns reconciliation data flow information about the specified process (in the form of a tcResultSet).
 java.lang.String getUDFLabelForCode(java.lang.String metaDataCode)
          Returns the label defined for the UDF field.
 void removeAdministrator(long plFormKey, long plGroupKey)
          Removes a group from having administrative control over a form.
 void removeFormDataFlowMapping(long plProcessKey, java.lang.String sourceName, java.lang.String targetName)
          Remove an existing data flow mapping
 void removeFormField(long plFormFieldKey)
          Removes the specified field of a form.
 void removeFromObject(long plFormKey, long plObjectKey)
          Removes the specified form from an object.
 void removeReconDataFlowMapping(long plProcessKey, long plObjectKey, java.lang.String sourceKey)
          Remove an existing reconciliation data flow mapping
 void setFormFieldLookupValues(long plFormFieldKey, java.lang.String[] pasLookupValues)
          Sets the list of lookup values associated with a field that has a lookup attached to it.
 void updateAdministrator(long plFormKey, long plGroupKey, boolean pbWrite, boolean pbDelete)
          Updates the access an administrative group has over a form definition.
 void updateFormField(long plFormFieldKey, java.util.Map phAttributes)
          Updates information about the specified field of a form.
 void updateFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName, java.lang.String psPropertyValue)
          Updates the specified property with specified value to the form's field

 

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant

 

Method Detail

activateFormVersion

Thor.API.tcResultSet activateFormVersion(long plFormKey,
                                         int pnFormVersion)
                                         throws tcAPIException,
                                                tcFormNotFoundException,
                                                tcVersionNotDefinedException,
                                                tcAPIException
Sets the specified version of the specified form as the active version of that form.
Parameters:
plFormKey - The key for the form definition
pnFormVersion - The version to make active
Returns:
a tcResultSet that match the provided attribute list.
Throws:
tcAPIException
tcFormNotFoundException
tcVersionNotDefinedException

addAdministrator

void addAdministrator(long plFormKey,
                      long plGroupKey,
                      boolean pbWrite,
                      boolean pbDelete)
                      throws tcAPIException,
                             tcFormNotFoundException,
                             tcGroupNotFoundException,
                             tcAPIException
Adds a group as having administrative control over a form
Parameters:
plFormKey - The key for the form definition
plGroupKey - The key for the group
pbWrite - Whether the group has write access to the form definition
pbDelete - Whether the group has delete access to the form definition
Throws:
tcAPIException
tcFormNotFoundException
tcGroupNotFoundException

addFormField

long addFormField(long plFormKey,
                  int pnFormVersion,
                  java.lang.String psFieldName,
                  java.lang.String psFieldType,
                  java.lang.String psVariantType,
                  int pnFieldLength,
                  int pnOrder,
                  java.lang.String psDefaultValue,
                  java.lang.String pbProfileEnabled,
                  boolean pbSecure)
                  throws tcAPIException,
                         tcFormNotFoundException,
                         tcInvalidAttributeException,
                         tcAddFieldFailedException,
                         tcAPIException
Updates information about the specified field of a form.
Parameters:
plFormKey - The key for the form definition
pnFormVersion - Denotes whether field would be a required field for the form.
psFieldName - The name of the field, used as the label and also to make the column in the database
psFieldType - The type of the field, which should be one of the values defined by the field type lookup
psVariantType -
pnFieldLength - The maximum length of what can be saved in this field
pnOrder - The order of the field on the form
psDefaultValue - The system level default value for the field
pbProfileEnabled - Denotes whether the field is profile-enabled or not
pbSecure - Denotes whether the field is a senstive field to be stored encrypted in the database.
Returns:
The key of the form field definition
Throws:
tcAPIException
tcFormNotFoundException
tcInvalidAttributeException
tcAddFieldFailedException

assignToObject

void assignToObject(long plFormKey,
                    long plObjectKey)
                    throws tcAPIException,
                           tcFormNotFoundException,
                           tcObjectNotFoundException,
                           tcProcessFormException,
                           tcObjectFormAssignedException,
                           tcAPIException
Assign the specified form to an object. This is only valid for assigning object forms to objects.
Parameters:
plFormKey - The key for the form definition
plObjectKey - The key for the object to assign the form to
Throws:
tcAPIException
tcFormNotFoundException
tcObjectNotFoundException
tcProcessFormException
tcObjectFormAssignedException

createForm

void createForm(java.util.Map phAttributeList)
                throws tcAPIException,
                       tcInvalidNameException,
                       tcAPIException
Create a new form.
Parameters:
phAttributeList - The descriptive name of the form
Throws:
tcAPIException
tcInvalidNameException

createNewVersion

void createNewVersion(long plFormKey,
                      int pnFormVersion,
                      java.lang.String psVersionLabel)
                      throws tcAPIException,
                             tcFormNotFoundException,
                             tcVersionNotDefinedException,
                             tcAPIException
Creates a new version of the specified form (in the form of a tcResultSet).
Parameters:
plFormKey - The key for the form definition
pnFormVersion - The version to base the new version on
psVersionLabel - The label of new version to be defined
Throws:
tcAPIException
tcFormNotFoundException
tcVersionNotDefinedException

findForms

Thor.API.tcResultSet findForms(java.util.Map phAttributes)
                               throws tcAPIException,
                                      tcAPIException
Returns a list of forms (in the form of a tcResultSet) that match the provided attribute list, and are object forms. It returns both type of Object and Process forms.
Parameters:
phAttributes - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%). For example: parameter phAttributes can take the value of variable mhMap where HashMap mhMap = new HashMap(); and we can supply a value to mhMap as: mhMap.put("Structure Utility.Table Name", "UD_%");
Returns:
A tcResultSet containing multiple rows, each holding information about the forms
Throws:
tcAPIException

getAdministrators

Thor.API.tcResultSet getAdministrators(long plFormKey)
                                       throws tcAPIException,
                                              tcFormNotFoundException,
                                              tcAPIException
Returns administration information about the specified form (in the form of a tcResultSet).
Parameters:
plFormKey - The key for the form definition
Returns:
A tcResultSet containing multiple rows, each holding information about the groups that have access to adminster the form
Throws:
tcAPIException
tcFormNotFoundException

getFormFieldLookupValues

Thor.API.tcResultSet getFormFieldLookupValues(long plFormFieldKey)
                                              throws tcAPIException,
                                                     tcFormFieldNotFoundException,
                                                     tcNotLookupFieldException,
                                                     tcAPIException
Returns a list of lookup values (in the form of a tcResultSet) t
Parameters:
plFormFieldKey - The Key of the form field
Returns:
tcResultSet in which each row holds details about the lookup values
Throws:
tcAPIException
tcFormFieldNotFoundException
tcNotLookupFieldException

getLookupPropertyType

java.lang.String getLookupPropertyType(long plFormFieldKey)
                                       throws tcFormFieldNotFoundException,
                                              tcNotLookupFieldException,
                                              tcAPIException,
                                              tcAPIException
Returns the property type of the specified form field.
Parameters:
plFormFieldKey - The Key of the form field. Note that this field must be of type LookupField or ComboBox.
Returns:
The property type associated with the specified form field. One of the following two types will be returned:
  • Lookup Code
  • Lookup Query
Throws:
tcFormFieldNotFoundException
tcNotLookupFieldException
tcAPIException

getFormFieldsAttestation

Thor.API.tcResultSet getFormFieldsAttestation(long plFormKey,
                                              long plFormUDFKey)
                                              throws tcAPIException,
                                                     tcFormNotFoundException,
                                                     tcAPIException
Returns information about the user-defined and system fields of a specified form (in the form of a tcResultSet). Each record in the result set holds information about one field of the form. LookupCode column in resultset has lookup code value property set against form field if at all it is defined.
Parameters:
plFormKey - The key for the form definition
plFormUDFKey - The key for the form's user-defined fields
Returns:
A tcResultSet containing multiple rows, each holding information about a field of the form
Throws:
tcAPIException
tcFormNotFoundException
Since:
9.1.0.0

getFormFields

Thor.API.tcResultSet getFormFields(long plFormKey,
                                   int plVersion)
                                   throws tcAPIException,
                                          tcFormNotFoundException,
                                          tcAPIException
Returns information about the user-defined and system fields of a specified form (in the form of a tcResultSet). Each record in the result set holds information about one field of the form. LookupCode column in resultset has lookup code value property set against form field if at all it is defined.
Parameters:
plFormKey - The key for the form definition
plVersion - The version for the form definition
Returns:
A tcResultSet containing multiple rows, each holding information about a field of the form
Throws:
tcAPIException
tcFormNotFoundException

getFormFieldTypes

java.lang.String[] getFormFieldTypes()
                                     throws tcAPIException,
                                            tcAPIException
Returns a list of form field types defined in the Xellerate system.
Returns:
An array of strings, each string a valid field type.
Throws:
tcAPIException

getFormVersions

Thor.API.tcResultSet getFormVersions(long plFormKey)
                                     throws tcAPIException,
                                            tcFormNotFoundException,
                                            tcAPIException
Returns version information about the specified form (in the form of a tcResultSet).
Parameters:
plFormKey - The key for the form definition
Returns:
A tcResultSet containing multiple rows, each holding information about a version of the form (version number, status)
Throws:
tcAPIException
tcFormNotFoundException

getObjects

Thor.API.tcResultSet getObjects(long plFormKey)
                                throws tcAPIException,
                                       tcFormNotFoundException,
                                       tcProcessFormException,
                                       tcAPIException
Gets a list of all the objects that use this form.
Parameters:
plFormKey - Value holding the Form Key (corresponds to value in the SDK_KEY column)
Returns:
A tcResultSet, each row holding information about an object that uses this form.
Throws:
tcAPIException
tcFormNotFoundException
tcProcessFormException

removeAdministrator

void removeAdministrator(long plFormKey,
                         long plGroupKey)
                         throws tcAdminNotFoundException,
                                tcAPIException,
                                tcFormNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException
Removes a group from having administrative control over a form.
Parameters:
plFormKey - The key for the form definition
plGroupKey - The key for the group
Throws:
tcAdminNotFoundException
tcAPIException
tcFormNotFoundException
tcGroupNotFoundException

removeFormField

void removeFormField(long plFormFieldKey)
                     throws tcAPIException,
                            tcFormFieldNotFoundException,
                            tcDeleteNotAllowedException,
                            tcAPIException
Removes the specified field of a form.
Parameters:
plFormFieldKey - The key for the form field definition
Throws:
tcAPIException
tcFormFieldNotFoundException
tcDeleteNotAllowedException

setFormFieldLookupValues

void setFormFieldLookupValues(long plFormFieldKey,
                              java.lang.String[] pasLookupValues)
                              throws tcAPIException,
                                     tcFormFieldNotFoundException,
                                     tcNotLookupFieldException,
                                     tcAPIException
Sets the list of lookup values associated with a field that has a lookup attached to it. This would be the whole set, so internally, Xellerate would compare this list to what is already there, and add or remove from the list as required.
Parameters:
plFormFieldKey - The key for the form field definition
pasLookupValues - An array of strings where each string is an element in the lookup.
Throws:
tcAPIException
tcFormFieldNotFoundException
tcNotLookupFieldException

updateAdministrator

void updateAdministrator(long plFormKey,
                         long plGroupKey,
                         boolean pbWrite,
                         boolean pbDelete)
                         throws tcAdminNotFoundException,
                                tcAPIException,
                                tcFormNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException
Updates the access an administrative group has over a form definition.
Parameters:
plFormKey - The key for the form definition
plGroupKey - The key for the group
pbWrite - Whether the group has write access to the form definition
pbDelete - Whether the group has delete access to the form definition
Throws:
tcAdminNotFoundException
tcAPIException
tcFormNotFoundException
tcGroupNotFoundException

updateFormField

void updateFormField(long plFormFieldKey,
                     java.util.Map phAttributes)
                     throws tcAPIException,
                            tcFormFieldNotFoundException,
                            tcInvalidAttributeException,
                            tcUpdateNotAllowedException,
                            tcAPIException
Updates information about the specified field of a form.
Parameters:
plFormFieldKey - The key for the form field definition
phAttributes - The list of attributes that need to be updated alongwith the updated value
Throws:
tcAPIException
tcFormFieldNotFoundException
tcInvalidAttributeException
tcUpdateNotAllowedException

removeFromObject

void removeFromObject(long plFormKey,
                      long plObjectKey)
                      throws tcAPIException,
                             tcFormNotFoundException,
                             tcObjectNotFoundException,
                             tcProcessFormException,
                             tcObjectFormNotAssignedException,
                             tcAPIException
Removes the specified form from an object. This is only valid for object forms.
Parameters:
plFormKey - The key for the form definition
plObjectKey - The key for the object to assign the form to
Throws:
tcAPIException
tcFormNotFoundException
tcObjectNotFoundException
tcProcessFormException
tcObjectFormNotAssignedException

addFormFieldProperty

void addFormFieldProperty(long plFormFieldKey,
                          java.lang.String psPropertyName,
                          java.lang.String psPropertyValue)
                          throws tcAPIException,
                                 tcFormFieldNotFoundException,
                                 tcPropertyNotFoundException,
                                 tcInvalidAttributeException,
                                 tcPropertyAlreadyAssignedException,
                                 tcAddFormFieldPropertyFailedException,
                                 tcAPIException
Adds the specified property with specified value to the form's field
Parameters:
plFormFieldKey - The key for the form definition
psPropertyName - The name of the property to be assigned to the form field
psPropertyValue - The value of the property to be assigned to the form field
Throws:
tcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcInvalidAttributeException
tcPropertyAlreadyAssignedException
tcAddFormFieldPropertyFailedException

deleteFormFieldProperty

void deleteFormFieldProperty(long plFormFieldKey,
                             java.lang.String psPropertyName)
                             throws tcAPIException,
                                    tcFormFieldNotFoundException,
                                    tcPropertyNotFoundException,
                                    tcPropertyNotAssignedException,
                                    tcDeleteNotAllowedException,
                                    tcAPIException
Deletes the specified property from the specified form's field
Parameters:
plFormFieldKey - The key for the form definition
psPropertyName - The name of the property to be assigned to the form field
Throws:
tcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcPropertyNotAssignedException
tcDeleteNotAllowedException

updateFormFieldProperty

void updateFormFieldProperty(long plFormFieldKey,
                             java.lang.String psPropertyName,
                             java.lang.String psPropertyValue)
                             throws tcAPIException,
                                    tcFormFieldNotFoundException,
                                    tcPropertyNotFoundException,
                                    tcPropertyNotAssignedException,
                                    tcInvalidAttributeException,
                                    tcUpdateNotAllowedException,
                                    tcAPIException
Updates the specified property with specified value to the form's field
Parameters:
plFormFieldKey - The key for the form definition
psPropertyName - The name of the property to be assigned to the form field
psPropertyValue - The value of the property to be assigned to the form field
Throws:
tcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcPropertyNotAssignedException
tcInvalidAttributeException
tcUpdateNotAllowedException

getFormFieldPropertyValue

java.lang.String getFormFieldPropertyValue(long plFormFieldKey,
                                           java.lang.String psPropertyName)
                                           throws tcAPIException,
                                                  tcFormFieldNotFoundException,
                                                  tcPropertyNotFoundException,
                                                  tcAPIException
Gets the value of the specified property of the specified form's field
Parameters:
plFormFieldKey - The key for the form definition
psPropertyName - The name of the property whose value is to be retrieved
Returns:
Value of the specified property. If the specified property name is Required or Visible Field and they do not have values, a default value will be returned. The default values are:
  • true for Visible Field property
  • false for Required property
Throws:
tcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException

findFormVersion

Thor.API.tcResultSet findFormVersion(long plFormKey,
                                     java.lang.String psLabel)
                                     throws tcAPIException,
                                            tcFormNotFoundException,
                                            tcInvalidAttributeException,
                                            tcAPIException
Returns version information about the specified form (in the form of a tcResultSet).
Parameters:
plFormKey - The key for the form definition
psLabel - The label of the form version
Returns:
A tcResultSet containing row holding information about a version of the form
Throws:
tcAPIException
tcFormNotFoundException
tcInvalidAttributeException

getITResourceServerType

java.lang.String getITResourceServerType(long plFormFieldKey)
                                         throws tcAPIException,
                                                tcPropertyNotFoundException,
                                                tcAPIException
Returns the ITResourceServerType from the specified form's field
Parameters:
plFormFieldKey - The key for the form definition
Throws:
tcAPIException
tcPropertyNotFoundException

getDataFlow

Thor.API.tcResultSet getDataFlow(long plObjectKey)
                                 throws tcAPIException,
                                        tcObjectNotFoundException,
                                        tcAPIException
Returns data flow information about the specified object (in the form of a tcResultSet).
Parameters:
plObjectKey - The key for the Object
Returns:
A tcResultSet containing multiple rows, each holding information about the data flow defined
Throws:
tcAPIException
tcObjectNotFoundException

getDataFlowForProcess

Thor.API.tcResultSet getDataFlowForProcess(long plProcessKey)
                                           throws tcAPIException,
                                                  tcProcessNotFoundException,
                                                  tcAPIException
Returns data flow information about the specified process (in the form of a tcResultSet).
Parameters:
plProcessKey - The key for the Object
Returns:
A tcResultSet containing multiple rows, each holding information about the data flow defined
Throws:
tcAPIException
tcProcessNotFoundException
Since:
9.1.0.0

addFormDataFlow

void addFormDataFlow(long plProcessKey,
                     long plObjectKey,
                     java.lang.String sourceName,
                     java.lang.String targetName)
                     throws tcAPIException,
                            tcProcessNotFoundException,
                            tcObjectNotFoundException,
                            tcAPIException
Adds a new data flow mapping
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceFieldName - The source Field/Table name
targetFieldName - The target Field/Table name
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

removeFormDataFlowMapping

void removeFormDataFlowMapping(long plProcessKey,
                               java.lang.String sourceName,
                               java.lang.String targetName)
                               throws tcAPIException,
                                      tcProcessNotFoundException,
                                      tcAPIException
Remove an existing data flow mapping
Parameters:
plProcessKey - The process key
sourceFieldName - The source Field/Table name
targetFieldName - The target Field/Table name
Throws:
tcAPIException
tcProcessNotFoundException
Since:
9.1.0.0

getReconDataFlowForProcess

Thor.API.tcResultSet getReconDataFlowForProcess(long plProcessKey)
                                                throws tcAPIException,
                                                       tcProcessNotFoundException,
                                                       tcAPIException
Returns reconciliation data flow information about the specified process (in the form of a tcResultSet).
Parameters:
plProcessKey - The key for the Object
Returns:
A tcResultSet containing multiple rows, each holding information about the reconciliation data flow defined
Throws:
tcAPIException
tcProcessNotFoundException
Since:
9.1.0.0

addReconDataFlow

void addReconDataFlow(long plProcessKey,
                      long plObjectKey,
                      java.lang.String sourceKey,
                      java.lang.String targetName,
                      boolean isKeyField)
                      throws tcAPIException,
                             tcProcessNotFoundException,
                             tcObjectNotFoundException,
                             tcAPIException
Adds a new reconciliation data flow mapping
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceName - The source Reconciliation field key (orf_key)
targetName - The target Field/Table name
isKeyField - The boolean represnting whether key field or not
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

addReconDataFlow

void addReconDataFlow(long plProcessKey,
                      long plObjectKey,
                      java.lang.String sourceKey,
                      java.lang.String targetName,
                      boolean isKeyField,
                      boolean isCaseInsensitive)
                      throws tcAPIException,
                             tcProcessNotFoundException,
                             tcObjectNotFoundException,
                             tcAPIException
Adds a new reconciliation data flow mapping
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceName - The source Reconciliation field key (orf_key)
targetName - The target Field/Table name
isKeyField - The boolean represnting whether key field or not
isCaseInsensitive - The boolean represnting whether key field case insensitive or not
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

editReconDataFlow

void editReconDataFlow(long plProcessKey,
                       long plObjectKey,
                       java.lang.String sourceKey,
                       boolean isKeyField)
                       throws tcAPIException,
                              tcProcessNotFoundException,
                              tcObjectNotFoundException,
                              tcAPIException
Edits an existing reconciliation data flow mapping to change the key field mapping information
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceKey - The source Reconciliation field key (orf_key)
isKeyField - The boolean representing whether key field or not
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

editReconDataFlow

void editReconDataFlow(long plProcessKey,
                       long plObjectKey,
                       java.lang.String sourceKey,
                       boolean isKeyField,
                       boolean iskeyCaseInsensitiveField)
                       throws tcAPIException,
                              tcProcessNotFoundException,
                              tcObjectNotFoundException,
                              tcAPIException
Edits an existing reconciliation data flow mapping to change the key field mapping information
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceKey - The source Reconciliation field key (orf_key)
isKeyField - The boolean representing whether key field or not
iskeyCaseInsensitiveField - The boolean representing whether key is case insensitive or not
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

editReconDataFlow

void editReconDataFlow(long plProcessKey,
                       long plObjectKey,
                       java.lang.String sourceKey,
                       int isKeyField,
                       int iskeyCaseInsensitiveField)
                       throws tcAPIException,
                              tcProcessNotFoundException,
                              tcObjectNotFoundException,
                              tcAPIException
Edits an existing reconciliation data flow mapping to change the key field mapping information
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceKey - The source Reconciliation field key (orf_key)
isKeyField - The int representing whether key field or not. The "1" stands for: the field is the key field. The "0" stands for: the field is not the key field. Any other value will not modify the value in the database.
iskeyCaseInsensitiveField - The int representing whether key is case insensitive or not. The "1" stands for: the field is the case insensitve key field. The "0" stands for: the field is the case sensitive key field which is the default behavior. Any other value will not modify the value in the database.
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

removeReconDataFlowMapping

void removeReconDataFlowMapping(long plProcessKey,
                                long plObjectKey,
                                java.lang.String sourceKey)
                                throws tcAPIException,
                                       tcProcessNotFoundException,
                                       tcObjectNotFoundException,
                                       tcAPIException
Remove an existing reconciliation data flow mapping
Parameters:
plProcessKey - The process key
plObjectKey - The object key
sourceKey - The source reconciliation field key (orf_key)
Throws:
tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
Since:
9.1.0.0

getUDFLabelForCode

java.lang.String getUDFLabelForCode(java.lang.String metaDataCode)
                                    throws tcAPIException,
                                           tcAPIException
Returns the label defined for the UDF field. It takes an input as the meta data column code defined for the field
Parameters:
metaDataCode - Lookup MetaData Code
Returns:
String Column label for the field
Throws:
tcAPIException
Since:
9.1.0.0

Skip navigation links


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.