com.thortech.xl.util.adapters

Class tcUtilXellerateOperations

java.lang.Object

com.thortech.xl.util.adapters.tcUtilXellerateOperations

public class tcUtilXellerateOperations
extends java.lang.Object

This class that will perform Xellerate specific utility functions particularly for Rule generations.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	chckProcOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psActKey) Method that checks if a particular process has been successfully ordered for a user.
static java.lang.String	chckProcOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psUsrKey) Method that checks if a particular process has been successfully ordered for a user.
static java.lang.String	checkProcessOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psActKey) Method that checks if a particular process has been successfully ordered for an organization.
static java.lang.String	checkProcessOrderedForParentAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psActKey) Method that checks if a particular process has been successfully ordered for parent of an organization.
static java.lang.String	checkProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psUsrKey) Method that checks if a particular process has been successfully ordered for a user.
static boolean	checkValueUniqueness(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, com.thortech.xl.dataobj.tcDataObj poDataObj, java.lang.String psColumnName, java.lang.String psColumnValue) method that validates uniqueness of the value.
static boolean	checkValueUniquenessIgnoreCase(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, com.thortech.xl.dataobj.tcDataObj poDataObj, java.lang.String psColumnName, java.lang.String psColumnValue) method that validates uniqueness of the value(ignore case)
static java.lang.String	getDataFromOrc(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psOrcKey, java.lang.String psColumnName) Method that gets the value of a particular field from the process data for a specific orc ordered for the specified organization.
static java.lang.String	getDataFromProcessOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psActKey, java.lang.String psColumnName) Method that gets the value of a particular field from the process data for a specific process ordered for the specified organization.
static java.lang.String	getDataFromProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psUsrKey, java.lang.String psColumnName) Method that gets the value of a particular field from the process data for a specific process ordered for the specified user.
static java.util.Map	getDeletedProcessFormChildData(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, long childFormDefinitionKey, long processInstanceKey, long taskInstanceKey) Get the deleted child form entry details.
static java.lang.String	getITAssetKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psITAssetType, java.lang.String psITAssetName) Method that given an Asset Type and Asset Name, returns the Asset Instance Key
static java.util.Hashtable	getITAssetProperties(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psServerName) Method that given an Asset Name, returns the Asset Properties in a Hashtable
static java.lang.String	getObjKeyfromOrcKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psOrcKey) method that find the obj_key from the orc_key
static java.lang.String	getObjOrderForfromObjKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psObjKey) method that get obj_order_for column from the obj table by obj_key provided
static java.lang.String	getOstKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psObjKey, java.lang.String psOstStatus) method that get ost_key from the ost table by obj_key and ost_status provided
static boolean	isValueChanged(com.thortech.xl.dataobj.tcDataObj poDataObj, java.lang.String psColumName) method that validates that value has been changed in the database.
static java.lang.String	orderProcessForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psUsrKey) Method that orders a process for a user.
static void	printLine(java.lang.String psParmToPrint) This method prints out the parameter is is being passed in.
static java.lang.String	setDataForOrcProcess(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psOrcKey, java.lang.String psColumnName, java.lang.String psColumnValue) Method that sets the value of a particular field in the process data for a specific process instance (ORC).
static java.lang.String	setDataForProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psProcessName, java.lang.String psUsrKey, java.lang.String psColumnName, java.lang.String psColumnValue) Method that sets the value of a particular field in the process data for a specific process ordered for the specified user.
static boolean	setOstKeyforObject(com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psOrcKey, java.lang.String psObjOrderFor, java.lang.String psOstKey) method that set obj status in oio/oiu table
static void	updateITAssetProperty(com.thortech.xl.server.tcOrbServerObject poCreator, com.thortech.xl.dataaccess.tcDataProvider poDataProvider, java.lang.String psServerName, java.lang.String psPropName, java.lang.String psPropValue) Given an Asset Name, associated property name, and its value, the method will update this property with the value passed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isValueChanged

public static boolean isValueChanged(com.thortech.xl.dataobj.tcDataObj poDataObj,
                                     java.lang.String psColumName)
                              throws java.lang.Exception

method that validates that value has been changed in the database.

Parameters:

poDataObj - poDataObj for all data objects except tcScheduleItem.

psColumName - psColumName name of the column being compared.

Returns:

