|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcFormDefinitionOperationsIntf
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 |
---|
Thor.API.tcResultSet activateFormVersion(long plFormKey, int pnFormVersion) throws tcAPIException, tcFormNotFoundException, tcVersionNotDefinedException, tcAPIException
plFormKey
- The key for the form definitionpnFormVersion
- The version to make activetcAPIException
tcFormNotFoundException
tcVersionNotDefinedException
void addAdministrator(long plFormKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcFormNotFoundException, tcGroupNotFoundException, tcAPIException
plFormKey
- The key for the form definitionplGroupKey
- The key for the grouppbWrite
- Whether the group has write access to the form definitionpbDelete
- Whether the group has delete access to the form definitiontcAPIException
tcFormNotFoundException
tcGroupNotFoundException
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
plFormKey
- The key for the form definitionpnFormVersion
- 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 databasepsFieldType
- The type of the field, which should be one of the values defined by the field type lookuppsVariantType
-pnFieldLength
- The maximum length of what can be saved in this fieldpnOrder
- The order of the field on the formpsDefaultValue
- The system level default value for the fieldpbProfileEnabled
- Denotes whether the field is profile-enabled or notpbSecure
- Denotes whether the field is a senstive field to be stored encrypted in the database.tcAPIException
tcFormNotFoundException
tcInvalidAttributeException
tcAddFieldFailedException
void assignToObject(long plFormKey, long plObjectKey) throws tcAPIException, tcFormNotFoundException, tcObjectNotFoundException, tcProcessFormException, tcObjectFormAssignedException, tcAPIException
plFormKey
- The key for the form definitionplObjectKey
- The key for the object to assign the form totcAPIException
tcFormNotFoundException
tcObjectNotFoundException
tcProcessFormException
tcObjectFormAssignedException
void createForm(java.util.Map phAttributeList) throws tcAPIException, tcInvalidNameException, tcAPIException
phAttributeList
- The descriptive name of the formtcAPIException
tcInvalidNameException
void createNewVersion(long plFormKey, int pnFormVersion, java.lang.String psVersionLabel) throws tcAPIException, tcFormNotFoundException, tcVersionNotDefinedException, tcAPIException
plFormKey
- The key for the form definitionpnFormVersion
- The version to base the new version onpsVersionLabel
- The label of new version to be definedtcAPIException
tcFormNotFoundException
tcVersionNotDefinedException
Thor.API.tcResultSet findForms(java.util.Map phAttributes) throws tcAPIException, tcAPIException
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_%");tcAPIException
Thor.API.tcResultSet getAdministrators(long plFormKey) throws tcAPIException, tcFormNotFoundException, tcAPIException
plFormKey
- The key for the form definitiontcAPIException
tcFormNotFoundException
Thor.API.tcResultSet getFormFieldLookupValues(long plFormFieldKey) throws tcAPIException, tcFormFieldNotFoundException, tcNotLookupFieldException, tcAPIException
plFormFieldKey
- The Key of the form fieldtcAPIException
tcFormFieldNotFoundException
tcNotLookupFieldException
java.lang.String getLookupPropertyType(long plFormFieldKey) throws tcFormFieldNotFoundException, tcNotLookupFieldException, tcAPIException, tcAPIException
plFormFieldKey
- The Key of the form field. Note that this field must be of type LookupField or ComboBox.tcFormFieldNotFoundException
tcNotLookupFieldException
tcAPIException
Thor.API.tcResultSet getFormFieldsAttestation(long plFormKey, long plFormUDFKey) throws tcAPIException, tcFormNotFoundException, tcAPIException
plFormKey
- The key for the form definitionplFormUDFKey
- The key for the form's user-defined fieldstcAPIException
tcFormNotFoundException
Thor.API.tcResultSet getFormFields(long plFormKey, int plVersion) throws tcAPIException, tcFormNotFoundException, tcAPIException
plFormKey
- The key for the form definitionplVersion
- The version for the form definitiontcAPIException
tcFormNotFoundException
java.lang.String[] getFormFieldTypes() throws tcAPIException, tcAPIException
tcAPIException
Thor.API.tcResultSet getFormVersions(long plFormKey) throws tcAPIException, tcFormNotFoundException, tcAPIException
plFormKey
- The key for the form definitiontcAPIException
tcFormNotFoundException
Thor.API.tcResultSet getObjects(long plFormKey) throws tcAPIException, tcFormNotFoundException, tcProcessFormException, tcAPIException
plFormKey
- Value holding the Form Key (corresponds to value in the SDK_KEY
column)tcResultSet
, each row holding information about an object that uses this form.tcAPIException
tcFormNotFoundException
tcProcessFormException
void removeAdministrator(long plFormKey, long plGroupKey) throws tcAdminNotFoundException, tcAPIException, tcFormNotFoundException, tcGroupNotFoundException, tcAPIException
plFormKey
- The key for the form definitionplGroupKey
- The key for the grouptcAdminNotFoundException
tcAPIException
tcFormNotFoundException
tcGroupNotFoundException
void removeFormField(long plFormFieldKey) throws tcAPIException, tcFormFieldNotFoundException, tcDeleteNotAllowedException, tcAPIException
plFormFieldKey
- The key for the form field definitiontcAPIException
tcFormFieldNotFoundException
tcDeleteNotAllowedException
void setFormFieldLookupValues(long plFormFieldKey, java.lang.String[] pasLookupValues) throws tcAPIException, tcFormFieldNotFoundException, tcNotLookupFieldException, tcAPIException
plFormFieldKey
- The key for the form field definitionpasLookupValues
- An array of strings where each string is an element in the lookup.tcAPIException
tcFormFieldNotFoundException
tcNotLookupFieldException
void updateAdministrator(long plFormKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAdminNotFoundException, tcAPIException, tcFormNotFoundException, tcGroupNotFoundException, tcAPIException
plFormKey
- The key for the form definitionplGroupKey
- The key for the grouppbWrite
- Whether the group has write access to the form definitionpbDelete
- Whether the group has delete access to the form definitiontcAdminNotFoundException
tcAPIException
tcFormNotFoundException
tcGroupNotFoundException
void updateFormField(long plFormFieldKey, java.util.Map phAttributes) throws tcAPIException, tcFormFieldNotFoundException, tcInvalidAttributeException, tcUpdateNotAllowedException, tcAPIException
plFormFieldKey
- The key for the form field definitionphAttributes
- The list of attributes that need to be updated alongwith the updated valuetcAPIException
tcFormFieldNotFoundException
tcInvalidAttributeException
tcUpdateNotAllowedException
void removeFromObject(long plFormKey, long plObjectKey) throws tcAPIException, tcFormNotFoundException, tcObjectNotFoundException, tcProcessFormException, tcObjectFormNotAssignedException, tcAPIException
plFormKey
- The key for the form definitionplObjectKey
- The key for the object to assign the form totcAPIException
tcFormNotFoundException
tcObjectNotFoundException
tcProcessFormException
tcObjectFormNotAssignedException
void addFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName, java.lang.String psPropertyValue) throws tcAPIException, tcFormFieldNotFoundException, tcPropertyNotFoundException, tcInvalidAttributeException, tcPropertyAlreadyAssignedException, tcAddFormFieldPropertyFailedException, tcAPIException
plFormFieldKey
- The key for the form definitionpsPropertyName
- The name of the property to be assigned to the form fieldpsPropertyValue
- The value of the property to be assigned to the form fieldtcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcInvalidAttributeException
tcPropertyAlreadyAssignedException
tcAddFormFieldPropertyFailedException
void deleteFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName) throws tcAPIException, tcFormFieldNotFoundException, tcPropertyNotFoundException, tcPropertyNotAssignedException, tcDeleteNotAllowedException, tcAPIException
plFormFieldKey
- The key for the form definitionpsPropertyName
- The name of the property to be assigned to the form fieldtcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcPropertyNotAssignedException
tcDeleteNotAllowedException
void updateFormFieldProperty(long plFormFieldKey, java.lang.String psPropertyName, java.lang.String psPropertyValue) throws tcAPIException, tcFormFieldNotFoundException, tcPropertyNotFoundException, tcPropertyNotAssignedException, tcInvalidAttributeException, tcUpdateNotAllowedException, tcAPIException
plFormFieldKey
- The key for the form definitionpsPropertyName
- The name of the property to be assigned to the form fieldpsPropertyValue
- The value of the property to be assigned to the form fieldtcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
tcPropertyNotAssignedException
tcInvalidAttributeException
tcUpdateNotAllowedException
java.lang.String getFormFieldPropertyValue(long plFormFieldKey, java.lang.String psPropertyName) throws tcAPIException, tcFormFieldNotFoundException, tcPropertyNotFoundException, tcAPIException
plFormFieldKey
- The key for the form definitionpsPropertyName
- The name of the property whose value is to be retrievedtrue
for Visible Field propertyfalse
for Required propertytcAPIException
tcFormFieldNotFoundException
tcPropertyNotFoundException
Thor.API.tcResultSet findFormVersion(long plFormKey, java.lang.String psLabel) throws tcAPIException, tcFormNotFoundException, tcInvalidAttributeException, tcAPIException
plFormKey
- The key for the form definitionpsLabel
- The label of the form versiontcAPIException
tcFormNotFoundException
tcInvalidAttributeException
java.lang.String getITResourceServerType(long plFormFieldKey) throws tcAPIException, tcPropertyNotFoundException, tcAPIException
plFormFieldKey
- The key for the form definitiontcAPIException
tcPropertyNotFoundException
Thor.API.tcResultSet getDataFlow(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
plObjectKey
- The key for the ObjecttcAPIException
tcObjectNotFoundException
Thor.API.tcResultSet getDataFlowForProcess(long plProcessKey) throws tcAPIException, tcProcessNotFoundException, tcAPIException
plProcessKey
- The key for the ObjecttcAPIException
tcProcessNotFoundException
void addFormDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceName, java.lang.String targetName) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceFieldName
- The source Field/Table nametargetFieldName
- The target Field/Table nametcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void removeFormDataFlowMapping(long plProcessKey, java.lang.String sourceName, java.lang.String targetName) throws tcAPIException, tcProcessNotFoundException, tcAPIException
plProcessKey
- The process keysourceFieldName
- The source Field/Table nametargetFieldName
- The target Field/Table nametcAPIException
tcProcessNotFoundException
Thor.API.tcResultSet getReconDataFlowForProcess(long plProcessKey) throws tcAPIException, tcProcessNotFoundException, tcAPIException
plProcessKey
- The key for the ObjecttcAPIException
tcProcessNotFoundException
void addReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, java.lang.String targetName, boolean isKeyField) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceName
- The source Reconciliation field key (orf_key)targetName
- The target Field/Table nameisKeyField
- The boolean represnting whether key field or nottcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void addReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, java.lang.String targetName, boolean isKeyField, boolean isCaseInsensitive) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceName
- The source Reconciliation field key (orf_key)targetName
- The target Field/Table nameisKeyField
- The boolean represnting whether key field or notisCaseInsensitive
- The boolean represnting whether key field case insensitive or nottcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, boolean isKeyField) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceKey
- The source Reconciliation field key (orf_key)isKeyField
- The boolean representing whether key field or nottcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, boolean isKeyField, boolean iskeyCaseInsensitiveField) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceKey
- The source Reconciliation field key (orf_key)isKeyField
- The boolean representing whether key field or notiskeyCaseInsensitiveField
- The boolean representing whether key is case insensitive or nottcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void editReconDataFlow(long plProcessKey, long plObjectKey, java.lang.String sourceKey, int isKeyField, int iskeyCaseInsensitiveField) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceKey
- 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.tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
void removeReconDataFlowMapping(long plProcessKey, long plObjectKey, java.lang.String sourceKey) throws tcAPIException, tcProcessNotFoundException, tcObjectNotFoundException, tcAPIException
plProcessKey
- The process keyplObjectKey
- The object keysourceKey
- The source reconciliation field key (orf_key)tcAPIException
tcProcessNotFoundException
tcObjectNotFoundException
java.lang.String getUDFLabelForCode(java.lang.String metaDataCode) throws tcAPIException, tcAPIException
metaDataCode
- Lookup MetaData CodetcAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |