Class rp

Properties, Events and Methods

Member Description
addfieldvalue This method will add a value the a field property of the oData object. Before adding the value it will validate it's datatype. If incorrect it will return False and an error message placed in cErrorMsg (Public).
o.addfieldvalue( tcFieldName, tvFieldValue, tlChangeDataType)
cleardata This method will clear all results and data values in the object. Best used when you want to keep using most of the settings of the object but just want to clear existing data and errors (Public)
o.cleardata()
createadata This populates the property aData as an array representation of oData. oData must have already been loaded for this to work (Public)
o.createadata()
createnewid
o.createnewid( tcTableID)
createorows This method converts the passed in cursor to a collection in property oRows (Public)
o.createorows( tcCursor)
cursortoxml This save the cursor to xml and adds index and structure information to the XML (Public)
o.cursortoxml( tccursor, tlTableNode, tlOmitHeader)
delete query This method will delete all records resulting from the query. You must include only the "Where" part of the query. (Public)
o.delete()
deletequery This method will delete all records resulting from the query. You must include only the "Where" part of the query. (Public)
o.deletequery( tcFilter)
foxcommand This executes a fox command and returns the results. Only to be used by peoplel who know what there doing (Public)
o.foxcommand( tcCommand, tlNoReturn)
foxstructuretostring Returns a string used to re create a fox table (Public)
o.foxstructuretostring( tcCursorName,tlModified)
getblankrecord Retrieves an empty record and creates an empty oData member. Note no defaults are set.
o.getblankrecord()
getfieldvalue This method returns the value of a field from a table record. The record retireved is governed by the passed in filter (Public)
o.getfieldvalue( tcField, tcFilter)
getorowsitem This is used to retrieve items from the oRows property. This is necessary due to issues with visual basic accessing the oRows property (Public)
o.getorowsitem( tnItem)
getparentpkvalue Returns the value of the Parent PK fo rthe loaded record
o.getparentpkvalue()
getpkvalue This is a simple method for retrieving the PK value of a business object (Public)
o.getpkvalue()
importfromtable This method will import data from another table. It will only apply matched field names
o.importfromtable( tcFileName, tcMatchonExpression ,tcDefaultValueRecord, tcImportIDField, tcIgnoreFields)
importfromxml Imports data from an xml file
o.importfromxml( tcFileName, tcMatchonExpression ,tcDefaultValueRecord, tcImportIDField, tcIgnoreFields)
isvalid Returns true if the passed in value is valid for the passed in field name (Public)
o.isvalid( tcValue, tcField, tcFilter)
load parent Loads an instance of the parent into the member oParent
o.load()
loadtable This method pulls a copy of the table down from the data server (Public)
o.loadtable( tcFilter, tcAlias, tcSelect, tlIsChild, lnResultMode)
loginuser This performs the promatrix login. If the password is not valid then it returns false
o.loginuser( tcID)
makecdata This creates an xml version of odata and places into (Public)
o.makecdata()
new record Exactly the same as the New command. Introduced so as to avoid command conflict in Languages in .NET
o.new( llNoNewPK)
newrecord Exactly the same as the New command. Introduced so as to avoid command conflict in Languages in .NET
o.newrecord( llnonewpk)
open databaseexclusive Tries to open a data base exclusively
o.open()
opendatabase exclusive Tries to open a data base exclusively
o.opendatabase( tcDataBase, tlExclusive)
opendatabaseexclusive Tries to open a data base exclusively
o.opendatabaseexclusive( tcDataBase)
query
o.query( lcSelect as String ,
lcCursor as String ,
lnResultmode as Integer ,
llEditable as Boolean ,
lLoadFirstRecord as Boolean ,
tcTableList as String ,
tlNoNulls as Boolean
)
recordvalidate Validates data in a record (Public)
o.recordvalidate()
reset Resets dynamic properties to default (Public)
o.reset()
save tableinfo Stores inex and table structure info to object
o.save()
seterror
o.seterror()
settable Sets the table properties of the object with the table name passed in (Public)
o.settable( tcTable)
submitasynchjob
o.submitasynchjob()
validateexcludedfield Method to test if validation is excluded for the passed in field (Public)
o.validateexcludedfield( tcField)
calias The Alias of the master file.
casynchjobid ID for Asycnh Job when submitted
cblockreason The reason for the data object block (Public)
cconnectioncode The code for the connection to use. This code relates to local a table holding connection settings (Public)
cdata An XML Vrsion of odata for Http communication (Public)
cdatabase The name of the database in which to find the tables (Public)
cdatadictionarypath Holds the path to the data dictiionary tables
cdatapath Location of the data
cdatatablestructure Holds the data structure of odata
cerrormsg Any error messages that occurred.
cfieldvalidationexcludelist Any fields in this list will not be validated. Used for saving child records of for parent records that haven't been saved yet (Public)
cfilename Filename of the master file of this business object.
cfilter This property will hold any filter to be applied to the query and loadtable methods. This will be added to filter parameter
chookprogramfile This holds the location of the hook file to use for the hook server
chttpmethod The name of the method being called via HTTP
chttpparameters Holds an XML listing of parameteters being passed via HTTP
chttpservername The server name for the HTTPCOM (Public)
clastmodfield Modified by InfoToday: Holds the name of the last modified field
clocaltablename This is the name that the data object will use for working on a local copy of the table related to this data object. IT_Datagrid and also table updates use this to know which table to use (Public)
cparentqueryexpression This can hold the field expression to use when doing queries. It is used so that we can match index expressions exactly to improve speed. This is used if parent values are provided (Public)
cparentvalue This is the code for the parent information. This can be used to determine properties of parent and also to obntain table names for this object (Public)
cpassword User Password (Public)
cpkexpression This expression defines any operation to perform before locating the PK value. It will be evaluated with the assumption that the PK value will be in the variable lcPKValue (Public)
cpkfield The field used as the primary key in the table. This field must be an integer or numeric field.
cpkidtype Specifies data type of the pk id - "C" for character or "N" for numeric
cpkqueryexpression This can hold the field expression to use when doing queries. It is used so that we can match index expressions exactly to improve speed. This is used if PK values are provided (Public)
cpkvalue Holds character PK Values (Public)
cpropertiesreturnedonly This comma deleimited list of properties are returned only from the HTTP server
cpropertiestopassbothways This comma delimited list of properties will be passed over HTTP to the server. All others will be ignored
cpropertiestosendonly This comma delimited list of properties will be passed over HTTP to the server but only in the to server direction.
cproxypass The password to use for Proxy Connections (Public)
cproxyserver Address of proxy server (Public)
cproxyuser The domain\User to use for proxy connections (Public)
cresultxml Methods returning XML will return the XML in this property.
csystemcode Holds the code for a system. This can be referenced by the systems class to get connection properties (Public)
ctable This holds the name of the table within the database. cFileName will hold the physiacl table file name (Public)
ctablestructure Holds the structure of the table so it can be recreated on the client if required
cuserid User ID (Public)
lallowpkset If this is true the users will be allowed to set the PK value of a table. This is useful when using the oTable object
lallowwrite This is a read only property. It is used to totally block write access to the table being accessed by this object. It cannot be changed (Public)
lblocked Flags wether access to the table represented by this data object is blocked. Blockeaso could hold the reason for the block (Public)
lcheckrequired Used to switch of rams value checks for new records created by the ITRDS
lcreateidonnew If this is true then a unique id is assigned to New records. To assign IDs on save then use the lCreateIDONSave (Public)
lcreateidonsave If this is true then a unique id is assigned to records when saved. To assign IDs on New then use the lCreateIDONNew (Public)
lcustomvalidation This is an override switch for all custom validation
ldocustompostdeletelogic If this is true then the custom Post Delete function "Table__PostDelete" will be called after promatrix validation.
ldocustompostsavelogic If this is true then the custom Post Delete function "Table__PostSave" will be called after promatrix validation.
ldocustompredeletelogic If this is true then the custom Post Delete function "Table__PreDelete" will be called after promatrix validation.
ldocustompresavelogic If this is true then the custom Post Delete function "Table__PreSave" will be called after promatrix validation.
ldopostdeletelogic If this is true then the PostDeleteLogic function is called after deleting (Public)
ldopredeletelogic If this is true then then predeletelogic function is called prior to deleting the data (Public)
lerror Error flag for the previous operation. Note this property must be managed by the developer for custom methods.
lfieldvalidate If this is set to true the the FieldValidate function is called first by the record validate function (Public)
lforcelogin If this is true then the user must provide a valid user id and password. This is checked on each method call. See also cUserID and cPassword
lgettablepropertiesonopen If this is true then the table proerties such as PK field are loaded on open without the user having to manually set them. Setting this to True may slow things down.
lincludedeletedinquery This property is for foxpro tables where the query function is to include deleted records (Public)
lincludefoxstructurefromquery If this is true then when the query command is issued the fox structure is included in the XML returned
lisasynchprocess This is used to denote when a process is actually running as an asynch process.
lnoformatfields If this is true then the formatfields method just returns the value without trying to format the value
lopenexclusive This flag is used by the open method to open the table exlusively (Public)
lpostsavelogic If this is true then the method PostSaveLogic will be called after each record save (Public)
lposttounprocessed If this isi true then when posting batcb transactions they will be assigned to an existing open batch for the current user if possible
lpresavehookserver If this is true then the hook server is called just prior to committing the changes
lpresavelogic If this is true then as part of the serverside validation it will call the PreSaveLogic method before saving the record. If this returns false then we exit without saving. (Public)
lpromatrixvalidate If this is set to true then promatrix validation is carried out
lrecordvalidate Flag to determine if we need to validate each record using the RecordValidate method (Public)
lstoreindexes Flag to determine if indexes are stored (Public)
lstoretablestructure Flag to tell if table structure is stored in this.cTableStructure
lsubmitasasynchprocess Denotes if the method should be submitted as an asynchronous process. Only supported on some methods
lusedefaultvalues Flag to determine if we need to populate the record with default values (Public)
luseglobaldatasystem This flag sets whether a data object should use the global data system object to set it's data mode settings (Public)
luseproxy Used to determine if a proxy server is used for Http connection (Public)
luseseekandreplace This tells the ITRDS to use seek commands instead of query commands and replace statements instead of save commands where possible. This improves speed but should only be used when speed is crucial
lusetransactions Tells data modification to use transactions for greater data integrity. Default is True (Public)
lvalidateonsave Flag that determines whether a Valid
lzlibcompression If this is true then everything aside from the soap header is compressed
nhttptimeout The timeout for a call to http server. Default = 40secs
nvpmversion Holds the version number of visual promatix used to create the system
nxmlschematype This property allows you to specify the type of schema used when returning data via HTTP. 0 = None, 2 = In line Schema and 'Row' format, 3 = In Line VFP Schema and 'Row' syntax, 4 = In Line VFP Schema with FoxPro CursortoXML format
odata Data member that receives all of the field names as property values.
oparent Holds an instance of the parent object for this object (Public)
orows A collection of data rows. Gets populated by the ConvertData method and also it can be the results of the Query method. For non foxpro developers see also the GetoRowsItem method (Public)
vencoded Holds encoded data. Created using the it_encoding class