boolean flag that indicates whether value passed is identical to the one in database.

Throws:

java.lang.Exception

com.thortech.xl.dataobj.tcUnsupportedDataObjException

checkValueUniqueness

public static boolean checkValueUniqueness(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                           com.thortech.xl.dataobj.tcDataObj poDataObj,
                                           java.lang.String psColumnName,
                                           java.lang.String psColumnValue)
                                    throws java.lang.Exception

method that validates uniqueness of the value.

Parameters:

poDataProvider - poDataProvider data base connection.

poDataObj - poDataObj for all data objects except tcScheduleItem.

psColumnName - psColumName name of the column being checked.

psColumnValue - psColumnValue value of the column being checked.

Returns:

boolean flag that indicates whether value passed exists in the table.

Throws:

java.lang.Exception

com.thortech.xl.dataobj.tcUnsupportedDataObjException

checkValueUniquenessIgnoreCase

public static boolean checkValueUniquenessIgnoreCase(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                     com.thortech.xl.dataobj.tcDataObj poDataObj,
                                                     java.lang.String psColumnName,
                                                     java.lang.String psColumnValue)
                                              throws java.lang.Exception

method that validates uniqueness of the value(ignore case)

Parameters:

poDataProvider - poDataProvider data base connection.

poDataObj - poDataObj for all data objects except tcScheduleItem.

psColumnName - psColumName name of the column being checked.

psColumnValue - psColumnValue value of the column being checked.

Returns:

boolean flag that indicates whether value passed exists in the table.

Throws:

java.lang.Exception

com.thortech.xl.dataobj.tcUnsupportedDataObjException

getObjKeyfromOrcKey

public static java.lang.String getObjKeyfromOrcKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                   java.lang.String psOrcKey)
                                            throws java.lang.Exception

method that find the obj_key from the orc_key

Parameters:

poDataProvider - poDataProvider data base connection.

psOrcKey - psOrcKey orc_key for the process form

Returns:

the obj_key related to the orc_key

Throws:

java.lang.Exception

getObjOrderForfromObjKey

public static java.lang.String getObjOrderForfromObjKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                        java.lang.String psObjKey)
                                                 throws java.lang.Exception

method that get obj_order_for column from the obj table by obj_key provided

Parameters:

poDataProvider - poDataProvider data base connection.

psObjKey - psObjKey obj_key to check obj_order_for

Returns:

the obj_order_for related to the obj_key

Throws:

java.lang.Exception

getOstKey

public static java.lang.String getOstKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                         java.lang.String psObjKey,
                                         java.lang.String psOstStatus)
                                  throws java.lang.Exception

method that get ost_key from the ost table by obj_key and ost_status provided

Parameters:

poDataProvider - poDataProvider data base connection.

psObjKey - psObjKey

psOstStatus - psOstStatus

Returns:

the ost_key related to the obj_key and ost_status

Throws:

java.lang.Exception

setOstKeyforObject

public static boolean setOstKeyforObject(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                         java.lang.String psOrcKey,
                                         java.lang.String psObjOrderFor,
                                         java.lang.String psOstKey)
                                  throws java.lang.Exception

method that set obj status in oio/oiu table

Parameters:

poDataProvider - poDataProvider data base connection.

psOrcKey - psOrcKey orc_key

psObjOrderFor - psObjOrderFor (U/O)

psOstKey - psOstKey the new ost_key value for the oiu/oio record

Returns:

the obj_order_for related to the obj_key

Throws:

java.lang.Exception

printLine

public static void printLine(java.lang.String psParmToPrint)

This method prints out the parameter is is being passed in.

Parameters:

psParmToPrint - psParmToPrint value to print.

checkProcessOrderedForUser

public static java.lang.String checkProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                          java.lang.String psProcessName,
                                                          java.lang.String psUsrKey)
                                                   throws java.lang.Exception

Method that checks if a particular process has been successfully ordered for a user. Success is defined as the process being ordered, in completed status, and in enabled application status. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psUsrKey - psUsrKey Key of the user to check process for.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 is User Key given was blank or null
-20 is process not ordered for user or is cancelled

Throws:

java.lang.Exception

chckProcOrderedForUser

public static java.lang.String chckProcOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                      java.lang.String psProcessName,
                                                      java.lang.String psUsrKey)
                                               throws java.lang.Exception

