tcFormDefinitionOperationsIntf (Thor.API.Operations Javadoc)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Thor.API.Operations
Interface tcFormDefinitionOperationsIntf

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
`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`	`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
`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`	`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).
`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.
`void`	`removeAdministrator(long plFormKey, long plGroupKey)` Removes a group from having administrative control over a form.
`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`	`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

Method Detail

activateFormVersion

public Thor.API.tcResultSet activateFormVersion(long plFormKey,
                                                int pnFormVersion)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                Thor.API.Exceptions.tcFormNotFoundException,
                                                Thor.API.Exceptions.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

public void addAdministrator(long plFormKey,
                             long plGroupKey,
                             boolean pbWrite,
                             boolean pbDelete)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcFormNotFoundException,
                             Thor.API.Exceptions.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

public 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 Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcFormNotFoundException,
                         Thor.API.Exceptions.tcInvalidAttributeException,
                         Thor.API.Exceptions.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

public void assignToObject(long plFormKey,
                           long plObjectKey)
                    throws Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcFormNotFoundException,
                           Thor.API.Exceptions.tcObjectNotFoundException,
                           Thor.API.Exceptions.tcProcessFormException,
                           Thor.API.Exceptions.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

public void createForm(java.util.Map phAttributeList)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcInvalidNameException,
                       tcAPIException

Create a new form.

Parameters:: phAttributeList - The descriptive name of the form
Throws:: tcAPIException; tcInvalidNameException

createNewVersion

public void createNewVersion(long plFormKey,
                             int pnFormVersion,
                             java.lang.String psVersionLabel)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcFormNotFoundException,
                             Thor.API.Exceptions.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

public Thor.API.tcResultSet findForms(java.util.Map phAttributes)
                               throws Thor.API.Exceptions.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

public Thor.API.tcResultSet getAdministrators(long plFormKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.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

public Thor.API.tcResultSet getFormFieldLookupValues(long plFormFieldKey)
                                              throws Thor.API.Exceptions.tcAPIException,
                                                     Thor.API.Exceptions.tcFormFieldNotFoundException,
                                                     Thor.API.Exceptions.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

public java.lang.String getLookupPropertyType(long plFormFieldKey)
                                       throws Thor.API.Exceptions.tcFormFieldNotFoundException,
                                              Thor.API.Exceptions.tcNotLookupFieldException,
                                              Thor.API.Exceptions.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

getFormFields

public Thor.API.tcResultSet getFormFields(long plFormKey,
                                          int plVersion)
                                   throws Thor.API.Exceptions.tcAPIException,
                                          Thor.API.Exceptions.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

public java.lang.String[] getFormFieldTypes()
                                     throws Thor.API.Exceptions.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

public Thor.API.tcResultSet getFormVersions(long plFormKey)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            Thor.API.Exceptions.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

public Thor.API.tcResultSet getObjects(long plFormKey)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcFormNotFoundException,
                                       Thor.API.Exceptions.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

public void removeAdministrator(long plFormKey,
                                long plGroupKey)
                         throws Thor.API.Exceptions.tcAdminNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcFormNotFoundException,
                                Thor.API.Exceptions.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

public void removeFormField(long plFormFieldKey)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcFormFieldNotFoundException,
                            Thor.API.Exceptions.tcDeleteNotAllowedException,
                            tcAPIException

Removes the specified field of a form.

Parameters:: plFormFieldKey - The key for the form field definition
Throws:: tcAPIException; tcFormFieldNotFoundException; tcDeleteNotAllowedException

setFormFieldLookupValues

public void setFormFieldLookupValues(long plFormFieldKey,
                                     java.lang.String[] pasLookupValues)
                              throws Thor.API.Exceptions.tcAPIException,
                                     Thor.API.Exceptions.tcFormFieldNotFoundException,
                                     Thor.API.Exceptions.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

public void updateAdministrator(long plFormKey,
                                long plGroupKey,
                                boolean pbWrite,
                                boolean pbDelete)
                         throws Thor.API.Exceptions.tcAdminNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcFormNotFoundException,
                                Thor.API.Exceptions.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

public void updateFormField(long plFormFieldKey,
                            java.util.Map phAttributes)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcFormFieldNotFoundException,
                            Thor.API.Exceptions.tcInvalidAttributeException,
                            Thor.API.Exceptions.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

public void removeFromObject(long plFormKey,
                             long plObjectKey)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcFormNotFoundException,
                             Thor.API.Exceptions.tcObjectNotFoundException,
                             Thor.API.Exceptions.tcProcessFormException,
                             Thor.API.Exceptions.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

public void addFormFieldProperty(long plFormFieldKey,
                                 java.lang.String psPropertyName,
                                 java.lang.String psPropertyValue)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcFormFieldNotFoundException,
                                 Thor.API.Exceptions.tcPropertyNotFoundException,
                                 Thor.API.Exceptions.tcInvalidAttributeException,
                                 Thor.API.Exceptions.tcPropertyAlreadyAssignedException,
                                 Thor.API.Exceptions.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

public void deleteFormFieldProperty(long plFormFieldKey,
                                    java.lang.String psPropertyName)
                             throws Thor.API.Exceptions.tcAPIException,
                                    Thor.API.Exceptions.tcFormFieldNotFoundException,
                                    Thor.API.Exceptions.tcPropertyNotFoundException,
                                    Thor.API.Exceptions.tcPropertyNotAssignedException,
                                    Thor.API.Exceptions.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

public void updateFormFieldProperty(long plFormFieldKey,
                                    java.lang.String psPropertyName,
                                    java.lang.String psPropertyValue)
                             throws Thor.API.Exceptions.tcAPIException,
                                    Thor.API.Exceptions.tcFormFieldNotFoundException,
                                    Thor.API.Exceptions.tcPropertyNotFoundException,
                                    Thor.API.Exceptions.tcPropertyNotAssignedException,
                                    Thor.API.Exceptions.tcInvalidAttributeException,
                                    Thor.API.Exceptions.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

public java.lang.String getFormFieldPropertyValue(long plFormFieldKey,
                                                  java.lang.String psPropertyName)
                                           throws Thor.API.Exceptions.tcAPIException,
                                                  Thor.API.Exceptions.tcFormFieldNotFoundException,
                                                  Thor.API.Exceptions.tcPropertyNotFoundException,
                                                  tcAPIException

Gets the value of the specified property of the specified form's field