Member	Description
addfieldvalue	This method will add a value the a field property of the oData object. Before adding the value it will validate it's datatype. If incorrect it will return False and an error message placed in cErrorMsg (Public). o.addfieldvalue( tcFieldName, tvFieldValue, tlChangeDataType)
cleardata	This method will clear all results and data values in the object. Best used when you want to keep using most of the settings of the object but just want to clear existing data and errors (Public) o.cleardata()
createadata	This populates the property aData as an array representation of oData. oData must have already been loaded for this to work (Public) o.createadata()
createnewid	o.createnewid( tcTableID)
createorows	This method converts the passed in cursor to a collection in property oRows (Public) o.createorows( tcCursor)
cursortoxml	This save the cursor to xml and adds index and structure information to the XML (Public) o.cursortoxml( tccursor, tlTableNode, tlOmitHeader)
delete	query This method will delete all records resulting from the query. You must include only the "Where" part of the query. (Public) o.delete()
deletequery	This method will delete all records resulting from the query. You must include only the "Where" part of the query. (Public) o.deletequery( tcFilter)
foxcommand	This executes a fox command and returns the results. Only to be used by peoplel who know what there doing (Public) o.foxcommand( tcCommand, tlNoReturn)
foxstructuretostring	Returns a string used to re create a fox table (Public) o.foxstructuretostring( tcCursorName,tlModified)
getblankrecord	Retrieves an empty record and creates an empty oData member. Note no defaults are set. o.getblankrecord()
getfieldvalue	This method returns the value of a field from a table record. The record retireved is governed by the passed in filter (Public) o.getfieldvalue( tcField, tcFilter)
getorowsitem	This is used to retrieve items from the oRows property. This is necessary due to issues with visual basic accessing the oRows property (Public) o.getorowsitem( tnItem)
getparentpkvalue	Returns the value of the Parent PK fo rthe loaded record o.getparentpkvalue()
getpkvalue	This is a simple method for retrieving the PK value of a business object (Public) o.getpkvalue()
importfromtable	This method will import data from another table. It will only apply matched field names o.importfromtable( tcFileName, tcMatchonExpression ,tcDefaultValueRecord, tcImportIDField, tcIgnoreFields)
importfromxml	Imports data from an xml file o.importfromxml( tcFileName, tcMatchonExpression ,tcDefaultValueRecord, tcImportIDField, tcIgnoreFields)
isvalid	Returns true if the passed in value is valid for the passed in field name (Public) o.isvalid( tcValue, tcField, tcFilter)
load	parent Loads an instance of the parent into the member oParent o.load()
loadtable	This method pulls a copy of the table down from the data server (Public) o.loadtable( tcFilter, tcAlias, tcSelect, tlIsChild, lnResultMode)
loginuser	This performs the promatrix login. If the password is not valid then it returns false o.loginuser( tcID)
makecdata	This creates an xml version of odata and places into (Public) o.makecdata()
new	record Exactly the same as the New command. Introduced so as to avoid command conflict in Languages in .NET o.new( llNoNewPK)
newrecord	Exactly the same as the New command. Introduced so as to avoid command conflict in Languages in .NET o.newrecord( llnonewpk)
open	databaseexclusive Tries to open a data base exclusively o.open()
opendatabase	exclusive Tries to open a data base exclusively o.opendatabase( tcDataBase, tlExclusive)
opendatabaseexclusive	Tries to open a data base exclusively o.opendatabaseexclusive( tcDataBase)
query	o.query( lcSelect as String , lcCursor as String , lnResultmode as Integer , llEditable as Boolean , lLoadFirstRecord as Boolean , tcTableList as String , tlNoNulls as Boolean )
recordvalidate	Validates data in a record (Public) o.recordvalidate()
reset	Resets dynamic properties to default (Public) o.reset()
save	tableinfo Stores inex and table structure info to object o.save()
seterror	o.seterror()
settable	Sets the table properties of the object with the table name passed in (Public) o.settable( tcTable)
submitasynchjob	o.submitasynchjob()
validateexcludedfield	Method to test if validation is excluded for the passed in field (Public) o.validateexcludedfield( tcField)
calias	The Alias of the master file.
casynchjobid	ID for Asycnh Job when submitted
cblockreason	The reason for the data object block (Public)
cconnectioncode	The code for the connection to use. This code relates to local a table holding connection settings (Public)
cdata	An XML Vrsion of odata for Http communication (Public)
cdatabase	The name of the database in which to find the tables (Public)
cdatadictionarypath	Holds the path to the data dictiionary tables
cdatapath	Location of the data
cdatatablestructure	Holds the data structure of odata
cerrormsg	Any error messages that occurred.
cfieldvalidationexcludelist	Any fields in this list will not be validated. Used for saving child records of for parent records that haven't been saved yet (Public)
cfilename	Filename of the master file of this business object.
cfilter	This property will hold any filter to be applied to the query and loadtable methods. This will be added to filter parameter
chookprogramfile	This holds the location of the hook file to use for the hook server
chttpmethod	The name of the method being called via HTTP
chttpparameters	Holds an XML listing of parameteters being passed via HTTP
chttpservername	The server name for the HTTPCOM (Public)
clastmodfield	Modified by InfoToday: Holds the name of the last modified field
clocaltablename	This is the name that the data object will use for working on a local copy of the table related to this data object. IT_Datagrid and also table updates use this to know which table to use (Public)
cparentqueryexpression	This can hold the field expression to use when doing queries. It is used so that we can match index expressions exactly to improve speed. This is used if parent values are provided (Public)
cparentvalue	This is the code for the parent information. This can be used to determine properties of parent and also to obntain table names for this object (Public)
cpassword	User Password (Public)
cpkexpression	This expression defines any operation to perform before locating the PK value. It will be evaluated with the assumption that the PK value will be in the variable lcPKValue (Public)
cpkfield	The field used as the primary key in the table. This field must be an integer or numeric field.
cpkidtype	Specifies data type of the pk id - "C" for character or "N" for numeric
cpkqueryexpression	This can hold the field expression to use when doing queries. It is used so that we can match index expressions exactly to improve speed. This is used if PK values are provided (Public)
cpkvalue	Holds character PK Values (Public)
cpropertiesreturnedonly	This comma deleimited list of properties are returned only from the HTTP server
cpropertiestopassbothways	This comma delimited list of properties will be passed over HTTP to the server. All others will be ignored
cpropertiestosendonly	This comma delimited list of properties will be passed over HTTP to the server but only in the to server direction.
cproxypass	The password to use for Proxy Connections (Public)
cproxyserver	Address of proxy server (Public)
cproxyuser	The domain\User to use for proxy connections (Public)
cresultxml	Methods returning XML will return the XML in this property.
csystemcode	Holds the code for a system. This can be referenced by the systems class to get connection properties (Public)
ctable	This holds the name of the table within the database. cFileName will hold the physiacl table file name (Public)
ctablestructure	Holds the structure of the table so it can be recreated on the client if required
cuserid	User ID (Public)
lallowpkset	If this is true the users will be allowed to set the PK value of a table. This is useful when using the oTable object
lallowwrite	This is a read only property. It is used to totally block write access to the table being accessed by this object. It cannot be changed (Public)
lblocked	Flags wether access to the table represented by this data object is blocked. Blockeaso could hold the reason for the block (Public)
lcheckrequired	Used to switch of rams value checks for new records created by the ITRDS
lcreateidonnew	If this is true then a unique id is assigned to New records. To assign IDs on save then use the lCreateIDONSave (Public)
lcreateidonsave	If this is true then a unique id is assigned to records when saved. To assign IDs on New then use the lCreateIDONNew (Public)
lcustomvalidation	This is an override switch for all custom validation
ldocustompostdeletelogic	If this is true then the custom Post Delete function "Table__PostDelete" will be called after promatrix validation.
ldocustompostsavelogic	If this is true then the custom Post Delete function "Table__PostSave" will be called after promatrix validation.
ldocustompredeletelogic	If this is true then the custom Post Delete function "Table__PreDelete" will be called after promatrix validation.
ldocustompresavelogic	If this is true then the custom Post Delete function "Table__PreSave" will be called after promatrix validation.
ldopostdeletelogic	If this is true then the PostDeleteLogic function is called after deleting (Public)
ldopredeletelogic	If this is true then then predeletelogic function is called prior to deleting the data (Public)
lerror	Error flag for the previous operation. Note this property must be managed by the developer for custom methods.
lfieldvalidate	If this is set to true the the FieldValidate function is called first by the record validate function (Public)
lforcelogin	If this is true then the user must provide a valid user id and password. This is checked on each method call. See also cUserID and cPassword
lgettablepropertiesonopen	If this is true then the table proerties such as PK field are loaded on open without the user having to manually set them. Setting this to True may slow things down.
lincludedeletedinquery	This property is for foxpro tables where the query function is to include deleted records (Public)
lincludefoxstructurefromquery	If this is true then when the query command is issued the fox structure is included in the XML returned
lisasynchprocess	This is used to denote when a process is actually running as an asynch process.
lnoformatfields	If this is true then the formatfields method just returns the value without trying to format the value
lopenexclusive	This flag is used by the open method to open the table exlusively (Public)
lpostsavelogic	If this is true then the method PostSaveLogic will be called after each record save (Public)
lposttounprocessed	If this isi true then when posting batcb transactions they will be assigned to an existing open batch for the current user if possible
lpresavehookserver	If this is true then the hook server is called just prior to committing the changes
lpresavelogic	If this is true then as part of the serverside validation it will call the PreSaveLogic method before saving the record. If this returns false then we exit without saving. (Public)
lpromatrixvalidate	If this is set to true then promatrix validation is carried out
lrecordvalidate	Flag to determine if we need to validate each record using the RecordValidate method (Public)
lstoreindexes	Flag to determine if indexes are stored (Public)
lstoretablestructure	Flag to tell if table structure is stored in this.cTableStructure
lsubmitasasynchprocess	Denotes if the method should be submitted as an asynchronous process. Only supported on some methods
lusedefaultvalues	Flag to determine if we need to populate the record with default values (Public)
luseglobaldatasystem	This flag sets whether a data object should use the global data system object to set it's data mode settings (Public)
luseproxy	Used to determine if a proxy server is used for Http connection (Public)
luseseekandreplace	This tells the ITRDS to use seek commands instead of query commands and replace statements instead of save commands where possible. This improves speed but should only be used when speed is crucial
lusetransactions	Tells data modification to use transactions for greater data integrity. Default is True (Public)
lvalidateonsave	Flag that determines whether a Valid
lzlibcompression	If this is true then everything aside from the soap header is compressed
nhttptimeout	The timeout for a call to http server. Default = 40secs
nvpmversion	Holds the version number of visual promatix used to create the system
nxmlschematype	This property allows you to specify the type of schema used when returning data via HTTP. 0 = None, 2 = In line Schema and 'Row' format, 3 = In Line VFP Schema and 'Row' syntax, 4 = In Line VFP Schema with FoxPro CursortoXML format
odata	Data member that receives all of the field names as property values.
oparent	Holds an instance of the parent object for this object (Public)
orows	A collection of data rows. Gets populated by the ConvertData method and also it can be the results of the Query method. For non foxpro developers see also the GetoRowsItem method (Public)
vencoded	Holds encoded data. Created using the it_encoding class