OptBase Class Methods
This section discusses the abstract base class placeholder methods for the PT_OPT_BASE:OptBase application class. The methods are listed in alphabetical order.
Syntax
GetParmDate(parmName, &parmVal)
Description
The GetParmDate method retrieves a Date parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Date variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmDateArray(parmName, &parmVal)
Description
The GetParmDateArray method retrieves a Date array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Date array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmDateTime(parmName, &parmVal)
Description
The GetParmDateTime method retrieves a DateTime parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a DateTime variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmDateTimeArray(parmName, &parmVal)
Description
The GetParmDateTimeArray method retrieves a DateTime array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a DateTime array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmNumber(parmName, &parmVal)
Description
The GetParmNumber method retrieves a Number parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmNumberArray(parmName, &parmVal)
Description
The GetParmNumberArray method retrieves a Number array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmInt(parmName, &parmVal)
Description
The GetParmInt method retrieves an Integer parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify an Integer variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmIntArray(parmName, &parmVal)
Description
The GetParmIntArray method retrieves a Number array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmString(parmName, &parmVal)
Description
The GetParmString method retrieves a String parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a String variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmStringArray(parmName, &parmVal)
Description
The GetParmStringArray method retrieves a String array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a String array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmTime(parmName, &parmVal)
Description
The GetParmTime method retrieves a Time parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Time variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
GetParmTimeArray(parmName, &parmVal)
Description
The GetParmTimeArray method retrieves a Time array parameter value that passed as input by any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Time array variable to contain the value passed as input by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
Init()
Description
The Init method launches when the CreateOptEngine built-in function loads an analytic instance that uses the Optimization PeopleCode plug-in.
Use this method to perform additional processing for your own purposes, including checking table data, or any functionality you want to apply before any plug-in transactions run. You accomplish this by adding your own PeopleCode to the extended method.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run before any other code in your extended class.
Note: If you don't extend this method, PeopleSoft Optimization Framework calls its base version from the OptBase application class.
Parameters
None.
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
OptDeleteCallback(&Record)
Description
The OptDeleteCallback method launches when PeopleSoft Optimization Framework propagates to the datacache any database deletions that it encounters for a callback record.
Use this method to perform additional processing for your own purposes, including modifying any derived data structures that might be affected by the deletion. You accomplish this by adding your own PeopleCode to the extended method.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run.
Important! If you designate any record in the analytic type definition as a callback record, you must ensure that you extend this callback method in your derived class, even if the extended method contains only a Return statement. Otherwise the Optimization PeopleCode plug-in will fail.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Record |
Specifies a record variable that contains the keys of the data row to be deleted. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
OptInsertCallback(&Record)
Description
The OptInsertCallback method launches when PeopleSoft Optimization Framework propagates to the datacache any database insertion that it encounters for a callback record.
Use this method to perform additional processing for your own purposes, including modifying any derived data structures that might be affected by the insertion. You accomplish this by adding your own PeopleCode to the extended method.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run.
Important! If you designate any record in the analytic type definition as a callback record, you must ensure that you extend this callback method in your derived class, even if the extended method contains only a Return statement. Otherwise the Optimization PeopleCode plug-in will fail.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Record |
Specifies a record variable that contains the new data row to be inserted. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
OptPostUpdateCallback(&OldRecord, &NewRecord)
Description
The OptPostUpdateCallback method launches after PeopleSoft Optimization Framework propagates to the datacache any database update that it encounters for a callback record.
Use this method to perform additional processing for your own purposes, including modifying any derived data structures that might have been affected by the update. You accomplish this by adding your own PeopleCode to the extended method. The parameters provide the previous and current content of the row.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run.
Important! If you designate any record in the analytic type definition as a callback record, you must ensure that you extend this callback method in your derived class, even if the extended method contains only a Return statement. Otherwise the Optimization PeopleCode plug-in will fail.
Parameters
|
Field or Control |
Definition |
|---|---|
| &OldRecord |
Specifies a record variable that contains the pre-update content of the data row that was updated. |
| &NewRecord |
Specifies a record variable that contains the post-update content of the data row that was updated. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
OptPreUpdateCallback(&OldRecord, &NewRecord)
Description
The OptPreUpdateCallback method launches before PeopleSoft Optimization Framework propagates to the datacache any database update that it encounters for a callback record.
Use this method to perform additional processing for your own purposes, including modifying any derived data structures that might be affected by the update. You accomplish this by adding your own PeopleCode to the extended method. The parameters provide the current and future content of the row.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run.
Important! If you designate any record in the analytic type definition as a callback record, you must ensure that you extend this callback method in your derived class, even if the extended method contains only a Return statement. Otherwise the Optimization PeopleCode plug-in will fail.
Parameters
|
Field or Control |
Definition |
|---|---|
| &OldRecord |
Specifies a record variable that contains the pre-update content of the data row to be updated. |
| &NewRecord |
Specifies a record variable that contains the post-update content of the data row to be updated. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
OptRefreshCallback()
Description
The OptRefreshCallback method launches after PeopleSoft Optimization Framework propagates to the datacache all database insertions, deletions, and updates that it encounters for all callback records.
Use this method to perform additional processing for your own purposes, including modifying any derived data structures that might be affected by the modifications. You accomplish this by adding your own PeopleCode to the extended method.
Don't call this method in your own PeopleCode. It's called automatically at the appropriate moment by PeopleSoft Optimization Framework, which enables your added functionality to run.
Important! If you designate any record in the analytic type definition as a callback record, you must ensure that you extend this callback method in your derived class, even if the extended method contains only a Return statement. Otherwise the Optimization PeopleCode plug-in will fail.
Parameters
None.
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmDate(parmName, &parmVal)
Description
Use the SetOutputParmDate method to pass a Date parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Date variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmDateArray(parmName, &parmVal)
Description
Use the SetOutputParmDateArray method to pass a Date array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Date array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmDateTime(parmName, &parmVal)
Description
Use the SetOutputParmDateTime method to pass a DateTime parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a DateTime variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmDateTimeArray(parmName, &parmVal)
Description
Use the SetOutputParmDateTimeArray method to pass a DateTime array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a DateTime array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmNumber(parmName, &parmVal)
Description
Use the SetOutputParmNumber method to pass a Number parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmNumberArray(parmName, &parmVal)
Description
Use the SetOutputParmNumberArray method to pass a Number array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmInt(parmName, &parmVal)
Description
Use the SetOutputParmInt method to pass an Integer parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify an Integer variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmIntArray(parmName, &parmVal)
Description
Use the SetOutputParmIntArray method to pass a Number array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Number array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmString(parmName, &parmVal)
Description
Use the SetOutputParmString method to pass a String parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a String variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmStringArray(parmName, &parmVal)
Description
Use the SetOutputParmStringArray method to pass a String array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a String array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmTime(parmName, &parmVal)
Description
Use the SetOutputParmTime method to pass a Time parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Time variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.
Syntax
SetOutputParmTimeArray(parmName, &parmVal)
Description
Use the SetOutputParmTimeArray method to pass a Time array parameter value as output from any method you develop that corresponds to an Optimization PeopleCode plug-in transaction. You develop the transaction method in an application class that you derive from the OptBase application class.
Parameters
|
Field or Control |
Definition |
|---|---|
| parmName |
Specify the name of the parameter as it's defined for the Optimization PeopleCode plug-in transaction. |
| &parmVal |
Specify a Time array variable that contains a value to be passed as output by the parameter. |
Returns
A Boolean value: True if the method is successful, False otherwise.