Built-in methods can be called in method logic anywhere within their scope.
Adds an item to a list attribute.
<<listObject>>::Add(T value) : void
Advances the outputstream the requested number of lines.
<<outputstream>>::Advance(Lines : numericExpression) : void
Advances the outputstream to the specified printer channel number.
<<outputstream>>::AdvanceChannel(Channel : numericExpression) : void
Advances the outputstream to the top of the next page.
<<outputstream>>::AdvanceNewPage(void) : void
Calculates the annual rate of flow required to reduce the present value to zero in the specified number of time periods.
Glb.Financial::AnnualRateOfFlow( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Calculates the annuity (regular savings) required to accumulate the nominated future value.
Glb.Financial::AnnuityFutureValue( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Returns whether the last member of the set has been accessed in the current iteration.
<<datasetInstance>>::AtEnd(void) : Boolean
Specify that the named frame is printed at the head of each new page. Multiple BeginPage methods might be called. The Frames is printed in the order specified by their Sequence property.
<<outputstream>>::BeginPage(Frame : stringExpression) : void
Clears any Begin Page settings for the outputstream.
<<outputstream>>::BeginPageClear(void) : void
Clears the entire contents of a scalar or array variable in a single operation.
<<variable>>::Clear(void) : void
Closes the external file attached to the open extract file.
<<extract file>>::Close( retain : boolean = false, purge : boolean = false) : void
Close – Persistent Class
Resets a specific iterator to its constructed state. The iterator has no position until a First(), Last(), Next(), or Prior() is invoked. For a non-keyed table, following the Close() method with First(), Last(), Next(), or Prior() method reads a ‘start point’ record.
For a keyed table, following the Close() method with:
First() method reads the record at or after the key value(s)
Last() method reads the record at or before the key value(s)
Next() method reads the record at the beginning of the set
Prior() method reads the record at the end of the set
<<persistent class>>::Close(void) : void
Close – Profile
The Close built-in profile method resets a specific iterator to its constructed state. The iterator has no position until a First(), Last(), Next() or Prior() is invoked. For a keyed table, following the Close() method with:
First() method reads the record at or after the key value(s)
Last() method reads the record at or before the key value(s)
Next() method reads the record at the beginning of the set
Prior() method reads the record at the end of the set
<<persistent class>>::Close(<profile>) : void
Called on application shut down.
<<segment>>::CloseDown(void) : void
Called on application shut down.
<<segment>>::CloseUpdate(void) : void
Calculates the future value accumulated in the specified number of time periods from the present value.
Glb.Financial::Compound( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Sets up the ispec or event before it is ready to accept input (for ispecs with a user interface, this corresponds with its display to the application client).
<<ispec || event>>::Construct(void) : void
Opens the database cursor in preparation for iterating through the results of a Determine Actual logic statement.
<SQL script>>::Construct(void) : void
Inverts the sign of the signed number-primitive variable.
<<variable>>::Contra(void) : void
Returns the number of members of the set.
<<datasetInstance>>::Count(void) : numericLiteral
The Create built-in extract file method creates the external file attached to the extract file.
<<extract file>>::Create([Filename : stringExpression]) : void
Deletes the external file attached to the extract file.
<<extract file>>::Delete(void) : void
Releases any resources used by the SQL script.
<<SQL script>>::Destruct(void) : void
Calculates the present value required to accumulate the nominated future value.
Glb.Financial::Discount( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Called during the validation phase of the copy cycle.
<<copy ispec || copy event>>::Edit(void) : void
Calls other Glb.Financial member methods dynamically at runtime.
Glb.Financial::Evaluate( action : qualifier, futureValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Specifies that the ispec is intended for use in an external automatic entry.
<<ispec || event>>::External(isExternal : boolean ) : void
Returns the first member of the set.
<<datasetInstance>>::First(void) : datasetInstance
First – Persistent Class
Returns the first record in the table, if it is a non-keyed table. If it is a keyed table and the key value(s) have been initialized, returns the record with the specified key value(s) or the next record after the key values if there is no direct key-value match available.
<<persistent class>>::First(void) : Boolean
First – Profile
If the Profile has not been initialized (that is, the key values have not been established in the appropriate <table>.<attribute> fields), returns the first record in the table according to the order of the profile’s defined keys and filter conditions (if any). If the Profile has been initialized, then returns the first record matching the specified profile key values or the next record after the key values if there is no direct key-value match available.
<<persistent class>>::First(<profile>) : boolean
Returns the first character of the string variable.
<<string variable>>::First(void) : stringExpression
Calculates the annual rate of flow required to accumulate the nominated future value.
Glb.Financial::FlowForFutureValue( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Calculates the future value accumulated in the specified number of time periods from the annual rate of flow.
Glb.Financial::FutureValueFlow( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Calculates the future value accumulated in the specified number of time periods from the annuity (regular savings).
Glb.Financial::FutureValueFromAnnuity( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Determines the length of a variable. This length includes leading and embedded spaces, but not trailing spaces.
<<string variable>>::GetLength(void) : numericLiteral
Returns the path assigned to the binary instance. If no path is assigned, then an empty string is returned.
<<binaryLargeObject>>::GetPath(void) : string
Clears the database buffer of the ispec. It is generally for use prior to automatic entry processing.
<<ispec || event>>::Initialize(void) : void
<<datasetInstance>>::IsEmpty(void) : boolean
Specifies the sort order for the Sort built-in extract file method.
Static
<<extract file sort order>>::Key( key : qualifier, order : stringExpression) : boolean
Non-static
<<extract file sort order>>::Key( key : qualifier, order : stringExpression) : Boolean
Returns the last member of the set.
<<datasetInstance>>::Last(void) : datasetInstance
Removes leading zeros from the numeric expression and moves the result, left-aligned, and without separators, to the calling variable. Trailing decimal zeros are not removed.
<<string variable>>::LeftAlign( alignThis : numericExpression, setZero : boolean = false, decimalChar : string = void ) : void
Retrieves the class's persistent attributes from the database.
<<persistent class>>::Load(void) : void
Executes the logic of the frame, but does not output the frame for printing.
<<frame>>::Main(void) : void
Called by the segment cycle after automatic validation following the invocation of the ispec or event's Prepare method, but prior to automatic update.
<<ispec || event>>::Main(void) : void
Called on each iteration of a Determine Actual logic statement. It retrieves the next database record from the results of the Determine Actual logic statement.
<<SQL script>>::Main(void) : void
Calculates the annuity (regular payments) required to amortize the present value in the specified number of time periods.
Glb.Financial::Mortgage( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Opens the external file attached to the extract file.
<<extract file>>::Open( fileName : string, mode : string) : void
The Position built-in extract file method positions the offset of the external file attached to the extract file.
<<extract file>>::Position(RecordNumber : numericExpression) : void
Called by the segment cycle before invocation of the ispec or event's Main method.
<<ispec || event>>::Prepare(void) : void
Calculates the present value required to produce the annual rate of flow for the specified number of time periods, leaving a future value of zero.
Glb.Financial::PresentValueFlow( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Calculates the present value required to produce the annuity for the specified number of time periods, leaving a future value of zero.
Glb.Financial::PresentValueToAnnuity( initialValue : numericExpression, interestRate : numericExpression, timeUnits : numericExpression) : numericLiteral
Executes the logic of the frame (including any nested Print method invocations), and outputs the frame for printing.
<<frame>>::Print( streamName : qualifier = void, start : numericExpression = void) : void
Remove all data from the file.
<<extract file>>::Purge(void) : void
Physically deletes the most recently accessed persistent class record from the database.
<<persistent class>>::Purge(void) : void
Reads a record from an extract file into Object.
<<extract file>>::Read(object : anObject : void
Release the current print output.
<<outputstream>>::BeginPageClear(void) : void
Restarts the offset (positions the offset at the beginning) of the external file attached to the extract file.
<<extract file>>::Restart(void) : void
Send the current print to the named Device at Destination on host.
<<outputstream>>::SendPrint( Device : stringExpression [ Destination : stringExpression [ HostName : stringExpression ] ] ) : void
Sends the presentation of the current object to a remote destination specified using GLB.DESTINATION, GLB.DESTHOST etc.
<<persistent class>>::Send(void) : void
Sets the Maint attribute of a keyed ispec to a specified value so that it can be translated to internal form for storage in the database record.
<<ispec>>::SetMaint(maint : stringExpression) : void
Establishes the path to the file containing the binary data.
<<binaryLargeObject>>::SetPath(string) : void
This method sets the attribute it is invoked on to the ClearWhen character defined for that attribute or to the default ClearWhen character if no ClearWhen character has been specifically defined for the attribute.
<<persistent attribute || persistent attribute group>>::SetToClearWhen(void) : void
Orders records in the extract file. The sort order applied is specified by the Key built-in method.
<<extractFile>>::Sort(sortOn : sortOrder) : void
Called on application start up.
<<segment>>::StartUp(void) : void
Updates the class's persistent attributes in the database.
<<persistent class>>::Store(void) : void
Converts the value of the string variable to lowercase. The characters 'A' through 'Z' are converted to 'a' through 'z' respectively. Embedded digits or non-alphabetical characters are unchanged.
<<string variable>>::ToLower(void) : void
Returns the sum of all values of the specified attribute of the members of the set.
<<datasetInstance>>::Total(AttributeName : stringExpression) : numericLiteral
Converts the value of the string variable to uppercase. The characters 'a' through 'z' are converted to 'A' through 'Z' respectively. Embedded digits or non-alphabetical characters are unchanged.
<<string variable>>::ToUpper(void) : void
Updates the current record (last read into the instance).
<<persistent class>>::Update(void) : void
Notes:
To use the <class>.UPDATE() method for MCP-based systems, at least one of the following conditions must be true:
The record is accessed through DT/LU by using the SECURE option within the current processing cycle.
The record is persisted by <class>.STORE() or <class>.CLEARPERSISTENT() prior to the <class>.UPDATE() and within the current processing cycle.
Writes the string representation of Object to the extract file.
<<extract file>>::Write(object : anObject) : void