Doco Home Tools Home

This section describes the names generated by Platypus, such as variable names in the generated Java.

There is another page on names in the Hints section - it describes conventions we have found useful for names which are chosen by the developer. Such names include the NAME and ID attributes in the prototype HTML.

Platypus's Conventions for Generated Names

Session Data

Platypus uses the session data to store information which needs to be retained between page requests.

presentation
Section contains information for the presentation layer. The BASE class creates this if it isn't already there, and puts it in a variable 'presentationData'.
business
section is created in the sessionData by the base application BO object. In this section are the business objects that provide access to the data layer. By storing these objects in the sessionData, and then restoring them each time the business layer is instantiated, the time cost of recreating the database connection is avoided. This code is created by Billabong in the application base BO class.
Presentation section
The presentation section of the session data contains:
nextId
value is next "unique id number" for a served page.
DEBUG [Optional]
Section contains debugging flags for the presentation layer. The BASE class creates this if it isn't already there, and puts it in a variable 'debugData'.
RESTOREQUERYSTRING [Optional]
Section contains a KeywordValueTable. The FORMs on subsequent pages might be restored from the name value pairs in this section.
LASTADMINNOTICE [Optional]
The presentation section may contain a LASTADMINNOTICE value. This is the last admin notice served up with a page (if any).

Commonly used Query String Names

RedirectingPO
Where a PO receives a redirection from another PO, it might need to know which PO it came from.
FromPO
This is the name of the previous PO in the workflow displayed at the browser. Only the PO name is here: no directory, no file name suffix.
FromDirPO
This is the name (with directory) of the previous PO in the workflow displayed at the browser. This value includes the directory and PO name, but no file suffixes. Directory separator is '/'.
RESTOREQUERYSTRING
on the query string indicates the FORMs in the page should be rebuilt from the RESTOREQUERYSTRING section of the presentationData (ie, 'presentation' section of the session data).
DEBUG
tells the PO to display debugging information in the served the page.
TableNameId
The ObjectId for the record selected by a drill down.

BASE class variables

The variables declared in the BASE class, for use in the hand-edited manipulation class, are described here.

Manipulation class variables

This section describes the main variables declared in the skeleton manipulation class.

redirectURL, type String
URL to which we will redirect the browser, after this class does its work.
qsQueryStringName, type String
Value of 'QueryStringName' on query string
iAccessName, type int
Loop index
countAccessName, type int
Count of records returned by AccessName DB query.
newAccessName, type Node
Clone of prototype node, after prototype is filled with data.
idnodesAccessName, type Hashtable
List of ID nodes in a cloned access tree.
fieldIdName, type String
ID IdName from DB query on AccessName
oidCommitName, type String
ObjectId for new/updated record