Method that checks if a particular process has been successfully ordered for a user. Success is defined as the process being ordered, in completed status, and in enabled application status. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psUsrKey - psUsrKey Key of the user to check process for.

Returns:

String 1, if checkProcessOrderedForUser is positive
otherwise return error code that was defined from checkProcessOrderedForUser method:

Throws:

java.lang.Exception

checkProcessOrderedForAct

public static java.lang.String checkProcessOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                         java.lang.String psProcessName,
                                                         java.lang.String psActKey)
                                                  throws java.lang.Exception

Method that checks if a particular process has been successfully ordered for an organization. Success is defined as the process being ordered, in completed status. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psActKey - psActKey Key of the organization to check process for.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 is Organization Key given was blank or null
-20 is process not ordered for organization or is cancelled

Throws:

java.lang.Exception

chckProcOrderedForAct

public static java.lang.String chckProcOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                     java.lang.String psProcessName,
                                                     java.lang.String psActKey)
                                              throws java.lang.Exception

Method that checks if a particular process has been successfully ordered for a user. Success is defined as the process being ordered, in completed status, and in enabled application status. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psActKey - psActKey Key of the organization to check process for.

Returns:

String 1, if checkProcessOrderedForAct is positive
otherwise return error code that was defined from checkProcessOrderedForAct method:

Throws:

java.lang.Exception

checkProcessOrderedForParentAct

public static java.lang.String checkProcessOrderedForParentAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                               java.lang.String psProcessName,
                                                               java.lang.String psActKey)
                                                        throws java.lang.Exception

Method that checks if a particular process has been successfully ordered for parent of an organization. Success is defined as the process being ordered, in completed status. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psActKey - psActKey Key of the organization whose parent to check process for.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 is Organization Key given was blank or null
-20 is process not ordered for organization or was cancelled
-50 if Organization does not have a parent

Throws:

java.lang.Exception

getDataFromProcessOrderedForUser

public static java.lang.String getDataFromProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                                java.lang.String psProcessName,
                                                                java.lang.String psUsrKey,
                                                                java.lang.String psColumnName)
                                                         throws java.lang.Exception

Method that gets the value of a particular field from the process data for a specific process ordered for the specified user. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psUsrKey - psUsrKey The user process data is to be retrieved.

psColumnName - psColumnName The field whose value is to be retrieved.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 is User Key given was blank or null
-20 if Process not ordered for user or is cancelled
-30 if Process not atomic process
-40 if Process doesn't define process data
-50 if Process has no process data

Throws:

java.lang.Exception

getDataFromProcessOrderedForAct

public static java.lang.String getDataFromProcessOrderedForAct(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                               java.lang.String psProcessName,
                                                               java.lang.String psActKey,
                                                               java.lang.String psColumnName)
                                                        throws java.lang.Exception

Method that gets the value of a particular field from the process data for a specific process ordered for the specified organization. Looks for non cancelled instances of the process. If more than one exists, gets the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName name of the process to look for.

psActKey - psActKey The organization process data is to be retrieved.

psColumnName - psColumnName The field whose value is to be retrieved.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 is User Key given was blank or null
-20 if Process not ordered for organization or is cancelled
-30 if Process not atomic process
-40 if Process doesn't define process data
-50 if Process has no process data

Throws:

java.lang.Exception

getDataFromOrc

public static java.lang.String getDataFromOrc(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                              java.lang.String psOrcKey,
                                              java.lang.String psColumnName)
                                       throws java.lang.Exception

Method that gets the value of a particular field from the process data for a specific orc ordered for the specified organization.

Parameters:

poDataProvider - poDataProvider data base connection.

psOrcKey - psProcessName name of the process to look for.

psColumnName - psActKey The organization process data is to be retrieved.

Returns:

String containing the ORC KEY, if successful.
If not successful, returns the following error codes:
-10 if Orc Key was blank
-20 if Process doesn't exist or is cancelled
-30 if Process not atomic process
-40 if Process doesn't define process data
-50 if Process has no process data

Throws:

java.lang.Exception

setDataForOrcProcess

public static java.lang.String setDataForOrcProcess(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                    java.lang.String psOrcKey,
                                                    java.lang.String psColumnName,
                                                    java.lang.String psColumnValue)
                                             throws java.lang.Exception

