You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Service module to handle common interactions with the Linear Hash database.

Syntax

Response = Database_Services(@Service, @Params)

Returns

The meaning of the response value depends on the service.

Parameters

ParameterDescription
ServiceThe name of the service being requested. Required.
Param1 - Param10Generic parameters.

Remarks

This module provides several useful services for high level interaction with database tables and rows.

Services

ServiceDescription
VerifyLHAll

Usage:
Database_Services('VerifyLHAll', ErrorMessage)

Comments:
Sets an error to the stack. This will automatically clear any existing error conditions first so this error will be the only one on the stack.

Returns:
N/A 

VerifyLH

Usage:
Database_Services('VerifyLH', ErrorMessage)

Comments:
Adds an error to the stack. This will not clear existing error conditions first. It is intended to allow higher level routines to add more information to an existing error condition or simply to maintain an ongoing error log for some troubleshooting or debugging purposes.

Returns:
N/A

GetTableProperties

Usage:
Database_Services('GetTableProperties')

Comments:
Clears all error conditions and related information.

Returns:
N/A

GetTableHandle

Usage:
Database_Services('GetTableHandle')

Comments:
Returns the most current error message.

Returns:
The most current error message.

ClearTableHandle

Usage:
Database_Services('ClearTableHandle')

Comments:
Returns the stack of error messages. This will be @FM delimited.

Returns:
The stack of error messages.

ReadDataRow

Usage:
Database_Services('ReadDataRow')

Comments:
Returns True if there is an error condition, False if there is no error condition. Caller will still need to use the GetMessage or GetMessages service to determine what the error is. The HasError service allows the caller to embed the Error_Services service call inside of a conditional statement like this:

If Error_Services('HasError') then
* An error has occured. Proceed accordingly.
ErrorMessage = Error_Services('GetMessage')
end else
* No error has occured.
end

Returns:
True if there is an error condition, False if there is no error condition.

WriteDataRow

Usage:
Database_Services('WriteDataRow')

Comments:
Returns True if there are no error conditions, False if there is an error condition. This is the opposite of the HasError service and exists for improved readability.

Returns:
True if there are no error conditions, False if there is an error condition.

DeleteDataRow

Usage:
Database_Services('DeleteDataRow')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

GetKeyIDLock

Usage:
Database_Services('GetKeyIDLock')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

ReleaseKeyIDLock

Usage:
Database_Services('ReleaseKeyIDLock')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

SetTableAlias

Usage:
Database_Services('SetTableAlias')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

SearchIndex

Usage:
Database_Services('SearchIndex')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

CalculateColumn

Usage:
Database_Services('CalculateColumn')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

GetTableCommuter

Usage:
Database_Services('GetTableCommuter')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

GetUserLocks

Usage:
Database_Services('GetUserLocks')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

IsKeyIDLocked

Usage:
Database_Services('IsKeyIDLocked')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

IsKeyIDSelfLocked

Usage:
Database_Services('IsKeyIDSelfLocked')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

UnlockKeyID

Usage:
Database_Services('UnlockKeyID')

Comments:
Displays the current error message to the end user. Error_Services is designed to avoid any user interface so it can be safe to use in application contexts where no presentation server context is available (e.g., web applications). For convenience, the DisplayError service was added to make it easy to display the most recent error added to the stock.

Returns:
N/A

Param1 - Param10

The proper use of the generic arguments are defined in the definition of each service above.

  • No labels