Method that sets the value of a particular field in the process data for a specific process instance (ORC). If more than one exists, uses the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psOrcKey - psProcessName name of the process to look for.

psColumnName - psOrcKey The process insatnce whose data is to be set.

psColumnValue - psColumnName The field whose value is to be set.

Returns:

String containing the result code:
1 if successful
-10 if Orc Key was blank
-20 if Process doesn't exist or is cancelled
-30 if Process not atomic process
-40 if Process doesn't define process data
-50 if Process has no process data

Throws:

java.lang.Exception

setDataForProcessOrderedForUser

public static java.lang.String setDataForProcessOrderedForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                               java.lang.String psProcessName,
                                                               java.lang.String psUsrKey,
                                                               java.lang.String psColumnName,
                                                               java.lang.String psColumnValue)
                                                        throws java.lang.Exception

Method that sets the value of a particular field in the process data for a specific process ordered for the specified user. Looks for non cancelled instances of the process. If more than one exists, uses the first one found.

Parameters:

poDataProvider - poDataProvider data base connection.

psProcessName - psProcessName The name of the process to look for.

psUsrKey - psUsrKey The user whose process data is to be modified.

psColumnName - psColumnName The field whose value is to be set.

psColumnValue - psColumnValue The value to be set.

Returns:

String containing a result code:
1 if successful
-10 is User Key given was blank or null
-20 if Process not ordered for user or is cancelled
-30 if Process not atomic process
-40 if Process doesn't define process data
-50 if Process has no process data

Throws:

java.lang.Exception

orderProcessForUser

public static java.lang.String orderProcessForUser(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                   java.lang.String psProcessName,
                                                   java.lang.String psUsrKey)
                                            throws java.lang.Exception

Method that orders a process for a user.

Parameters:

poDataProvider - A data provider

psProcessName - The name of the process to order

psUsrKey - The key of the user to order the process for

Returns:

The Orc Key of the resultant process instance

Throws:

java.lang.Exception

getITAssetKey

public static java.lang.String getITAssetKey(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                             java.lang.String psITAssetType,
                                             java.lang.String psITAssetName)
                                      throws java.lang.Exception

Method that given an Asset Type and Asset Name, returns the Asset Instance Key

Parameters:

poDataProvider - A data provider

psITAssetType - The type of the IT Asset

psITAssetName - The name of the IT Asset

Returns:

The Asset Key

Throws:

java.lang.Exception

getITAssetProperties

public static java.util.Hashtable getITAssetProperties(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                       java.lang.String psServerName)
                                                throws java.lang.Exception

Method that given an Asset Name, returns the Asset Properties in a Hashtable

Parameters:

poDataProvider - A data provider

psServerName - The name of the IT Asset

Returns:

The Asset Properties Hashtable

Throws:

java.lang.Exception

updateITAssetProperty

public static void updateITAssetProperty(com.thortech.xl.server.tcOrbServerObject poCreator,
                                         com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                         java.lang.String psServerName,
                                         java.lang.String psPropName,
                                         java.lang.String psPropValue)
                                  throws java.lang.Exception

Given an Asset Name, associated property name, and its value, the method will update this property with the value passed

Parameters:

poCreator - tcOrbServerObject type object

poDataProvider - A data provider

psServerName - The name of the IT Asset

psPropName - The name of the IT Asset Property

psPropValue - The new value of the IT Asset Property

Throws:

java.lang.Exception

getDeletedProcessFormChildData

public static java.util.Map getDeletedProcessFormChildData(com.thortech.xl.dataaccess.tcDataProvider poDataProvider,
                                                           long childFormDefinitionKey,
                                                           long processInstanceKey,
                                                           long taskInstanceKey)
                                                    throws tcProcessNotFoundException,
                                                           tcFormNotFoundException,
                                                           tcAPIException,
                                                           java.lang.Exception

Get the deleted child form entry details.

Parameters:

poDataProvider - A data provider

psChildTableName - Child process form name

childFormDefinitionKey - Child process form key

processInstanceKey - Process Instance Key

taskInstanceKey - Task Instance Key

Returns:

Map deleted child process form column name and value.

Throws:

java.lang.Exception - DOCUMENT ME!

tcProcessNotFoundException

tcFormNotFoundException

tcAPIException