Quick Reference for PeopleCode Classes

Appendix: Quick Reference for PeopleCode Classes

This appendix discusses:

PeopleCode classes
Session class methods and properties
Mapping of functions to methods
Mapping of old names to new names
PeopleCode syntax quick reference

PeopleCode Classes

This section provides an overview of typographical conventions and visual cues and lists the PeopleCode classes in alphabetical order, along with the functions, methods and properties associated with that class.

Typographical Conventions and Visual Cues

This table describes the typographical conventions and visual cues that are used in this quick reference:

Typographical Convention or Visual Cue	Description
^D	Identifies the default method for a class.
^RO	Identifies a read-only property. Properties that aren't identified as read-only are read-write.

In addition, the usual PeopleCode typographical conventions are used to distinguish between different elements of the PeopleCode language, such as keyword to indicate keywords or syntax that must be entered exactly as shown, variable for arguments, parameters, and so on.

AESection

This section lists the functions, methods, and properties, as well as returns (if applicable), for the AESection class.

Function

Function	Returns
GetAESection(applid, ae_section [, effdt])	AESection object

Methods

Method	Returns
AddStep(ae_step_name [,NewStepName])	None
Close()	None
Open(ae_applid, ae_section, [effdt])	AESection object
Save()	None
SetSQL(action_type_string, string)	None
SetTemplate(ae_applid, ae_section)	None

Property

Property	Returns
IsOpen	Boolean ^RO

Analytic Calculation Engine Classes

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Analytic Calculation Engine Classes.

Functions

Function	Returns
CreateAnalyticInstance(AnalyticType, AIID, Descr, AppClassName, MethodName, &RecordRef, Force)	AnalyticInstance object
GetAnalyticInstance(AIID)	AnalyticInstance object

AnalyticInstance Methods

Method	Returns
CheckAsyncStatus()	Number
CheckStatus()	Constant
Copy(NewAIID, ForceDelete, &Record)	None
Delete(ForceUnload, &RecordRef)	None
GetAnalyticModel((Model.ModelName)	AnalyticModel object
GetTraceLevel()	Integer
Load((Message.MessageName), Sync, IdleTimeOut)	String
RunAsync()	None
RunSync()	None
SetTraceLevel(TraceLevel)	Number
Terminate()	None.
Unload()	None

AnalyticInstance Properties

Property	Returns
AnalyticType	String^RO
ID	Integer^RO
Messages	Multi-dimensional array of any^RO

AnalyticModel Methods

Method	Returns
AddMember(DimName, MemberName)	None
AttachTree(DimName, TreeName, SetId, UserKeyValue, EffDt, NodeName, OverrideRecord, DetailStartLvl, TreeDiscardLvl)	None
CalculateCube(CubeName, Sync)	None
DetachTree(DimName)	None
GetCubeCollection(CubeCollName)	CubeCollection object
GetCellProperties(CubeName, &Node)	Array of string
GetMembers(DimName, DimFilter)	Two-dimensional array
GetTree(DimName)	Array of string
Recalculate(Sync)	String
RenameMember(DimName, OrigMemberName, NewMemberName)	None

AnalyticModel Property

Property	Returns
Messages	Multi-dimensional array of any^RO

CubeCollection Methods

Method	Returns
CollapseNode(DimName, &Node)	None
DrillIntoNode(DimName, &Node)	None
DrillOutOfNode(DimName, &Node)	None
ExpandNode(DimName, &Node, ExpandAll)	None
GetData(&DataRowset, StartRow, EndRow[, NetChanges])	None
GetDimFilter(DimName)	String
GetDimSort(DimName)	Array
GetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)	None
GetRowCount()	Integer
SetData(&DataRowset)	None
SetDimensionOrder(&FieldNames)	None
SetDimFilter(DimName, DimFilter)	None
SetDimSort(DimName, IsAscending[, Key1, IsAscending2, Key2, IsAscending3, Key3])	None
SetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray	None
SetSlice(&SliceRecord)	None
ShowHierarchy(DimName, Show)	None
UnsetDimFilter(DimName)	None
UnsetDimSort(DimName)	None

CubeCollection Property

Property	Returns
Messages	Multi-dimensional array of any^RO

Analytic Calculation Engine Metadata Classes

This section lists the methods and properties, as well as returns (if applicable), for the Analytic Calculation Engine metadata classes.

AnalyticModelDefn Methods

Method	Returns
AddCube(CubeName)	CubeDefn object
AddCubeCollection(CubeCollectionName)	CubeCollectionDefn object
AddDimension(DimName)	DimensionDefn object
AddExplicitDimensionSet (ExplicitDimSetName)	ExplicitDimensionSet object
AddOrganizer(OrganizerName)	OrganizerDefn object
AddUserFunction(UserFunctionName)	UserFunction object
CopyCube(CubeName, NewCubeName)	CubeDefn object
CopyCubeCollection(CubeCollectionName, NewCubeCollectionName)	CubeCollectionDefn object
CopyDimension(DimName, NewDimName)	DimensionDefn object
CopyExplicitDimensionSet(OldExplicitDimSetName, NewExplicitDimSetName)	ExplicitDimensionSet object
CopyTo(NewModelName)	AnalyticModelDefn object
CopyUserFunction(UserFunctionName, NewUserFunctionName)	UserFunctionDefn object
Create()	None
Delete()	None
DeleteCube(CubeName, ForceDelete)	None
DeleteCubeCollection(CubeCollectionName, ForceDelete)	None
DeleteOrganizer(OrganizerName)	None
DeleteDimension(DimensionName)	None
DeleteExplicitDimensionSet(ExplicitDimensionSetName)	None
DeleteUserFunction(UserFunctionName, ForceDelete)	None
Get()	None
GetCube(CubeName)	CubeDefn object
GetCubeCollection(CubeCollection)	CubeCollectionDefn object
GetCubeCollectionNames()	Array of string
GetCubeNames()	Array of string
GetDimension(DimName)	DimensionDefn object
GetDimenstionNames()	Array of string
GetExplicitDimensionSet	ExplicitDimensionSet object
GetExplicitDimensionSetNames	Array of strings
GetOrganizer(OrganizerName)	OrganizerDefn object
GetOrganizerNames()	Array of string
GetUserFunction(UserFunctionNames)	UserFunctionDefn object
GetUserFunctionNames()	Array of string
Rename(NewModelName)	None
RenameCube(CubeName, NewCubeName, ForceRename)	None
RenameCubeCollection(CubeCollectionName, NewCubeCollectionName, ForceRename)	None
RenameDimension(DimensionName, NewDimName, ForceRename)	None
RenameExplicitDimensionSet(ExplicitDimSetName, NewExplicitDimSetName, ForceRename)	None
RenameOrganizer(OrganizerName, NewOrganizerName, ForceRename)	None
RenameUserFunction(UserFunctionName, NewUserFunctionName, ForceRename)	None
Save()	None
Validate()	Boolean

AnalyticModelDefn Properties

Property	Returns
CircularFomulaWarn	Boolean
Description	String
IsValid	Boolean^RO
LongDescription	String
MaxDelta	Integer
MaxIterations	Integer
Messages	Multi-dimensional array of any^RO
Name	String^RO
ResolveCircularDeps	Boolean

DimensionDefn Properties

Property	Returns
AggregateSequence	Number^RO
AggregationUserFunction	String
Comments	String
Name	String^RO
TotalMemberName	String

ExplicitDimensionSet Methods

Method	Returns
AttachDimension(DimName)	None.
DetachDimension(DimName)	None.
GetDimensionName()	Array of string.

ExplicitDimensionSet Properties

Property	Returns
Name	String ^RO
SequenceNumber	Number ^RO

CubeDefn Methods

Method	Returns
AttachDimension(DimName)	None
DetachDimension(DimName)	None
GetCauses(CauseType)	Array of string
GetCircularDeps(DimName)	Array of string
GetDimensionAggregate(DimName)	String
GetEffects(EffectType)	Array of string
GetDimensionNames()	Array of string
GetRule(DimensionName)	RuleDefn object
SetDimensionAggregate(DimName, UserFunctionName)	None
SetRule(&RuleDefn)	None
UsesDimension(DimName)	Boolean

CubeDefn Properties

Property	Returns
CalcAggregates	Boolean
Comments	String
DimensionCount	Number^RO
FormatType	Varies
IsVirtual	Boolean
Name	String^RO
Rule	String
ValueDimensionName	String

CubeCollectionDefn Methods

Method	Returns
AttachCube(CubeName)	None
DetachCube(CubeName)	None
GetAggregateMapping(PartName, IsCube)	String
GetCubeNames()	Array of string
GetDimensionNames()	Array of string
GetDimSort(DimensionName)	Array of string
GetFieldMapping(PartName, IsCube)	String
GetFilter(DimensionName)	String
GetPersistAggregate(DimensionName)	String
SetAggregateMapping(PartName, IsCube, AggregateFieldName)	String
SetDimSort(DimName, IsAscending[,CubeName1, IsAscending2, CubeName2, IsAscending3, CubeName3])	None
SetFieldMapping(PartName, IsCube, FieldName)	None
SetFilter(DimensionName, FilterName)	None
SetPersistAggregate(DimensionName, AggregateType)	None
UsesCube(CubeName)	Boolean
UsesDimension(DimensionName)	Boolean

CubeCollectionDefn Properties

Property	Returns
AggregateRecName	String
Comments	Number^RO
CubeCount	Number^RO
DimensionCount	Number^RO
Name	String^RO
RecordName	String

UserFunctionDefn Properties

Property	Returns
Comments	String
Name	String^RO

UserFunctionDefn Methods

Method	Returns
GetRule( )	RuleDefn object
SetRule(&Rule)	None

OrganizerDefn Methods

Method	Returns
AttachPart(PartName, PartType)	None
DetachPart(PartName, PartType	None
GetPartNames()	Array of string
UsesPart(PartName, PartType)	Boolean

OrganizerDefn Properties

Property	Returns
Comments	String
Name	String^RO

RuleDefn Methods

Method	Returns
AddRuleExpression(&Expr)	None
GenerateRule ( )	None

RuleDefn Property

Property	Returns
RuleString	String^RO

Assignment Method

Method	Returns
GenerateRule()	String

Assignment Properties

Property	Returns
Expression	Depends on value
Variable	String

Comparison Method

Method	Returns
GenerateRule ()	String

Comparison Properties

Property	Returns
Operand1	RuleExpression object
Operand2	RuleExpression object
Type	String ^RO

Constant Method

Method	Returns
GenerateRule()	String

Constant Properties

Property	Returns
Type	String ^RO
Value	String ^RO

Cube Methods

Method	Returns
AddIndex(&MemberReference)	None
GenerateRule()	String
GetIndexes()	Array of MemberReference objects

Cube Property

Property	Returns
Name	String ^RO

ExpressionBlock Methods

Method	Returns
AddRuleExpression(&Expr)	None.
GetRuleExpressions()	Array of rule expression objects.

FunctionCall Methods

Method	Returns
AddArgument(&RuleExpression)	None
GenerateRule()	String
GetArguments()	Array of RuleExpression objects

FunctionCall Properties

Property	Returns
Name	String ^RO
Type	String

MemberReference Method

Method	Returns
GenerateRule()	String

MemberReference Properties

Property	Returns
Dimension	String ^RO
Member	String ^RO

Operation Method

Method	Returns
GenerateRule()	String

Operation Properties

Property	Returns
Operand1	RuleExpression object
Operand2	RuleExpression object
Type	String

Variable Method

Method	Returns
GenerateRule()	String

Variable Properties

Property	Returns
Name	String ^RO
Type	String ^RO

Analytic Grid Classes

This section lists the functions, methods, and properties, as well as returns (if applicable), for the AnalyticGrid class.

AnalyticGrid Function

Function	Returns
GetAnalyticGrid(PAGE.pagename, gridname)	AnalyticGrid object

AnalyticGrid Methods

Method	Returns
GetColumn(ColumnName)	GridColumn object
GetCubeCollection()	CubeCollection object
LoadData()	None
SetAnalyticInstance(AIID)	None

AnalyticGrid Properties

Property	Returns
InActive	Boolean
Label	String
ShowGridLines	Boolean
SlicerVisible	Boolean

Analytic Type Classes

This section lists the methods and properties as well as returns for Analytic Type classes.

AnalyticTypeDefn Methods

Method	Returns
AddModel(ModelName, ModelType	AnalyticTypeModelDefn object
AddRecord(RecordName)	AnalyticTypeRecordDefn object
Create()
Copy(NewAnalyticTypeName, ForceCopy)	AnalyticTyepDefn object
Delete()
DeleteModel(ModelName)	None
DeleteRecord(RecordName)	None
Get()	None
GetModels()	Array
GetRecordNames()	Array of string
Rename(NewAnalyticTypeName)	None
Save()	None

AnalyticTypeDefn Properties

Property	Returns
Comments	String
Description	String
Name	String^RO
AppClassPath	String
OwnerID	String ^RO

AnalyticTypeModelDefn Properties

Property	Returns
Name	String^RO
Type	String^RO

AnalyticTypeRecordDefn Methods

Method	Returns
GetSelectedFields()	Array of string
SetSelectedFields(SelectedFieldsArray)	None
UnsetSelectedFields(FieldName)	None

AnalyticTypeRecordDefn Properties

Property	Returns
Callback	Boolean
Description	String
Name	String^RO
Readable	Boolean
ReadOnce	Boolean
ScenarioManaged	Boolean
SyncOrder	Integer^RO
Writeable	Boolean

Application Classes

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Application classes.

Functions

Function	Returns
Class classname [{Extends \| Implements}Classname] [Method_declarations] [Property_declarations] [Protected [Method_declarations] [Instance_declarations] [Constant_declaration]] [Private [Method_declarations] [Instance_declarations] [Constant_declaration]] End-Class	None
Get PropertyName StatementList End-Get	Depends on assignment of StatementList
Import PackageName:[PackageName. . .:]{Classname \| *}	None
Interface classname [{Extends \| Implements}Classname] [Method_declarations] [Property_declarations] [Protected [Method_declarations] [Instance_declarations] [Constant_declaration]] End-Interface	None.
Method MethodName StatementList End-Method	Depends on method
Set PropertyName StatementList End-Set	None

Array

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Array class.

Functions

Function	Returns
CreateArray(paramlist)	Array object
CreateArrayAny([paramlist] )	Array object
CreateArrayRept(val, count)	Array object
Split(string, separator)	Array object

Methods

Method	Returns
Clone()	Array object
Find(value)	Index of an element
Get(index)	Element of array
Join([separator [ , arraystart, arrayend [, stringsizehint]]])	String
Next(&index)	Boolean
Pop()	Value of last array element
Push(paramlist)	None
Replace(start, length, [paramlist])	None
Reverse()	None
Set(index)	None
Shift()	Value of first array element
Sort([order])	None
Subarray(start, length)	Array object
Substitute(old_val, new_val)	None
Unshift(paramlist)	None

Properties

Property	Returns
Dimension	Number ^RO
Len	Number

Business Interlinks and BIDocs

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Business Interlinks and BIDocs classes.

Business Interlink Functions

Function	Returns
GetBIDoc([XMLString])	BIDoc object
GetInterlink(INTERLINK.name)	Business Interlink object

Business Interlink Methods

Method	Returns
AddInputRow(inputname, value)	Boolean
BulkExecute(RECORD.inputrec [, RECORD.outputrec] [, user_process_inst \| user_operid])	Number
Clear()	None
Execute()	Number
FetchIntoRecord(RECORD.recname, [, user_process_inst \| user_operid])	Number
FetchIntoRowset(&Rowset)	Number
FetchNextRow(outputname, value)	Output row object
GetFieldCount()	Number
GetFieldType(index)	Number
GetFieldValue(index)	String
InputRowset(&Rowset)	Number
MoveFirst()	Boolean
MoveNext()	Boolean

Business Interlink Property

Property	Returns
StopAtError	Boolean

BIDoc Configuration Parameters

Configuration Parameters	Returns
URL	String
All other configuration parameters can be accessed like read-write properties.	Depends on type of Interlink plug-in.

BIDoc Methods

Method	Returns
AddAttribute(attributename, attributevalue)	Number
AddComment(comment)	Number
AddProcessingInstruction(instruction)	Number
AddText(text)	Number
CreateElement(elementname)	BIDoc object
GenXMLString()	String
GetAttributeName(attributenumber)	String
GetAttributeValue({attributenumber \| attributename})	String
GetNode({nodenumber \| nodename})	BIDoc object

Chart

This section lists the functions, methods, and properties, as well as returns (if applicable), for the chart class.

Note. There is only one chart class. However, the methods and properties have been grouped into logical sections.

Chart Functions

Function	Returns
CreateObject("Chart")	Chart object
GetChart(RecordName.FieldName)	Chart object
GetGanttChart([Recordname.FieldName])	Chart object

Chart Data Methods

Method	Returns
Refresh()	None
SetData({Record_Name \| &Rowset})	None
SetDataHints(Record_Name.Field_Name)	None
SetDataSeries(Record_Name.Field_Name)	None
SetDataURLs(URLString)	None
SetDataXAxis(Record_Name.Field_Name)	None
SetDataYAxis(Record_Name.Field_Name)	None

Chart Data Properties

Property	Returns
DataStartRow	Number
DataWidth	Number
ImageMap	Image map ^RO
IsTrueXY	Boolean

Chart Appearance Properties

Property	Returns
GridLines	String
GridLineType	String
Height	Number
IsDrillable	Boolean
IsPlainImage	Boolean
LineType	String
RotationAngle	Number
Style	String
StyleSheet	String
Type	String
Width	Number

Chart Color Methods

Method	Returns
SetColorArray(&Array_of_Color)	None
SetDataColor(Record_Name.Field_Name)	None

Chart Axis Methods

Method	Returns
SetXAxisLabels(&Array_of_Any)	None
SetYAxisLabels(&Array_of_Any)	None

Chart Axis Properties

Property	Returns
XAxisCross	String
XAxisLabelOrient	String
XAxisStyle	String
XAxisTicks	Number
YAxisLabelOrient	String
YAxisMax	Number
YAxisMin	Number
YAxisStyle	String
YAxisTicks	Number

Chart Title Properties

Property	Returns
MainTitle	String
MainTitleOrient	String
MainTitleStyle	String
XAxisTitle	String
XAxisTitleOrient	String
XAxisTitleStyle	String
YAxisTitle	String
YAxisTitleOrient	String
YAxisTitleStyle	String

Chart Legend Method

Method	Returns
SetLegend(&Array_of_String)	None

Chart Legend Properties

Property	Returns
HasLegend	Boolean
LegendMaxEntries	Number
LegendPosition	String
LegendStyle	String

Chart Overlay Methods

Method	Returns
SetOLData({Record_Name \| &Rowset})	None
SetOLDataSeries(Record_Name.Field_Name)	None
SetOLDataXAxis(Record_Name.Field_Name)	None
SetOLDataYAxis(Record_Name.Field_Name)	None

Chart Overlay Properties

Property	Returns
OLLineType	None
OLType	None

Scatter Chart Methods

Method	Returns
SetDataAnnotations(Recordname.FieldName)	None
SetDataGlyphScale(Recordname.FieldName)	None
SetOLDataAnnotations(Recordname.FieldName)	None
SetOLDataGlyphScale	None

Scatter Chart Property

Property	Returns
ShowCrossHair	Boolean

TrueXY Line Chart Properties

Property	Returns
XAxisCrossPoint	Number
XAxisMax	Number
XAxisMin	Number
XAxisPrecision	Number
XAxisScaleResolution	Constant
YAxisCrossPoint	Number
YAxisMax	Number
YAxisMin	Number
YAxisPrecision	Number
YAxisScaleResolution	Constant

Gantt Chart Methods

Method	Returns
SetActualEndDate(RecordName.FieldName)	None
SetActualStartDate(RecordName.FieldName)	None
SetActualTaskBarColor(Recordname.FieldName)	None
SetChartArea(Percentage)	None
SetPlannedEndDate(RecordName.FieldName)	None
SetPlannedStartDate(RecordName.FieldName)	None
SetPlannedTaskBarColor(RecordName.FieldName)	None
SetTableXScrollbar(Scroll_ArrowAmount)	None
SetTaskAppData(RecordName.FieldName1[, RecordName.FieldName2 [,RecordName.FieldName3. . .]])	None
SetTaskAppDataTitles(&TitleArray)	None
SetTaskBarURL(RecordName.FieldName)	None
SetTaskData({Record.RecordName \| &Rowset})	None
SetTaskDependencyChildID(RecordName.FieldName)	None
SetTaskDependencyData({RecordName \| &Rowset})	None
SetTaskDependencyURL(RecordName.FieldName)	None
SetTaskDependencyParentID(RecordName.FieldName)	None
SetTaskExpanded(RecordName.FieldName)	None
SetTaskHints(RecordName.FieldName)	None
SetTaskID(RecordName.FieldName)	None
SetTaskLabel(RecordName.FieldName)	None
SetTaskLevel(RecordName.FieldName)	None
SetTaskName(RecordName.FieldName)	None
SetTaskProgress(RecordName.FieldName)	None
SetTaskMilestone(RecordName.FieldName)	None.
SetTaskProgressBarColor(RecordName.FieldName)	None
SetWBSNumbering(RecordName.FieldName)	None

Gantt Chart Properties

Property	Returns
AxisEndDateTime	Datetime
AxisStartDateTime	Datetime
DataEndDateTime	Datetime
DataStartDateTime	Datetime
PixelsPerRow	Number ^RO
ShowTaskLabels	Boolean
TaskDependencyLineType	Number
TaskTitle	String
TaskMilestoneGlyph	Number
XAxisPosition	Constant
YAxisPosition	Constant

Gantt Chart DateTimeAxis Specific Methods

Method	Returns
SetDayFormat(Format)	None
SetHourFormat(Format)	None
SetMinuteFormat(Format)	None
SetMonthFormat(Format)	None
SetSecondFormat(Format)	None
SetYearFormat(Format)	None

Component Interface

See Component Interface Class Methods and Properties.

Exception

This section lists the functions, methods, and properties, as well as returns (if applicable), for the exception class.

Functions

Function	Returns
CreateException(message_set, message_num, default_txt [, subslist])	Exception object
Throw Expression	None
try Protected StatementList catch QualifiedID &Id StatementList end-try	Not applicable

Methods

Method	Returns
GetSubstitution(Index)	String
Output()	Depends on context
SetSubstitution(Index, String)	None
ToString([AddContext])	String

Properties

Property	Returns
Context	String ^RO
DefaultText	String
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MessageSeverity	String ^RO
SubstitutionCount	Number ^RO

Crypt

This section lists the methods and properties, as well as returns (if applicable) for the Crypt class.

Function

Function	Returns
CreateObject(“Crypt”)	Crypt object

Methods

Method	Returns
FirstStep()	None
GoToStep(StepNumber)	None
LoadLibrary(LibraryFile, LibraryID)	None
NextStep()	None
Open(ProfileName)	None
SetParameter(Name,Value)	None
UpdateData(Data)	None

Properties

Property	Returns
Result	String ^RO
Verified	Boolean ^RO

Exception

This section lists the functions, methods, and properties, as well as returns (if applicable), for the exception class.

Functions

Function	Returns
CreateException(message_set, message_num, default_txt [, subslist])	Exception object
Throw Expression	None
try Protected StatementList catch QualifiedID &Id StatementList end-try	None

Methods

Method	Returns
GetSubstitution(Index)	String
Output()	String
SetSubstitution(Index, String)	None
ToString()	String

Properties

Property	Returns
Context	String ^RO
DefaultText	String
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MessageSeverity	String ^RO
StackTrace	String ^RO
SubstitutionCount	Number ^RO

Field

This section lists the functions, methods, and properties, as well as returns (if applicable), for the field class.

Function

Function	Returns
GetField([recname.fieldname])	Field object

Methods

Method	Returns
AddDropDownItem(CodeString, DescriptionString)	None
ClearDropDownList()	None
GetAuxFlag(FlagNumber)	Boolean
GetLongLabel(LabelID)	String
GetRelated(recname.fieldname)	Field object
GetShortLabel(LabelID)	String
SearchClear()	None
SetCursorPos({PAGE.pagename \| %Page})	None
SetDefault()	None

Properties

Property	Returns
DataAreaCollapsed	Boolean
DecimalPosition	Number
DisplayFormat	String
DisplayOnly	Boolean
DisplayZero	Boolean
DisplayZeroChanged	Boolean
EditError	Boolean
Enabled	Boolean
FieldLength	Number ^RO
FormatLength	Number ^RO
FormattedValue	None
IsAltKey	Boolean ^RO
IsAuditFieldAdd	Boolean ^RO
IsAuditFieldChg	Boolean ^RO
IsAuditFieldDel	Boolean ^RO
IsAutoUpdate	Boolean ^RO
IsChanged	Boolean ^RO
IsDateRangeEdit	Boolean ^RO
IsDescKey	Boolean ^RO
IsDuplKey	Boolean ^RO
IsEditTable	Boolean ^RO
IsEditXlat	Boolean ^RO
IsFromSearchField	Boolean ^RO
IsInBuf	Boolean ^RO
IsKey	Boolean ^RO
IsListItem	Boolean ^RO
IsNotUsed	Boolean ^RO
IsRequired	Boolean ^RO
IsSearchItem	Boolean ^RO
IsSystem	Boolean ^RO
IsThroughSearchField	Boolean ^RO
IsUseDefaultLabel	Boolean ^RO
IsYesNo	Boolean ^RO
Label	String
LabelImage	{Image.imagename \| String}
LongTranslateValue	Any
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
Name	String ^RO
OriginalValue	Depends on field
ParentRecord	Record Object ^RO
PromptTableName	String ^RO
SearchDefault	Boolean
SearchEdit	Boolean
SetComponentChanged	Boolean
ShortTranslateValue	Any
ShowRequiredFieldCue	Boolean
SmartZero	Boolean
SqlText	String
StoredFormat	String ^RO
Style	String
SystemIDFieldName	String ^RO
TimeStampFieldName	String ^RO
Type	String ^RO
Value	Depends on field
Visible	Boolean

File

This section lists the functions, methods, and properties, as well as returns (if applicable), for the file class.

Functions

Function	Returns
CreateDirectory(path, [, pathtype])	None
FileExists(filename [, pathtype])	Boolean
FindFiles(filespec_pattern [, pathtype])	Array object
GetFile(filename, mode [, charset] [,pathtype])	File object

Methods

Method	Returns
Close()	None
CreateRowset()	Rowset object
GetPosition()	Number
GetString([Strip_Line_Terminator])	String
Open(filename, mode [, charset] [, pathtype])	None
ReadLine(string)	Boolean
ReadRowset()	Rowset object
SetFileId(fileid, position)
SetFileLayout(FILELAYOUT.filelayoutname)	Boolean
SetPosition(position)	None
SetRecTerminator(Terminator)	None
WriteLine(string)	None
WriteRaw(RawBinary)	None
WriteRecord(record)	Boolean
WriteRowset(rowset [, Write_Data])	Boolean
WriteString(string)	None

Properties

Property	Returns
CurrentRecord	String ^RO
IgnoreInvalidId	Boolean
IsError	Boolean ^RO
IsNewFileId	Boolean ^RO
IsOpen	Boolean ^RO
Name	String ^RO

Grid and GridColumn

This section lists the functions, methods, and properties, as well as returns (if applicable), for the grid and gridcolumn classses.

Grid Functions

Function	Returns
GetGrid(PAGE.pagename, gridname [, occursnumber])	Grid object

Grid Method

Method	Returns
GetColumn(columname)^D	Grid column object

Grid Properties

Property	Returns
gridcolumnname	Grid column object
Label	String

GridColumn Properties

Property	Returns
Enabled	Boolean
Label	String
Name	String ^RO
Visible	Boolean

Integration Broker Web Service Discovery

This section lists the constructor and methods, as well as returns (if applicable), for the Integration Broker Web Service Discovery class.

Integration Broker Web Service Discovery Constructor

Constructor	Returns
WebServiceDiscovery()	WebServiceDiscovery object

Integration Broker Web Service Discovery Methods

Method	Returns
FindCIWebServices(CI_Name, Request_Node_Name, Descr)	Array of array of string
FindMsgWebServices(Msg_name, Node_name)	Array of array of string
FindWebServices()	Array or array of string
GetCIWebServiceWSDL(Service_Descr)	String
GetMsgWebServiceWSDL(Service_Descr)	String
GetWSDL(Service_Descr)	String

Internet Script

This section lists the system variables, methods, and properties, as well as returns (if applicable), for the internet script (iScript) classes.

Internet Script System Variables

System Variable	Returns
%Request	Request object
%Response	Response object

Request Methods

Method	Returns
GetContentBody()	String
GetCookieNames()	Array of string
GetCookieValue(name)	String
GetHeader(name)	String
GetHeaderNames()	Array of string
GetHelpURL(HelpContext)	String
GetParameter(name)	String
GetParameterNames()	Array of string
GetParameterValues(Name)	Array of string

Request Properties

Property	Returns
AuthTokenDomain	String ^RO
AuthType	String ^RO
BrowserPlatform	String ^RO
BrowserType	String ^RO
BrowserVersion	String ^RO
ByPassSignOn	Boolean ^RO
ContentURI	String ^RO
ExpireMeta	String ^RO
FullURI	String ^RO
HTTPMethod	String ^RO
LogoutURL	String ^RO
PathInfo	String ^RO
Protocol	String ^RO
QueryString	String ^RO
RelativeURL	String ^RO
RemoteAddr	String ^RO
RemoteHost	String ^RO
RequestURI	String ^RO
RemoteUser	String ^RO
Scheme	String ^RO
ServerName	String ^RO
ServerPort	String ^RO
ServletPath	String ^RO
Timeout	Integer ^RO

Response Methods

Method	Returns
Clear()	None
CreateCookie(name)	Cookie object
GetCookie(name)	Cookie object
GetCookieNames()	Array of string
GetHeader(name)	String
GetHeaderNames()	Array of string
GetImageURL(ImageName)	String
GetJavaScriptURL(HTML.Name)	Srting
GetStyleSheetURL(STYLESHEET.name)	String
RedirectURL(name)	None
SetContentType(Type)	None
SetHeader(name, value)	None
UseSimpleURL({True \| False})	None
Write(HTML)	None
WriteLine(HTML)	None

Response Properties

Property	Returns
Charset	String ^RO
DefaultStyleSheetName	String ^RO

Cookie Properties

Property	Returns
Domain	String
MaxAge	Number
Name	String ^RO
Path	String
Secure	Boolean
Value	String

Java

This section lists the functions for the Java class.

Functions

Function	Returns
CopyFromJavaArray(JavaArray, &PeopleCodeArray [, &RestrictionArray])	None.
CopyToJavaArray(&PeopleCodeArray, JavaArray [, &RestrictionArray])	None.
CreateJavaArray(ElementClassName[], NumberOfElements)	Java object
CreateJavaObject(ClassName [ConstructorParams])	Java object
GetJavaClass(ClassName)	Java object

Mail Classes

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Mail (MultiChannel Framework) classes.

Functions

Function	Returns
DeQueue(physical queue ID, task type, task number, agent ID)	Number
EnQueue(logical queue , task type, Relative URL, Language_Code [,subject][, agent ID][, overflow timeout][, escalation timeout][, cost][, priority][, skill level])	Number
Forward(from physical queue ID, from agent ID, task number, task type, to logical queue ID[, to agent ID])	Number
InitChat(logical queue ID, application data URL, customer username, [chat_subject][, chat_question][, wizard_URL][, priority][, skill_level] [, cost])	Number
NotifyQ(logical queue ID, task type)	Number

Constructors

Constructor	Returns
MCFBodyPart()	MCFBodyPart object
MCFGetMail()	MCFGetMail object
MCFOutboundEmail()	MCFOutboundEmail object
MCFMailStore()	MCFMailStore object
SMTPSession()	SMTPSession object

MCFBodyPart Methods

Method	Returns
AddHeader(HeaderName, HeaderValue)	None.
GetHeader(HeaderName)	String
GetHeaderCount()	Number
GetHeaderName(Index)	String
GetHeaderNames()	String
GetHeaderValues(Index)	String
GetUnparsedHeaders()	String
SetAttachmentContent({FilePath \| FileURL}, FilePathType, FileName, FileDescr, OverrideContentType, OverrideCharset)	None

MCFBodyPart Properties

Properties	Returns
AttachmentURL	String
Charset	String
ContentType	String
Description	String
Disposition	String
Filename	String
FilePath	String
FilePathType	String
IsAttachment	Boolean ^RO
MultiPart	String
Text	String

MCFEmail Properties

Properties	Returns
BCC	String
BounceTo	String
CC	String
From	String
Importance	String
Priority	Number
Recipients	String
RefIDs	String
ReplyIDs	String
ReplyTo	String
Sender	String
Sensitivity	String
Subject	String
Text	String

MCFGetMail Methods

Method	Returns
CreateQuarantineFolder ( )	Boolean
GetCount ( )	Number
GetEmailCount(user, password, server, node)	Number
ReadAllEmailHeadersWithAttach(user, password, server, node)	Rowset object
ReadEmails (Count)	String
ReadEmailsWithAttach(User, password, server, node, count)	Rowset object
ReadEmailsWithUID (UID)	Array of MCFInboundEmail objects
ReadEmailWithAttach(User, password, server, node, UID)	Rowset object
ReadHeaders ( )	Array of objects
RemoveEmail(user, password, server, node, UID list)	Boolean
RemoveEmails(UID_List)	String
SetMCFEmail (user, password, server, node)	None

MCFGetMail Properties

Properties	Returns
AttachmentRoot	String
ContentTypes	String
ErrorCount	Number ^RO
IBNode	String
MailServer	String
Password	String
QuarantineCount	Number ^RO
QuarantineFolder	String
Status	String ^RO
UserID	String

MCFInboundEmail Methods

Properties	Returns
DumpToFile (&File)	None
GetAttachments ( )	Array of objects
GetFrom ( )	Array of string
GetParts ( )	Array of objects
GetSender ( )	Array of string
ReadFromDatabase (Email_ID)	Boolean
SaveToDatabase ( )	Number

MCFInboundEmail Properties

Properties	Returns
AttachList	String
AttachSizes	String
DttmReceived	String
DttmSaved	String
DttmSent	String
IBNode	String
Language	String
MessageID	String
NotifyCC	String
NotifyTo	String
OffsetReceived	Number
OffsetSent	String
Server	String
Size	Number
Status	String ^RO
UID	String
User	String

MCFMailStore Methods

Method	Returns
AuthorizeEmailAttach(email ID, authentication name, authentication type , operation)	Boolean
DeleteEmail(email ID, [forced delete])	Boolean
RetrieveEmail(email ID)	Rowset object
StoreEmail(rowset, row)	Number

MCFMailUtil Methods

Methods	Returns
DecodeText (TextToDecode, &DecodedText)	Boolean
DecodeWord (WordToDecode, &DecodedWord)	Boolean
EncodeText (TextToEncode, charset, EncodingStyle, &EncodedText)	Boolean
EncodeWord (WordToEncode, charset, EncodingStyle, &EncodedWord)	Boolean
IsEmailServerAvailable (server, port, user, password)	Boolean
ValidateAddress (EmailAddress)	Boolean

MCFMultiPart Methods

Methods	Returns
AddBodyPart (&bodyPart)	None
GetBodyPart(Index)	MCFBodyPart object
GetContentType ( )	String
GetCount ( )	Number

MCFMultiPart Property

Property	Returns
SubType	String

MCFOutboundEmail Methods

Methods	Returns
AddAttachment({FilePath \| FileURL}, FilePathType, FileName, FileDescr, OverrideContentType, OverrideCharset)	None
AddHeader(HeaderName, HeaderValue)	None
GetHeader(HeaderName)	Array of string
GetHeaderCount ()	Integer
GetHeaderName(Index)	String
GetHeaderNames ( )	String
GetHeaderValues (Index)	String
Send ( )	Number
SetSMTPParam(ParamName, ParamValue)	None

MCFOutboundEmail Properties

Properties	Returns
BackupSMTPPort	Number
BackupSMTPServer	String
BackupSMTPUserName	String
BCC	String
BounceTo	String
CC	String
Charset	String
ContentLanguage	String
ContentType	String
DefaultCharSet	String
Description	String
Disposition	String
ErrorDescription	String ^RO
ErrorDetails	String
Filename	String
FilePath	String
FilePathType	String
Importance	String
InvalidAddresses	String ^RO
IsAuthenticationReqd	Boolean
IsOkToSendPartial	Boolean
IsReturnReceiptReqd	Boolean
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MultiPart	String
Priority	Number
Recipients	String
RefIDs	Number
ReplyIDs	Number
ReplyTo	String
ResultOfSend	Number ^RO
Sender	String
Sensitivity	String
SMTPPort	Number
SMTPServer	String
SMTPUserName	String
SMTPUserPassword	String
StatusNotifyOptions	String
StatusNotifyReturn	String
Subject	String
Text	String
TimeToWaitForResult	Number
UsedDefaultConfig	Boolean ^RO
UsedPrimaryServer	Boolean ^RO
ValidSentAddresses	String ^RO
ValidUnsentAddresses	String ^RO

SMTPSession Methods

Methods	Returns
Send(&Email)	Constant
SendAll(&Emails)	Array of numbers
SetSMTPParam(ParamName, ParamValue)	None

SMTPSession Properties

Properties	Returns
BackupPort	Number
BackupServer	String
BackupUserName	String
BackupUserPassword	String
IsAuthenticationReqd	Boolean
Port	Number
Server	String
UsedDefaultConfig	Boolean ^RO
UsedPrimaryServer	Boolean ^RO
UserName	String
UserPassword	String

Message

This section lists the functions, methods, and properties, as well as returns (if applicable), for the message class.

Message Functions

Function	Returns
AddSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)	Boolean
ConnectorRequest(&Message)	Message object
ConnectorRequestURL(ConnectorStringURL)	String
CreateMessage(MESSAGE.messagename)	Message object
CreateWSDLMessage(MessageName, ChannelName)	Boolean
DeleteSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)	Boolean
GetArchPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])	XmlDoc object
GetArchPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode[, Segment])	XmlDoc object
GetArchSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName[, Segment])	XmlDoc object
GetMessage()	Message object
GetSyncLogData(GUID, pubnode, chnlname, msg_name, logtype [, message_version])	String
InboundPublishXmlDoc(&XmlDoc, Message.MessageName, Node., PubNodeName [, Enqueue])	Boolean
IsMessageActive(Message.Message_Name)	Boolean
NodeDelete(nodeName)	Boolean
NodeRename(oldNodeName, newNodeName)	Boolean
NodeSaveAs(oldNodeName, newNodeName)	Boolean
PingNode(MsgNodeName)	Array of number
ReturnToServer({TRUE \| FALSE \| &NODE_ARRAY})	None
SetChannelStatus(ChannelName, Status)	Boolean
SetMessageStatus(Message.MessageName, Status)	Boolean

Message Methods

Method	Returns
Clone()	Message object
CopyRowset(source_rowset [, record_list])	None
CopyRowsetDelta(source_rowset [, record_list])	None
CopyRowsetDeltaOriginal(source_rowset, [, record_list])	None
CreateNextSegment()	None
DeleteSegment(Segment)	None
ExecuteEdits([editlevels])	None
GenXMLString()	String
GetQueryString(Parameter_Name)	String
GetRowset()	Rowset object
GetSegment(Segment)	None
GetXmlDoc()	XmlDoc object
InboundPublish(PubNodeName)	None.
LoadXMLString(XMLString)	None
Publish([Deferred_Mode] [, NodeName , Enqueue])	Boolean
SetEditTable(%PromptTable, RECORD.recname)	None
SetQueryString(Parameter_Name, Value)	None.
SetStatus(status)	None
SetXmlDoc(&XmlDoc)	None.
SyncRequest([NodeName])	Message object
Update([versionlist])	None
UpdateSegment(Segment)

Message Properties

Property	Returns
ChannelName	String ^RO
Cookies	String
CurrentSegment	Number ^RO
DefaultMessageVersion	String
DoNotPubToNodeName	String
GUID	String ^RO
IBInfo	IBInfo object ^RO
IsActive	Boolean ^RO
IsDelta	Boolean ^RO
IsEditError	Boolean ^RO
IsEmpty	Boolean ^RO
IsLocal	Boolean ^RO
IsStructure	Boolean ^RO
MessageDetail	String
Name	String ^RO
NRId	String ^RO
PubID	Number ^RO
PubNodeName	String ^RO
ResponseStatus	Number ^RO
SegmentCount	Number ^RO
SegmentsByDatabase	Boolean
Size	Number ^RO
SubName	String ^RO
SubscriptionProcessID	String ^RO

IntBroker Methods

Method	Returns
GetMessageErrors(Type, PubID, PubNodeName, ChannelName [,{SubNode, SegmentNumber \| MsgName, SubscriptionName, SegmentNumber}]	Array of string
GetMsgScheme(MsgName, MsgVersion)	String
MsgSchemaExists(MsgName, MsgVersion)	Boolean
SetMessageErrors(Type, PubID, PubNodeName, ChannelName, SubNode, MsgName, SubscriptionName, Segment, MsgSet, MsgNumber, Error_Location, ParmList)	Boolean
SyncRequest([&MsgArray, &NodeNames])	Array of messages

IBInfo Methods

Method	Returns
LoadConnectorProp(ConnectorName)	Boolean
LoadConnectorPropFromNode(NodeName)	Boolean
LoadConnectorPropFromTrx(NodeName, TransactionType, MsgName, MsgVersion)	Boolean

IBInfo Properties

Property	Returns
AppServerDomain	String
IBConnectorInfo	ConnectorInfo object, ^RO
ConnectorOverride	Boolean
DestinationNode	String, ^RO
ExternalMessageID	Number ^RO
FinalDestinationNode	String, ^RO
MessageChannel	String, ^RO
MessageName	String, ^RO
MessageType	String, ^RO
MessageVersion	Number, ^RO
NodeDN	String, ^RO
NonRepudiationID	String, ^RO
OrigNode	String, ^RO
OrigProcess	String, ^RO
OrigTimeStamp	String, ^RO
OrigUser	String, ^RO
PublicationID	String, ^RO
RequestingNodeName	String, ^RO
SegmentsUnOrder	Boolean
SourceNode	String, ^RO
SyncServiceTimeout	Number
TransactionID	String, ^RO
VisitedNodes	Array of string, ^RO

ConnectorInfo Collection Methods

Method	Returns
AddConnectorProperties(Name, Value, Type)	Boolean
AddQueryStringArg(Name, Value)	Boolean
ClearConnectorProperties()	None
ClearQueryStringArgs()	None
DeleteConnectorProperties(Name)	Boolean
DeleteQueryStringArg(Name)	Boolean
GetConnectorPropertiesName(Index)	String
GetConnectorPropertiesValue(Index)	String
GetNumberOf ConnectorProperties()	Number
GetNumberOfQueryStringArgs()	Number
GetQueryStringArgName(Index)	String
GetQueryStringArgValue(Index)	String

ConnectorInfo Collection Properties

Property	Returns
ConnectorClassName	String
ConnectorName	String
Cookies	String
PathInfo	String
RemoteFrameworkURL	String

Mobile

This section lists the system variable, functions, methods, and properties, as well as returns (if applicable), for the mobile classes.

Mobile System Variable

System Variable	Returns
%ThisMobileObject	Mobile object

Mobile Functions

Function	Returns
GenerateMobileTree(CIObject [,CIObject_property])	None
TransferMobilePage(MOBILEPAGE.PageName, Tab, CIObject)	None

Mobile Methods

Method	Returns
Create()	Boolean
Find()	Collection of empty mobile objects
Get()	Boolean
GetName()	String
GetParent()	Mobile object
GetPropertyAttrsByName(propertyname)	PropertyAttrs object
GetPropertyByName(propertyname)	Depends on property. Will return a collection if propertyname is a collection.
GetPropertyInfoByName(propertyname)	PropertyInfo object
GetTopParent()	Mobile object
IsNew()	Boolean
IsNewAndNeverSaved()	Boolean
IsSameAs(&MobileObject)	Boolean
ReadBlobFromFile(blobpropertyname, filename	Boolean
Save()	Boolean
SetModified(IsModified	Boolean
SetPropertyByName(propertyname)	None
ValidateEnum(propertyname)	Boolean
ValuesDifferFromLastSync()	Boolean
WasSaved()	Boolean
WriteBlobToFile(blobpropertyname, filename)	Boolean

Mobile Property

Property	Returns
PropertyInfoCollection	PropertyInfoCollection ^RO

PropertyInfo Collection Method

Method	Returns
Item(number)	PropertyInfo object

PropertyInfoCollection Property

Property	Returns
Count	Number

PropertyInfo Properties

Property	Returns
DefaultValue	Depends on the value ^RO
HasDefaultValue	Boolean ^RO
IsCollection	Boolean ^RO
IsRefToParent	Boolean ^RO
IsPeerReference	Boolean ^RO
IsSimpleApplicationProperty	Boolean ^RO
IsSystemProperty	Boolean ^RO
Name	String ^RO
PropertyInfoCollection	PropertyInfo Collection ^RO

CI Collection Method

Method	Returns
Item(index)	Mobile object

CI Collection Property

Property	Returns
Count	Number ^RO

Data Collection Methods

Method	Returns
DeleteItem(location)	Boolean
GetListAttrs(propertyname)	ListViewAttrs object
InsertItem(location)	Boolean
Item(Index)	Mobile object

Data Collection Property

Property	Returns
Count	Number ^RO

ListViewAttrs Method

Method	Returns
IsSet(attribute)	Boolean

ListViewAttrs Properties

Property	Returns
DetailViewLabel	String
Label	String
ListViewLabel	String
Visible	Boolean

PropertyAttrs Method

Method	Returns
IsSet(attribute)	Boolean

PropertyAttrs Properties

Property	Returns
DisplayOnly	Boolean
InError	Boolean
Label	String
ShowRequiredCue	Boolean
Visible	Boolean

PeerDefaultAttributes Method

Method	Returns
IsSet(attribute)	Boolean

PeerDefaultAttributes Properties

Property	Returns
DisplayOnly	Boolean
Label	String
Visible	Boolean

Notification

This section lists the constructors, methods, and properties, as well as returns (if applicable), for the Notification, NotificationAddress, NotificationTemplate and WorklistEntry classes.

Constructors

Constructors	Returns
Notification(NotifyFrom, dttmCreated, language_cd)	Notifiacation object
NotificationAddress(Oprid, Description, Language, EmailId, Channel)	NotificationAddress object
NotificationTemplate(ComponentId, Market, TemplateId, TemplateType)	NotificationTemplate object
WorkList()	Worklist object
WorklistEntry()	WorklistEntry object

Notification Method

Method	Returns
Send()	None

Notification Properties

Property	Returns
ContentType	String
dttmCreated	Datetime
EmailReplyTo	String
FileNames	Array of String
FileTitles	Array of String
language_cd	String
Message	String
NotifyBCC	Array of NotificationAddress objects
NotifyCC	Array of NotificationAddress objects
NotifyFrom	String
NotifyGuid	GUID
NotifyTo	Array of NotificationAddress objects
SourceComponent	String
SourceMarket	String
SourceMenu	String
Subject	String
Template	String

NotificationAddress Properties

Property	Returns
Channel	String
Description	String
Emailld	String
Language	String
Oprid	String

NotificationTemplate Methods

Method	Returns
GetAndExpandTemplate(Language, Vars)	Boolean
SetupCompVarsAndRcpts(&Rowset_Context)	String
SetupGenericVars(&AryValues)	String

NotificationTemplate Properties

Property	Returns
ComponentId	String
Instruction	String
Language	String
Market	String
Priority	String
Responses	String
Subject	String
TemplateId	String
TemplateType	String
Text	String

Worklist Method

Method	Returns
Reassign(FromOperid, ToOperid)	Boolean

WorklistEntry Methods

Method	Returns
Create()	Number
Reassign(Operid)	Boolean
Save()	Number
Update()	Number

WorklistEntry Properties

Property	Returns
actiondttm	Datetime
busactivity	String
buseventname	String
busprocname	String
commentshort	String
do_replicate_flag	String
instanceid	Number
instselectddttm	Datetime
inststatus	String
insttimeoutddttm	Datetime
instworkeddttm	Datetime
oprid	String
originatorid	String ^RO
prevoprid	String
syncid	Number
timedout	String
transactionid	Number
url	String
wl_priority	String
wldaystoselect	Number
wldaystowork	Number
worklistname	String

Optimization

This section lists the functions, methods, and properties, as well as returns (if applicable), for the Optimization classes.

Functions

Function	Returns
CreateOptEngine(probinst, {%Synch \| %ASynch} [, detailedstatus] [,processinstance])	OptEngine object
CreateOptInterface()	OptInterface object
DeleteOptProbInst(probinst[, detailedstatus])	Constant
GetOptEngine(probinst[, detailedstatus])	OptEngine object
GetOptProbInstList(ProblemType , OutputErrorCode [, Prefix][, detailedstatus])	Array of string
InsertOptProbInst(probinst, ProblemType[, detailedstatus] [, Description])	Constant
IsValidOptProbInst(probinst[, status])	Constant

OptEngine Methods

Method	Returns
CheckOptEngineStatus()	Number
FillRowset(PARAM_NAME, &Rowset [, functionstatus])	Constant
GetDate(PARAM_NAME[,status])	Date
GetDateArray(PARAM_NAME)	Array of Date
GetDateTime(PARAM_NAME)	DateTime
GetDateTimeArray(PARAM_NAME)	Array of Datetime
GetNumber(PARAM_NAME)	Number
GetNumberArray(PARAM_NAME)	Array of number
GetString(PARAM_NAME)	String
GetStringArray(PARAM_NAME)	Array of string
GetTime(PARAM_NAME)	Time
GetTimeArray(PARAM_NAME)	Array of Time
GetTraceLevel(component)	Constant
RunAsynch(TRANSACTION, PARM_PAIRS)	Constant
RunSynch(TRANSACTION, PARM_PAIRS)	Constant
SetTraceLevel(Component, Severity)	Constant
ShutDown()	Constant

OptEngine Properties

Property	Returns
DetailMsgs	Array of String ^RO
DetailStatus	Constant

OptBase Methods

Methods	Returns
GetParmDate(ParmName, &ParmValue)	Boolean
GetParmDateArray(ParmName, &ParmValue)	Boolean
GetParmDateTime(ParmName, &ParmValue)	Boolean
GetParmDateTimeArray(ParmName, &ParmValue)	Boolean
GetParmNumber(ParmName, &ParmValue)	Boolean
GetParmNumberArray(ParmName, &ParmValue)	Boolean
GetParmIntˋ(ParmName, &ParmValue)	Boolean
GetParmIntArray(ParmName, &ParmValue)	Boolean
GetParmString(ParmName, &ParmValue)	Boolean
GetParmStringArray(ParmName, &ParmValue)	Boolean
GetParmTime(ParmName, &ParmValue)	Boolean
GetParmTimeArray(ParmName, &ParmValue)	Boolean
Init()	Boolean
OptDeleteCallback(&record)	Boolean
OptInsertCallback(&Record)	Boolean
OptPostUpdateCallback(&OldRecord, &NewRecord)	Boolean
OptPreUpdateCallback(&OldRecord, &NewRecord)	Boolean
OptRefreshCallback()	Boolean
SetOutputParmDate(ParmName, &ParmValue)	Boolean
SetOutputParmDateArray(ParmName, &ParmValue)	Boolean
SetOutputParmDateTime(ParmName, &ParmValue)	Boolean
SetOutputParmDateTimeArray(ParmName, &ParmValue)	Boolean
SetOutputParmNumber(ParmName, &ParmValue)	Boolean
SetOutputParmNumberArray(ParmName, &ParmValue)	Boolean
SetOutputParmInt(ParmName, &ParmValue)	Boolean
SetOutputParmIntArray(ParmName, &ParmValue)	Boolean
SetOutputParmString(ParmName, &ParmValue)	Boolean
SetOutputParmStringArray(ParmName, &ParmValue)	Boolean
SetOutputParmTime(ParmName, &ParmValue)	Boolean
SetOutputTimeArray(ParmName, &ParmValue)	Boolean

OptInterface Methods

Method	Returns
ActivateModel(ModelID, SolverSettingID	Constant
ActivateObjective(Model_Name, Objective_Name)	Constant
DeactivateModel(ModelId)	Constant
DumpMsgToLog(LogSeverity, Message)	None
FindRowNum(&Record[, StartRow[, EndRow [, field_list]]]	Number
GetSolution(ModelId, varArrayId, SkipZero [, KeyFieldNames, KeyFieldValues[, Sollution]]	Constant
GetSolutionDetail(ModelId, SolutionType, Name, &Solution)	Constant
IsModelActive(ModelId)	Boolean
RestoreBounds(ModelId[, varArrayId])	Constant
SetVariableBoungs(ModelId, varArrayId,BoundType, LowerBound, UpperBound, &KeyRecord[ , ChangeModelBounds])	Constant
SetVariableType(ModelId, varArrayId, varType)	Constant
Solve(ModelId, SolutionType[, objValue[ , name-value_pairs]])	Constant

Page

This section lists the functions, methods, and properties, as well as returns (if applicable), for the page class.

Function

Function	Returns
GetPage(PAGE.pagename)	Page object

Properties

Property	Returns
CopyURLLink	Boolean
CustomizePageLink	Boolean
DisplayOnly	Boolean ^RO
HelpLink	Boolean
Name	String ^RO
NewWindowLink	Boolean
Visible	Boolean

PortalRegistry

See PortalRegistry Classes Methods and Properties.

PostReport

This section lists the functions, methods, and properties, as well as returns (if applicable), for the PostReport class.

Function

Function	Returns
SetPostReport()	PostReport object

Methods

Method	Returns
AddDistributionOption(DistIdType, DistId)	Number
Put()

Properties

Property	Returns
ExpirationDate	Date
OutDestFormat	String
ProcessInstance	Number
ProcessName	String
ProcessType	String
ReportDesc	String
ReportFolder	String
ReportId	Number
ServerName	String

ProcessRequest

This section lists the functions, methods, and properties, as well as returns (if applicable), for the ProcessRequest class and the related PrcsApi class.

ProcessRequest Functions

Function	Returns
CreateProcessRequest([ProcessType, ProcessName])	ProcessRequest object
GetNextProcessInstance([Commit])	Number
SetupScheduleDefnItem(ScheduleName, JobName)	ProcessRequest object

ProcessRequest Methods

Method	Returns
AddDistributionOption(DistIdType, DistId [, JobName] [, PrcsItemLevel] [, JobSeqNo])	Number
PrintJobHTMLRpt()	String
PrintJobRqstRpt(ProcessInstance, ItemInstance [, PrintJobTree] [, PrintDistList] [, PrintNotifyList] [, PrintSystemMessage] [, PrintApplicationMessage] [, PrintParamList])	String
PrintSchdlHTMLRpt([PrintJobTree] [, PrintDistList] [, PrintNotifyList] [, PrintMessageList] [, PrintParamList])	String
RunJobSetNow()	None
Schedule()	None
SetEmailOption(EmailSubject, EmailText, EmailAddress, EmailWebReport, EmailAttachLog [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetItemFolder(PortalFolder [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetOutputOption(OutputType, OutputFormat, OutputDest [, JobName][, PrcsItemLevel] [, JobSeqNo])	None
UpdateRunStatus()	None

ProcessRequest Properties

Property	Returns
EmailAttachLog	Boolean
EmailSubject	String
EmailText	String
EmailWebReport	Boolean
FileName	String
JobName	String
LanguageCd	String
NotifyTextMsgNum	Number
NotifyTextMsgSet	Number
OutDest	String
OutDestFormat	String
OutDestType	String
PortalFolder	String
ProcessInstance	Number
ProcessName	String
ProcessType	String
RunControlID	String
RunDateTime	DateTime
RunLocation	String
RunRecurrence	String
RunStatus	Number
Status	Number ^RO
TimeZone	String

PrcsApi Constructor

Constructor	Returns
PrcsApi()	PrcsApi object

PrcsApi Methods

Method	Returns
getAllFileNames(PrcsInstance)	Array of string
notifyToWindows(PrcsInstance, Message)	Number

Query

See Query Classes Methods and Properties.

Record

This section lists the functions, methods, and properties, as well as returns (if applicable), for the record class.

Functions

Function	Returns
CreateRecord(RECORD.recname)	Record object
GetRecord([RECORD.recname])	Record object

Methods

Method	Returns
CompareFields(RecordObject)	Boolean
CopyChangedFieldsTo(RecordObj)	None
CopyFieldsTo(RecordObject)	None
DBPatternMatch(Value, Pattern, CaseSensitive)	Boolean
Delete()	Boolean
ExecuteEdits([EditLevel])	None
GetField(n/FIELD.fieldname)^D	Field Object
Insert()	Boolean
Save([CopyToOriginal])	Boolean
SearchClear()	None
SelectByKey([UseChangedBuffers])	Boolean
SelectByKeyEffDt(Date [, UseChangedBuffers])	Boolean
SetDefault()	None
SetEditTable(%PromptField, RECORD.recname)	None
Update([KeyRecord])	Boolean

Properties

Property	Returns
FieldCount	Number ^RO
fieldname	Field Object ^RO
IsChanged	Boolean ^RO
IsDeleted	Boolean ^RO
IsEditError	Boolean ^RO
Name	String ^RO
ParentRow	Row Object ^RO
RelLangRecName	String ^RO

Row

This section lists the functions, methods, and properties, as well as returns (if applicable), for the row class.

Function

Function	Returns
GetRow()	Row object

Methods

Method	Returns
CopyTo(rowobject)	Row Object
GetNextEffRow()	Row Object
GetPriorEffRow()	Row Object
GetRecord({n \| RECORD.recname})^D	Record Object
GetRowSet({n \| SCROLL.scrollname})	Rowset Object
scrollname(n)	Row Object

Properties

Property	Returns
ChildCount	Number ^RO
DeleteEnabled	Boolean
IsChanged	Boolean ^RO
IsDeleted	Boolean ^RO
IsEditError	Boolean ^RO
IsNew	Boolean ^RO
ParentRowSet	Rowset object ^RO
recname	Record object ^RO
RecordCount	Number ^RO
RowNumber	Number ^RO
Selected	Boolean
Style	String
Visible	Boolean

Rowset

This section lists the functions, methods, and properties, as well as returns (if applicable), for the rowset class.

Functions

Function	Returns
CreateRowset({RECORD.recname \| &Rowset} [, {FIELD.fieldname, RECORD.recname \| &Rowset}] . . .)	Rowset object
GetLevel0()	Rowset object
GetRowset([SCROLL.scrollname])	Rowset object

Methods

Method	Returns
ClearDeletesChanges()	None
CopyTo(&DestRowset [, RECORD.SourceRecname, RECORD.DestRecname]. . .)	None
DeleteRow(n)	Boolean
Fill([wherestring [, bindvalue] . . .])	Number
FillAppend([wherestring [, bindvalue] . . .])	Number
Flush()	None
FlushRow(n)	None
GetCurrEffRow()	Row object
GetNewEffRow()	Row object
GetRow(n)^D	Row object
HideAllRows()	None
InsertRow(n)	Boolean
Refresh()	None
Select([parmlist], RECORD.selrecord [ , wherestr, bindvars])	Number
SelectNew([parmlist], RECORD.selrecord [, wherestr, bindvars])	Number
SetDefault(recname.fieldname)	None
ShowAllRows()	None
Sort([paramlist,] sort_fields)	None

Properties

Property	Returns
ActiveRowCount	Number ^RO
ChangeOnInit	Boolean
DataAreaCollapsed	Boolean
DBRecordName	String ^RO
DeleteEnabled	Boolean
EffDt	Date ^RO
EffSeq	Number ^RO
InsertEnabled	Boolean
IsEditError	Boolean ^RO
Level	Number ^RO
Name	String ^RO
ParentRow	Row Object ^RO
ParentRowSet	Rowset Object ^RO
RowCount	Number ^RO
SetComponentChanged	Boolean
TopRowNumber	Number ^RO

RowsetCache

This section lists the functions, methods, and properties, as well as the returns (if applicable) for the RowsetCache class.

Functions

Function	Returns
CreateRowsetCache(&Rowset, [Rowset.]Name, Description)	RowsetCache object
GetRowsetCache(([Rowset.]name)	RowsetCache object

Methods

Method	Returns
Delete()	Boolean
Get()	Rowset object
Save([[Rowset.]name] [, Description])	Boolean

Properties

Property	Returns
Content	Rowset object
Description	String

Search

See Search Classes Methods and Properties.

Session

See Session Classes.

SOAPDoc

This section lists the functions, methods, and properties, as well as returns (if applicable), for the SOAPDoc class.

Function

Function	Returns
CreateSOAPDoc()	SOAPDoc object

Methods

Method	Returns
AddBody()	None
AddEnvelope(SOAP_Schema)	None
AddFault(Fault_Code, Fault_String)	None
AddHeader()	None
AddMethod(MethodName, IsRequest)	None
AddParm(ParmName, ParmValue)	None
GetParmName(Index)	String
GetParmValue(Index)	String
ValidateSOAPDoc([1])	String

Properties

Property	Returns
BodyNode	XmlNode object ^RO
EnvelopeNode	XmlNode object ^RO
FaultCode	Number ^RO
FaultCodeS	String ^RO
FaultString	String ^RO
HeaderNode	XmlNode object ^RO
MethodName	String ^RO
MethodNode	XmlNode object ^RO
ParmCount	Number ^RO
XmlDoc	XmlDoc object

SQL

This section lists the functions, methods, and properties, as well as returns (if applicable), for the SQL class.

Functions

Function	Returns
CreateSQL([{sqlstring\| SQL.SqlName} [, paramlist]])	None
DeleteSQL([SQL.]sqlname [ , dbtype [ , effdt]]] )	Boolean
FetchSQL([SQL.]sqlname [ , dbtype [ , effdt ]] )	String
GetSQL(SQL.sqlname [, paramlist])	SQL object
StoreSQL(sqlstring, [SQL.]sqlname [ , dbtype [ , effdt [, ownerId [ , Description]]]] )	None

Methods

Method	Returns
Close()	Boolean
Execute(paramlist)	Boolean
Fetch(paramlist)	Boolean
Open(sql [, paramlist])	None

Properties

Property	Returns
BulkMode	Boolean
IsOpen	Boolean ^RO
LTrim	Boolean
ReuseCursor	Boolean
RowsAffected	Number ^RO
Status	Number ^RO
TraceName	String
Value	String ^RO

SyncServer

This section lists the functions, methods, and properties, as well as returns (if applicable), for the SyncServer class.

System Variable

System Variable	Returns
%SyncServer	SyncServer object

Methods

Method	Returns
AddReference(SyncID[, CIDefnName])	None
AddReferenceType(CIDefnName)	None
CheckForChanges(SyncDateTime, TotalRowCount[, HasRefList])	Boolean
SelectAll()	None

Properties

Property	Returns
ClientPlatform	String
ConflictAlgorithm	String
ConflictStatus	String
ExcludeProperty	String
ExportLocation	String
LasySyncDateTime	DateTime, ^R
LastSyncRowCount	Number, ^R
PropertyValue	String
SessionID	String ^RO
Synchronizing	String
SyncIDs	Array of number
TypeID	String
validateID	String
validateRowCount	Number ^RO
validateVersion	String

TransformData

This section lists the functions, methods, and properties, as well as returns (if applicable), for the TransformData class.

System Variable

System Variable	Returns
%TransformData	TransformData object

Properties

Property	Returns
DestMsgName	String ^RO
DestMsgVersion	String ^RO
DestMsgVersion	String ^RO
DestNode	String ^RO
SourceMsgName	String ^RO
SourceMsgVersion	String ^RO
SourceNode	String ^RO
Status	Number
XmlDoc	XmlDoc object

Tree

See Tree Classes Methods and Properties.

Universal Queue

This section lists the constructors, methods, and properties, as well as returns (if applicable), for the universal queue classes.

Universal Queue Constructors

Constructor	Returns
Agent(AgentID)	Agent object
AgentPhysQueueProps()	Agent physical queue properties object
AgentPhysQueueTasks(PhysicalQueueID, AgentID)	Agent physical queue tasks object
LogicalQueue(LogicalQueueID)	Logical queue object
MCFFactory([MAX_TASKLIST_ITEMS])	MCFFactory object
PhysicalQueue(PhysicalQueueID)	Physical queue object
Task(TaskNumber)	Task object
TaskList(Status, TaskType, [PhysicalQueueID[, AgentID]])	Task list object
Util()	Util object

Agent Methods

Method	Returns
Delete()	Number
Refresh()	None
RefreshQTaskList(PhysQ)	None

Agent Properties

Properties	Returns
AgentID	String ^RO
AgentProps	AgentPhysQueueProps object ^RO
AgentTasks	AgentPhysQueueTask object ^RO
Buddy	Array of string ^RO
Language	Array of string ^RO
Name	String ^RO
Nickname	String ^RO
PhysicalQueueID	Array of string ^RO
TotalPhysicalQueues	Number ^RO

AgentPhysQueueProps Properties

Property	Returns
AgentID	String ^RO
PhysicalQueueID	String ^RO
SkillLevel	String ^RO
WorkLoad	Number ^RO

AgentPhysQueueTasks Method

Method	Returns
Refresh(TaskList)	None.

AgentPhysQueueTasks Properties

Property	Returns
AcceptedTaskList	Task list object ^RO
AssignedTaskList	Task list object ^RO
PhysicalQueueID	String ^RO

LogicalQueue Properties

Property	Returns
LogicalQueueID	String ^RO
PhysicalQueueID	Array of PhysicalQueue objects ^RO

MCFFactory Property

Property	Returns
LogicalQueue	Array of LogicalQueue objects ^RO

PhysicalQueue Methods

Method	Returns
Refresh()	None
RefreshTaskList(TaskList)	None.

PhysicalQueue Properties

Property	Returns
AcceptedTaskList	Task list object ^RO
AssignedTaskList	Task list object ^RO
Agent	Array of agent objects ^RO
BrowserURL	String ^RO
EnqueuedTaskList	Task list object ^RO
EscalatedTaskList	Task list object ^RO
InternalURL	String ^RO
IsActive	Boolean ^RO
LogicalQueueID	String ^RO
OverflowedTaskList	Task list object ^RO
PhysicalQueueID	String ^RO
RENURLID	String ^RO
TotalAgents	Number ^RO

Task Methods

Method	Returns
Close(Comment)	None
Enqueue(LogicalQueueID,AgentID, Timeout, ResponseTime, Cost, Priority, MinSkill)	None.
Refresh()	None
RefreshStatus()	None

Task Properties

Property	Returns
AgentID	String ^RO
ApplicationData	String ^RO
Comments	String
EnqueueTime	Datetime ^RO
EscalationTime	Datetime ^RO
Language	String ^RO
OriginalTime	Datetime ^RO
OverflowTime	Datetime ^RO
PhysicalQueueID	String ^RO
TiedAgentID	String ^RO

TaskList Method

Method	Returns
Refresh()	None

TaskList Properties

Properties	Returns
AgentID	String ^RO
PhysicalQueueID	String ^RO
Task	Array of tasks ^RO
TaskType	String ^RO
Total	Number ^RO

XmlDoc

This section lists the functions, methods, and properties, as well as returns (if applicable), for the XmlDoc and XmlNode classes.

XmlDoc Functions

Function	Returns
CancelPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName)	Boolean
CancelPubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubNode[, Segment])	Boolean
CancelSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName, SubscriptionName[, Segment])	Boolean
CreateXmlDoc(XmlString)	XmlDoc object
GetMessageXmlDoc()	XmlDoc object
GetNRXmlDoc(NRID, NodeName)	XmlDoc object
GetPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName[, Segment])	XmlDoc object
GetPubXmlDoc(PubID ,PubNode, ChannelName ,VersionName ,MessageName,SubNode[, Segment])	XmlDoc object
GetSubXmlDoc(PubID, PubNode, ChannelName, VersionName, MessageName[, Segment])	XmlDoc object
PublishXmlDoc(&XmlDoc, Message. MessageName [, Node. NodeName])	Boolean
ReSubmitPubHeaderXmlDoc(PubID, PubNode, ChannelName, VersionName)	Boolean
ReSubmitPubXmlDoc(PubID, PubNode, ChannelName ,VersionName,MessageName, SubNode[, Segment])	Boolean
ReSubmitSubXmlDoc(PubID , PubNode , ChannelName , VersionNam,,MessageName , SubscriptionName[, Segment])	Boolean
RevalidateNRXmlDoc(NRID, EntityName	Boolean
SyncRequestXmlDoc(&XmlDoc, Message. MessageName [, Node. NodeName])	XmlDoc object
Transform(Input, AE_Program_Name, Initial_Node_Name, Initial_Message__Name, Initial_Message_Version, Result_Node_Name, Result_Message_Name, Result_Message_Version)	XmlDoc object
TransformEx(XmlString, XsltString)	String
UpdateXmlDoc(&XmlDoc, PubID, PubNode, ChannelName, VersionName [, Message Name [, SubNode[, Segment]]])	Boolean

XmlDoc Methods

Method	Returns
CopyRowset(&InRowset[, MessageName ] [, MessageVersion])	Boolean
CopyToPSFTMessage(targetDoc, srcPath, targetPath)	Number
CopyToRowset(&InRowset[, Message_Name][, Message_Version])	Boolean
CreateDocumentElement(TagName [, NamespaceURI ] [, &DocType])	XmlNode object
CreateDocumentType(Name, PublicID, SystemID)	String
GenFormattedXmlString()	String
GenXmlString()	String
GenFormattedXmlString()	String
GetElementsByTagName(TagName)	Array of XmlNode objects
LoadIBContent(Content[, RootTagName])	Boolean
ParseXmlFromURL(path)	Boolean
ParseXmlString(XmlString)	Boolean

XmlDoc Properties

Property	Returns
DocumentElement	XmlNode object ^RO
IsNull	Boolean ^RO

XmlNode Methods

Method	Returns
AddAttribute(Name, Value)	None
AddAttributeNS(NamespaceURI, AttributeName, Value)	None
AddCDataSection(Data)	XmlNode object
AddComment(Text)	XmlNode object
AddElement(TagName)	XmlNode object
AddElementNS(NameSpaceURI, TagName)	XmlNode object
AddEntityReference(Name)	XmlNode object
AddNode(XmlNode)	XmlNode object
AddProcessInstruction(Target, Data)	XmlNode object
AddText(Data)	XmlNode object
CopyNode(Node)	None
FindNode(Path)	XmlNode object
FindNodes(Path)	Array of XmlNode objects
GenXmlString()	String
GetAttributeName(index)	String
GetAttributeValue({Name \| Index})	String
GetCDataValue()	String
GetCDataValues()	Array of string
GetChildNode(index)	XmlNode object
GetElement()	XmlNode object
GetElements()	Array of XmlNode objects
GetElementsByTagName(TagName)	Array of XmlNode objects
GetElementsByTagNameNS(NamespaceURI, TagName)	Array of XmlNode objects
InsertCDataSection(Data, Position)	XmlNode object
InsertComment(Data, Position)	XmlNode object
InsertElement(TagName, Position)	XmlNode object
InsertElementNS(NameSpaceURI, TagName, Position)	XmlNode object
InsertEntityReference(Name, Position)	XmlNode object
InsertNode(&NewNode, {&RefNode \| Position})	XmlNode object
InsertProcessInstruction(Target, Data, Position)	XmlNode object
InsertText(Data, Position)	XmlNode object
RemoveAllChildNode()	None
RemoveChildNode({Position \| Node})	XmlNode object

XmlNode Properties

Property	Returns
AttributesCount	Number ^RO
ChildNodeCount	Number ^RO
Index	Number ^RO
IsNull	Boolean ^RO
LocalName	String ^RO
NamespaceURI	String ^RO
NextSibling	XmlNode object ^RO
NodeName	String
NodePath	String ^RO
NodeType	String ^RO
NodeValue	String
ParentNode	XmlNode object ^RO
Prefix	String ^RO
PreviousSibling	XmlNode object ^RO

Session Classes

This section lists:

Session classes methods and properties
Component interface classes methods and properties
Search classes methods and properties
PortalRegistry classes methods and properties
Query classes methods and properties
Tree classes methods and properties

Session Classes Methods and Properties

A session object controls access to the PeopleSoft APIs as well as the environment in which they run. This section only lists the system variable, methods, and properties, as well as returns (if applicable), for the session class and the associated classes used for controlling the environment. The properties, methods, and so of the API objects (query classes, tree classes, and so on) are detailed in separate sections.

Session System Variable

System Variable	Returns
%Session	Session object

Session Methods

Method	Returns
AdvancedSearchQueries(GetFavorites, QueryName, QueryNameOp, Descr, DescrOp, FolderName, FolderNameOp, RecordName, RecordNameOp, FieldName, FieldNameOp, TreeName, TreeNameOp, QueryType, OwnerType, CaseSensitive)	Query collection
AdvancedSearchRecords(RecordName, RecordNameOp, Descr, DescrOp, FieldName, FieldNameOp, TreeName, TreeNameOp, CaseSensitive)	QueryDBRecord collection
FindCompIntfcs(partial_name)	Component Interface collection
FindPortalRegistries(partial_name)	PortalRegistry collection
FindQueryDBRecords()	QueryDBRecord collection
FindQueries()	Query collection
FindQueriesDateRange(StartDateString, EndDateString)	Query collection
GetCompIntfc([CompIntfc.]name)	Component Interface object
GetLocalNode()	Node object
GetNodes()	Node collection
GetPortalRegistry()	PortalRegistry object
GetQuery()	Query object
GetQuerySecurityProfile()	QuerySecurityProfile object
GetRemoteNodes()	Node collection
GetSearchIndexes()	SearchIndexes collection
GetSearchQuery()	SearchQuery object
GetTree()	Tree object
GetTreeStructure()	Tree structure
SearchQueryDBRecord(SearchType, Pattern, CaseSensitive):	QueryDBRecord collection
SearchPrivateQueries(QueryType, SearchType, Pattern, CaseSensitive)	Query collection
SearchPublicQueries(QueryType, SearchType, Pattern, CaseSensitive)	Query collection

Session Properties

Property	Returns
ErrorPending	Boolean ^RO
PSMessages	PSMessage collection object
PSMessageMode	Number
RegionalSettings	Regional settings object
Repository	API Repository object
SuspendFormating	Boolean
TraceSettings	Trace settings object
WarningPending	Boolean ^RO

PSMessage Collection

Method	Returns
DeleteAll()	Boolean
DeleteItem(number)	Boolean
First()	PSMessage object
Item(number)	PSMessage object
Next()	PSMessage object

PSMessage Collection Property

Property	Returns
Count	Number ^RO

PSMessage Properties

Property	Returns
ExplainText	String ^RO
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
Source	String ^RO
Text	String ^RO

RegionalSettings Properties

Property	Returns
ClientTimeZone	String
CurrencyFormat	Number
CurrencySymbol	String
DateFormat	Number
DateSeparator	String
DecimalSymbol	String
DigitGroupingSymbol	String
LanguageCD	String
UseLocalTime	Boolean
1159Separator	String
2359Separator	String

TraceSettings Properties

Property	Returns
API	Boolean
COBOLStmtTimings	Boolean
ConDisRollbackCommit	Boolean
DBSpecificCalls	Boolean
ManagerInfo	Boolean
NetworkServices	Boolean
NonSSBs	Boolean
OutputUNICODE	Boolean
PCExtFcnCalls	Boolean
PCFcnReturnValues	Boolean
PCFetchedValues	Boolean
PCIntFcnCalls	Boolean
PCListProgram	Boolean
PCParameterValues	Boolean
PCProgramStatements	Boolean
PCStack	Boolean
PCStartOfPrograms	Boolean
PCTraceProgram	Boolean
PCVariableAssignments	Boolean
RowFetch	Boolean
SQLStatement	Boolean
SQLStatementVariables	Boolean
SSBs	Boolean
SybBindInfo	Boolean
SybFetchInfo	Boolean
TraceFile	String

API Repository Classes Methods and Properties

This section lists the method, properties, as well as the returns (if applicable) for the API Repository classes.

Repository Properties

Property	Returns
Bindings	Bindings collection object ^RO
NameSpaces	Namespaces collection ^RO

Bindings Collection Property

Property	Returns
Count	Number ^RO

Bindings Collections Method

Method	Returns
Item(number)	Binding object

Bindings Property

Property	Returns
Name	String ^RO

Namespaces Collection Property

Property	Returns
Count	String ^RO

Namespaces Collection Methods

Method	Returns
Item(Number)	Namespaces object
ItemByName(Name)	Namespaces object

Namespaces Properties

Property	Returns
Classes	ClassInfo object ^RO
Name	String ^RO

ClassInfo Collection Property

Property	Returns
Count	Number ^RO

ClassInfo Collection Methods

Method	Returns
Item(Number)	ClassInfo object
ItemByName(Name)	ClassInfo object

ClassInfo Properties

Property	Returns
Documentation	String ^RO
Methods	MethodInfo collection object ^RO
Name	String ^RO
Properties	PropertyInfo collection object ^RO

MethodInfo Collection Property

Property	Returns
Count	String ^RO

MethodInfo Collection Methods

Method	Returns
Item(Number)	MethodInfo object
ItemByName(Name)	MethodInfo object

MethodInfo Properties

Property	Returns
Arguments	PropertyInfo collection object ^RO
Documentation	String ^RO
Name	String ^RO
Type	String ^RO

PropertyInfo Collection Properties

Property	Returns
Count	String ^RO

PropertyInfo Collection Methods

Method	Returns
Item(Number)	PropertyInfo object
ItemByName(Name)	PropertyInfo object

PropertyInfo Properties

Property	Returns
Documentation	String ^RO
Name	String ^RO
Type	String ^RO
Usage	Number ^RO

Component Interface Class Methods and Properties

This section lists the methods and properties, as well as returns (if applicable), for the component interface classes.

Component Interface Collection Methods

Method	Returns
First()	Component Interface structure (no data)
Item(number)	Component Interface structure (no data)
Next()	Component Interface structure (no data)

Component Interface Collection Property

Property	Retuns
Count	Number ^RO

Component Interface Methods

Method	Returns
Cancel()	Boolean
CopyRowset(&rowset [,IntialRow] [, record_list])	None
CopyRowsetDelta(&rowsetI, [,IntialRow] [, record_list])	None
CopySetupRowset(&rowset [,IntialRow] [, record_list])	None
CopySetupRowsetDelta(&rowsetI, [,IntialRow] [, record_list])	None
Create()	Component Interface with data
Find()	Component Interface collection
Get()	Component Interface with data
GetPropertyByName(string)	Depends on property
Save()	Boolean
SetPropertyByName(string, value)	None

Component Interface Properties

Property	Returns
ComponentName	String ^RO
CreateKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
FindKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
GetDummyRows	Boolean
GetHistoryItems	Boolean
GetKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
InteractiveMode	Boolean
PropertyInfoCollection	Component InterfacePropertyInfo collection object ^RO
StopOnFirstError	Boolean
Every user-defined property in a component interface definition can be used like a property on the instantiated object.	Depends on property

CompIntfPropInfo Collection Methods

Method	Returns
First()	Component InterfacePropertyInfo object
Item(number)	Component InterfacePropertyInfo object
Next()	Component InterfacePropertyInfo object

CompIntfPropInfo Collection Property

Property	Returns
Count	Number ^RO

CompIntfPropInfo Properties

Property	Returns
Format	String ^RO
IsCollection	Boolean ^RO
IsReadOnly	Boolean ^RO
Key	Boolean ^RO
LabelLong	String ^RO
LabelShort	String ^RO
Length	Number ^RO
Name	String ^RO
Prompt	Boolean ^RO
PropertyInfoCollection	Component InterfacePropertyInfo collection object
Required	Boolean ^RO
Type	String ^RO
Xlat	Boolean ^RO
YesNo	Boolean ^RO

Data Collection Methods

Method	Returns
CurrentItem()	Data collection item
DeleteItem(number)	None
GetEffectiveItem(DateString, SeqNo)	Data collection item
GetEffectiveItemNum(DateString, SeqNo)	Number
InsertItem(number)	Data collection item
Item(number)	Data collection item
ItemByKeys(key_values)	Data collection item

Data Collection Properties

Property	Returns
Count	Number ^RO
CurrentItemNumber	Number ^RO

Search Classes Methods and Properties

This section lists the methods and properties, as well as returns (if applicable), for the search classes.

Note. Search class objects are instantiated from both the session and PortalRegisty objects.

SearchQuery Methods

Method	Returns
Execute(Start, Size)	SearchResult collection
Parse()	ParseResult collection

SearchQuery Properties

Property	Returns
HitCount	Number ^RO
Indexes	String
KnowledgeBase	String
Language	String
ProcessedCount	Number ^RO
QueryText	String
RequestedFields	String
ScorePrecision	String
SortSpecifications	String

ParseResult Collection Methods

Method	Returns
First()	ParseResult object
Next()	ParseResult object or Null

ParseResult Collection Properties

Property	Returns
ErrorCount	Number ^RO
WarningCount	Number ^RO

ParseResult Properties

Property	Returns
Message	String ^RO
Severity	String ^RO

SearchResult Collection Methods

Method	Returns
First()	SearchResult
Item(number)	SearchResult
Next()	SearchResult

SearchResult Collection Property

Property	Returns
Count	Number ^RO

SearchResult Properties

Property	Returns
Key	String ^RO
Score	String ^RO
ScoreAsNumber	Floating point number ^RO
SearchFields	SearchField collection ^RO

SearchField Collection Methods

Method	Returns
First()	SearchField
ItemByName(Name)	SearchField
Next()	SearchField

SearchField Collection Property

Property	Returns
Count	Number ^RO

SearchField Properties

Property	Returns
Name	String ^RO
Value	String ^RO

SearchIndexes Collection Methods

Method	Returns
First()	SearchIndex object
ItemByName(Name)	SearchIndex object
Next()	SearchIndex object

SearchIndexes Collection Property

Property	Returns
Count	Number ^RO

SearchIndex Method

Method	Returns
Save()	Boolean

SearchIndex Properties

Property	Returns
ExtraOptions	Any
FSOpts	Search FS Options object ^RO
HTTPOpts	Search HTTP Options object ^RO
Languages	Search Language collection ^RO
Location	String
Name	String ^RO
RecOpts	SearchRecord Options collection ^RO
Schedules	Search Schedule collection ^RO
Type	String

SearchRecord Options Properties

Property	Returns
Fields	SearchRecordField collection ^RO
Filter	String
IncrementalView	String
RecName	String ^RO
VeggieKey	String
ZoneOptions	String

SearchRecordField Collection Methods

Method	Returns
DeleteItem(Record, Field)	Boolean
First()	SearchRecordField object
InsertItem(Record, Field)	SearchRecordField object
ItemByName(Record, Field)	SearchRecordField object
Next()	SearchRecordField object

SearchRecordField Collection Property

Property	Returns
Count	Number ^RO

SearchRecordField Properties

Property	Returns
FieldName	String ^RO
IsAttachment	Boolean
IsVerityField	Boolean
IsWordIndex	Boolean
RecordName	String ^RO

SearchLanguage Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Search Language object
InsertItem(LanguageCode, MapLanguageCode)	Search Language object
ItemByName(LanguageCode)	Search Language object
Next()	Search Language object

SearchLanguage Collection Property

Property	Returns
Count	Number ^RO

SearchLanguage Properties

Property	Returns
LanguageCd	String ^RO
MapLanguageCd	String ^RO

SearchSchedule Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Search Schedule object
InsertItem(RunCntrlID)	Search Schedule object
ItemByName(RunCntrlID)	Search Schedule object
Next()	Search Schedule object

SearchSchedule Collection Property

Property	Returns
Count	Number ^RO

SearchSchedule Properties

Property	Returns
BuildType	String
RunCntrID	String ^RO
RunRecurrance	String
ServerName	String

SearchHTTPOptions Properties

Property	Returns
AllowHTTPS	Boolean
DomainLimit	String
GlobList	String
GlobListType	String
LinkDepth	Number
MIMEList	String
MIMEListType	String
ProxyHost	String
ProxyPort	Number
StartOpts	Search Start Options collection ^RO

SearchFSOptions Properties

Property	Returns
GlobList	String
GlobListType	String
MIMEList	String
MIMEListType	String
StartOpts	Search Start Options collection ^RO

SearchStartOptions Collection Methods

Method	Returns
DeleteItem(Value)	Boolean
First()	Search Start Options object
InsertItem(Value)	Search Start Options object
ItemByName(Value)	Search Start Options object
Next()	Search Start Options object

SearchStartOptions Collection Property

Property	Returns
Count	Number ^RO

SearchStartOptions Properties

Property	Returns
IsDomainRestricted	Boolean
IsHostRestricted	Boolean
Value	String ^RO

PortalRegistry Classes Methods and Properties

This section lists the methods, and properties, as well as returns (if applicable), for the PortalRegistry classes.

PortalRegistry Methods

Method	Returns
BuildSearchIndex(Language)	Boolean
Close()	Boolean
CopyObject(sourcePortalName, sourceRefType, sourceObjName, targetPortalName, targetPrntFldrName, copyChildren)	Boolean
Create(RegistryName)	Boolean
CreateContentRefLink(LinkName, LinkLabel, LinkParent, CRefPortalName, CRefObjectName)	CRefLink object
CreateRemote(PortalName, RemoteNodeName)	Boolean
Delete(RegistryName)	Boolean
DeleteHomepage()	Boolean
FindCRefByName(Name)	ContentReference object
FindCRefByURL(URL)	ContentReference object
FindCrefForURL(URL)	ContentReference object
FindCRefLinkByName(LinkName)	Content Reference Link object
FindFolderByName(Name)	Folder object
FindPgltByName(PageletName)	Pagelet object
GetAbsoluteContentURL(NodeName, URL)	ContentReference object
GetDefaultHPTabOID()	String
GetQualifiedURL(ContentProvider, RelativeURL)	URL string
GetSearchQuery()	SearchQuery object
GrantPermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)	Boolean
GrantPermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)	Boolean
Open(RegistryName)	Boolean
PermissionListDelete(PermListName)	Boolean
PermissionListSaveAs(PermListSourceName, PermListTargetName)	Boolean
RevokePermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)	Boolean
RevokePermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)	Boolean
Save()	Boolean

PortalRegistry Properties

Property	Returns
DefaultTemplate	String
Description	String
DisableFolderNavigation	Boolean
Favorites	Favorite Collection ^RO
FolderNavObject	String
Homepage	Homepage object ^RO
IsFolderNavigation	Booldan
Name	String ^RO
NodeTemplates	NodeTemplate Collection ^RO
OwnerId	String
PageletCategories	PageletCategories Collection ^RO
Portals	Portal collection ^RO
RootFolder	Folder object ^RO
TabDefinitions	TabDefinitions Collection ^RO
TemplateObject	ContentReference object ^RO

PortalRegistry Collection Methods

Method	Returns
First()	PortalRegistry object
Item(number)	PortalRegistry object
Next()	PortalRegistry object

PortalRegistry Property

Property	Returns
Count	Number ^RO

Node Properties

Property	Returns
ActiveNode	Boolean ^RO
AppRelease	String ^RO
ContentURI	String ^RO
DefaultPortalName	String ^RO
Description	String ^RO
Name	String ^RO
NodePassword	String ^RO
NodeType	String ^RO
PortalURI	String ^RO
ToolsRelease	String ^RO

Node Collection Methods

Method	Returns
First()	Node object
ItemByName(NodeName)	Node object
Next()	Node object

Node Collection Property

Property	Returns
Count	Number ^RO

Remote Node Collection Methods

Method	Returns
First()	Node object
ItemByName(NodeName)	Node object
Next()	Node object

Remote Node Collection Property

Property	Returns
Count	Number ^RO

Portal Method

Method	Returns
Save()	Boolean

Portal Properties

Property	Returns
HostNodeName	String
IsLocal	Boolean ^RO
Name	String ^RO

Portal Collection Methods

Method	Returns
First()	Portal object
ItemByName(PortalName)	Portal object
Next()	Portal object

Portal Collection Property

Property	Returns
Count	Number ^RO

Node Template Properties

Property	Returns
DefaultTemplate	String
Name	String
TemplateObject	Template object ^RO

Node Template Collection Methods

Method	Returns
DeleteItem(NodeName)	Boolean
First()	NodeTemplate object
InsertItem(NodeName)	NodeTemplate object
ItemByName(NodeName)	NodeTemplate object
Next()	NodeTemplate Object

Node Template Collection Property

Property	Returns
Count	Number ^RO

Folder Method

Method	Returns
Save()	Boolean

Folder Properties

Property	Returns
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionValue collection ^RO
CascadedRolePermissions	RolePermissionValue collection ^RO
ContentRefs	ContentReference Collection ^RO
CreationDate	String ^RO
Description	String
Folders	Folder collection ^RO
IsMobile	Boolean
IsVisible	Boolean ^RO
Label	String
Name	String ^RO
OwnerID	String
ParentName	String ^RO
Path	String ^RO
Permissions	PermissionValue collection ^RO
Product	String
RolePermissions	RolePermissionValue collection ^RO
SequenceNumber	Number
PublicAccess	Boolean
ValidFrom	String
ValidTo	String

Folder Collection Methods

Method	Returns
DeleteItem(FolderName)	Boolean
First()	Folder object
InsertItem(FolderName, Label)	Folder object
ItemByName(FolderName)	Folder object
Next()	Folder object

Folder Collection Property

Property	Returns
Count	Number ^RO

ContentReference Methods

Methods	Returns
CreateLink(Name, Label)	Content Reference Link object
Save()	Boolean

ContentReference Properties

Property	Returns
AbsoluteContentURL	String ^RO
AbsolutePortalURL	String ^RO
AssignedPagelets	AssignedPagelets collection ^RO
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionValue collection ^RO
CascadedRolePermissions	RolePermissionValue collection ^RO
ContentProvider	String
CreationDate	String ^RO
Data	String
Description	String
HtmlText	String ^RO
IsMobile	Boolean
IsVisible	Boolean ^RO
Label	String
Links	Link collection ^RO
Name	String ^RO
OwnerId	String
ParentName	String ^RO
Path	String ^RO
Permissions	PermissionValue collection ^RO
Product	String
PublicAccess	Boolean
RelativeURL	String ^RO
RolePermissions	RolePermissionValue collection ^RO
SequenceNumber	Number
StorageType	String
Template	String
TemplateObject	ContentReference object ^RO
TemplateType	String
URL	String
URLType	String
UsageType	String
ValidFrom	String
ValidTo	String

ContentReference Collection Methods

Method	Returns
DeleteItem(ContentReferenceName)	Boolean
First()	ContentReference object
InsertItem(ContentReferenceName, ContentReferenceLabel, Node, URL)	ContentReference object
ItemByName(ContentReferenceName)	ContentReference object
Next()	ContentReference object

ContentReference Collection Property

Property	Returns
Count	Number ^RO

AttributeValue Properties

Property	Returns
Label	String
Name	String ^RO
Translatable	Boolean
Value	String

AttributeValue Collection Methods

Method	Returns
DeleteItem(AttributeValueName)	Boolean
First()	AttributeValue object
InsertItem(AttributeValueName)	AttributeValue object
ItemByName(AttributeValueName)	AttributeValue object
Next()	AttributeValue object

AttributeValue Collection Property

Property	Returns
Count	Number ^RO

PermissionValue Properties

Property	Returns
Cascade	Boolean
Name	String

PermissionValue Collection Methods

Method	Returns
DeleteItem(PermissionValueName)	Boolean
First()	PermissionValue object
InsertItem(PermissionValueName)	PermissionValue object
ItemByName(PermissionValueName)	PermissionValue object
Next()	PermissionValue object

PermissionValue Collection Property

Property	Returns
Count	Number ^RO

RolePermissionValue Collection Methods

Method	Returns
DeleteItem(PermissionValueName)	Boolean
First()	PermissionValue object
InsertItem(PermissionValueName)	PermissionValue object
ItemByName(PermissionValueName)	PermissionValue object
Next()	PermissionValue object

RolePermissionValue Collection Property

Property	Returns
Count	Number ^RO

ContentReference Link Methods

Method	Returns
Delete()	Boolean
Save()	Boolean

Content Reference Link Properties

Property	Returns
AbsoluteContentURL	String ^RO
AbsolutePortalURL	String ^RO
Attributes	Attribute Collection
Author	String ^RO
AuthorAccess	Boolean ^RO
Authorized	Boolean ^RO
CascadedPermissions	PermissionValue collection ^RO
ContentProvider	String ^RO
CreationDate	String ^RO
Data	String
Description	String
IsMobile	Boolean
IsVisible	Boolean ^RO
Label	String
Name	String
OwnerId	String
ParentName	String
Path	String ^RO
Permissions	PermissionValue Collection ^RO
Product	String
PublicAccess	Boolean ^RO
RelativeURL	String ^RO
SequenceNumber	String
Template	String
TemplateObject	String ^RO
TemplateType	String
URL	String
URLType	String ^RO
ValidFrom	Date
ValidTo	Date

Link Collection Methods

Method	Returns
First	Link object
Next	Link object

Link Collection Property

Property	Returns
Count	Number ^RO

Link Class Properties

Property	Returns
LinksObjectName	String ^RO
LinksObjectType	String ^RO
LinksPortalName	String ^RO

TabDefinition Method

Method	Returns
Save()	Boolean

TabDefinition Properties

Property	Returns
AssignedPagelets	AssignedPagelets collection ^RO
AvailableCategories	AvailableCategories collection ^RO
AvailablePagelets	AvailablePagelets collection ^RO
Attributes	AttributeValue collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
ColumnLayout	String
CreationDate	String ^RO
Description	String
DynamicCategories	DynamicCategories collection ^RO
HelpID	String
HtmlText	String ^RO
IsHideActionBar	Boolean
IsLayoutLocked	Boolean
IsRenamable	Boolean
Label	String
LayoutBehavior	String
Name	String ^RO
OwnerId	String
Product	String
PublicAccess	Boolean
QualifiedURL	String ^RO
SequenceNumber	Number
StyleSheet	String
ValidFrom	String
ValidTo	String

TabDefinition Collection Methods

Method	Returns
DeleteItem(TabDefinitionName)	Boolean
First()	TabDefinition object
InsertItem(TabDefinitionName)	TabDefinition object
ItemByName(TabDefinitionName)	TabDefinition object
Next()	TabDefinition object

TabDefinition Collection Property

Property	Returns
Count	Number ^RO

AssignedPagelet Properties

Property	Returns
Column	Number
LayoutBehavior	String
PageletName	String ^RO
Row	Number

AssignedPagelet Collection Methods

Method	Returns
DeleteItem(PageletName)	Boolean
First()	Pagelet object
InsertItem(PageletName, Column, Row, LayoutBehavior)	Pagelet object
ItemByName(PageletName)	Pagelet object
Next()	Pagelet object

AssignedPagelet Collection Property

Property	Returns
Count	Number ^RO

AvailableCategory Properties

Property	Returns
AvailablePagelets	AvailablePagelets Collection ^RO
CategoryName	String ^RO

AvailableCategory Collection Methods

Method	Returns
First()	AvailableCategory object
ItemByName(Name)	AvailableCategory object
Next()	AvailableCategory object

AvailableCategory Collection Property

Property	Returns
Count	Number ^RO

AvailablePagelet Properties

Property	Returns
CategoryLabel	String ^RO
CategoryName	String ^RO
Column	Number ^RO
LayoutBehavior	String ^RO
PageletLabel	String ^RO
PageletName	String ^RO
Row	Number ^RO

AvailablePagelet Collection Methods

Method	Returns
First()	AvailablePagelet object
ItemByName(Name)	AvailablePagelet object
Next()	AvailablePagelet object

AvailablePagelet Collection Property

Property	Returns
Count	Number ^RO

DynamicCategory Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	String
InsertItem(Name)	String
ItemByName(Name)	String
Next()	String

DynamicCategory Collection Property

Property	Returns
Count	Number ^RO

PageletCategory Method

Method	Returns
Save()	Boolean

PageletCategory Properties

Property	Returns
Attributes	AttributeValues collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionList object ^RO
CreationDate	String ^RO
Description	String
Label	String
Name	String ^RO
OwnerId	String
Pagelets	Pagelets Collection ^RO
Permissions	PermissionList Collection ^RO
Product	String
PublicAccess	Boolean
SequenceNumber	Number

PageletCategory Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	String
InsertItem(Name, Label)	String
ItemByName(Name)	String
Next()	String

PageletCategory Collection Property

Property	Returns
Count	Number ^RO

Pagelet Method

Method	Returns
Save()	Boolean

Pagelet Properties

Property	Returns
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionList Collection ^RO
ContentProvider	Node object ^RO
CreationDate	String ^RO
DefaultColumn	Number
Description	String
HelpID	String
IsHideMinimize	Boolean
Label	String
Name	String ^RO
OwnerId	String
ParentName	String ^RO
Permissions	PermissionList Collection ^RO
Product	String
PublicAccess	Boolean
QualifiedURL	String ^RO
SequenceNumber	Number
URL	String
URLType	String

Pagelet Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Pagelet object
InsertItem(Name, Label, NodeName, URL)	Pagelet object
ItemByName(Name)	Pagelet object
Next()	Pagelet object

Pagelet Collection Property

Property	Returns
Count	Number ^RO

UserHomepage Method

Method	Returns
Save()

UserHomepage Properties

Property	Returns
Greeting	String
UserId	String ^RO
UserTab	UserTab Collection^RO

UserTab Properties

Property	Returns
ColumnLayout	Number
Label	String
QualifiedURL	String ^RO
SelectedPagelets	SelectedPagelets collection^RO
SequenceNumber	Number
TabName	String ^RO

UserTab Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	UserTab object
InsertItem(Name)	UserTab object
ItemByName(Name)	UserTab object
Next()	UserTab object

UserTab Collection Property

Property	Returns
Count	Number ^RO

SelectedPagelet Properties

Property	Returns
CategoryName	String ^RO
Column	Number
IsMinimized	Boolean
PageletName	String ^RO
Row	Number

SelectedPagelet Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	SelectedPagelet object
InsertItem(Name)	SelectedPagelet object
ItemByName(Name)	SelectedPagelet object
Next()	SelectedPagelet object

SelectedPagelet Collection Property

Property	Returns
Count	Number ^RO

Favorites Properties

Property	Returns
CRefName	String ^RO
Label	String
QualifiedURL	String ^RO
SequenceNumber	Number
URL	String

Favorites Collection Methods

Method	Returns
DeleteItem(FavoriteLabel)	Boolean
First()	Favorite object
InsertItem(FavoriteLabel, FavoriteName)	Favorite object
ItemByLabel(FavoriteLabel)	Favorite object
Next()	Favorite object

Favorites Collection Property

Property	Returns
Count	Number ^RO

Query Classes Methods and Properties

This section lists the functions, methods, and properties, as well as returns (if applicable), for the query classes.

Query Collection Methods

Method	Returns
First()	Query object
Item(Number)	Query object
ItemByName(Name)	Query object
Next()	Query object

Query Collection Property

Property	Returns
Count	Number ^RO

Query Methods

Method	Returns
AddQuerySelect()	QuerySelect object
AddPrompt(PromptName)	Prompt object
Close()	None
Create(QueryName, Pubic, Type, Description, LongDescription)	Query object
Delete()	Number
DeletePrompt(PromptName)	Number
FindExpression(Number)	Expression object
FormatResultString(&Rowset, Output_Format, StartRow, EndRow)	String
Open(QueryName, Public, Update)	Number
Rename(NewQueryName)	Number
RunToFile(&PromptRecord, Destination, OutputFormat, MaxRows)	Number
RunToRowset(&PromptRecord, MaxRows)	Rowset object
Save()	Number

Query Properties

Property	Returns
Approved	String
ApprovedDtTm	String ^RO
ApprovedUserId	String
CreateDtTm	String ^RO
CreateUserId	String ^RO
Description	String
ExecAppName	String
ExecLogging	Boolean
LastSQLErrorCode	Number ^RO
LastUpdDttm	String ^RO
LastUpdOprId	String ^RO
LongDescription	String
Metadata	Metadata collection ^RO
Name	String ^RO
PDFFont	String
Prompts	QueryPrompt collection ^RO
PromptRecord	Record object ^RO
PublicPrivate	String
QuerySelect	QuerySelect object ^RO
QueryStatistics	QueryStatistics object ^RO
RunTimePrompts	QueryPrompt Collection ^RO
SQL	String ^RO
Type	Number

QuerySelect Methods

Method	Returns
AddAllFields(QueryRecord)	Number
AddCriteria(Name)	QueryCriteria object
AddExpression(Name)	QueryExpression object
AddHavingCriteria(Name)	QueryCriteria object
AddQueryOutputField(QueryRecord, index)	QueryOutputField object
AddQueryRecord(QueryRecordName)	QueryRecord object
AddQuerySelectedField(QueryRecord, index)	QuerySelectedField object
DeleteCriteria(index)	Number
DeleteExpression(Index)	Number
DeleteField(Index)	Number
DeleteHavingCriteria(Index)	Number
DeleteRecord(Index)	Number

QuerySelect Properties

Property	Returns
Criteria	QueryCriteria collection ^RO
Distinct	Boolean
Expressions	QueryExpression collection ^RO
HavingCriteria	QueryCriteria collection ^RO
ParentSelectNum	Number ^RO
QueryOutputFields	QueryField collection ^RO
QueryRecords	QueryRecord collection ^RO
QuerySelectedFields	QueryField collection ^RO
QuerySelects	QuerySelect object ^RO
SelectNum	Number ^RO
SelectType	Number ^RO

QuerySelect Collection Methods

Method	Returns
AddUnion()	QuerySelect object
DeleteQuerySelect(SelNumber)	Number
First()	QuerySelect object
Item(Number)	QuerySelect object
ItemBySelNum(SelNumber)	QuerySelect object
Next()	QuerySelect object

QuerySelect Collection Properties

Property	Returns
Count	Number ^RO

QueryRecord Collection Methods

Method	Returns
First()	QueryRecord object
Item(Number)	QueryRecord object
ItemByAlias(Alias)	QueryRecord object
Next()	QueryRecord object

QueryRecord Collection Property

Property	Returns
Count	Number ^RO

QueryRecord Method

Method	Returns
GetField(Index)	QueryField object

QueryRecord Properties

Property	Returns
Description	String ^RO
JoinAlias	String
JoinFieldName	String
JoinType	Number
Name	String ^RO
QueryFields	QueryFields collection ^RO
RecordAlias	String

QueryField Collection Methods

Method	Returns
First()	QueryField object
Item(Number)	QueryField object
ItemByNameAndAlias(Name, RecordAlias)	QueryField object
ItemByExpNum(ExpNum)	QueryField object
Next()	QueryField object

QueryField Collection Property

Property	Returns
Count	Number ^RO

QueryField Methods

Method	Returns
AddTranslateExpression(ExpressionName)	QueryExpression object
AddTranslateField(FieldName)	QueryField object

QueryField Properties

Property	Returns
Aggregate	Number
ColumnNumber	Number
Description	String ^RO
Decimal	Number ^RO
ExpNum	Number
Flag	Number ^RO
Format	Number
HeadingText	String
HeadingType	String
HeadingUniqueFieldName	String
Length	Number ^RO
LongName	String ^RO
Name	String ^RO
OrderByDirection	Number
OrderByNumber	Number
QueryRecord	QueryRecord object ^RO
RecordAlias	String ^RO
ShortName	String ^RO
TranslateEffDtLogic	String
TranslateExpression	Expression object ^RO
TranslateField	QueryField ^RO
TranslateOption	String
Type	String

QueryCriteria Collection Methods

Method	Returns
First()	QueryCriteria object
Item(Number)	QueryCriteria object
ItemByName(CriteriaName)	QueryCriteria object
Next()	QueryCriteria object

QueryCriteria Collection Property

Property	Returns
Count	Number ^RO

QueryCriteria Methods

Method	Returns
AddExpr1Expression()	QueryExpression object
AddExpr1Field(QueryRecordAlias, FieldName)	QueryField object
AddExpr2Expression()	QueryExpression object
AddExpr2Field1(QueryRecordAlias, FieldName)	QueryField object
AddExpr2Field2(QueryRecordAlias, FieldName)	QueryField object
AddExpr2List()	QueryList object
AddExpr2Subquery()	QuerySelect object

QueryCriteria Properties

Property	Returns
Expr1Expression	QueryExpression object ^RO
Expr1Field	QueryField object ^RO
Expr1Type	Number
Expr2Constant1	String
Expr2Constant2	String
Expr2Expression1	QueryExpression object ^RO
Expr2Expression2	QueryExpression object ^RO
Expr2Field1	QueryField object ^RO
Expr2Field2	QueryField object ^RO
Expr2List	QueryList object ^RO
Expr2Subquery	QuerySelect object ^RO
Expr2Type	Number
Logical	Number
LParenLvl	Number
Name	String ^RO
Negation	Boolean ^RO
Operator	Number
R1ExprNum	Number
R2ExprNum	Number
R1ExprType	Number
R2ExprType	Number
RParenLvl	Number

QueryExpression Collection Methods

Method	Returns
First()	QueryExpression object
Item(Number)	QueryExpression object
ItemByName(ExpressionName)	QueryExpression object
Next()	QueryExpression object

QueryExpression Collection Property

Property	Returns
Count	Number ^RO

QueryExpression Properties

Property	Returns
Aggregate	Number
BindFlag	Number
Decimal	Number
ExpNum	Number
Length	Number
Name	String ^RO
OutputField	QueryField object
RightExprFlag	Number
SelectedField	QueryField object
Text	String
Type	Number

QueryList Methods

Method	Returns
AddListValue(Value, IsPrompt)	QueryListValue object
First()	QueryListValue object
Item(Number)	QueryListValue object
Next()	QueryListValue object

QueryList Property

Property	Returns
Count	Number ^RO

QueryListValue Properties

Property	Returns
IsPrompt	Boolean ^RO
Value	String ^RO

QueryRecordHierarchy Collection Methods

Method	Returns
First()	QueryRecordHierarchy object
Item(Number)	QueryRecordHierarchy object
ItemByName(Name)	QueryRecordHierarchy object
Next()	QueryRecordHierarchy object

QueryRecordHierarchy Collection Property

Property	Returns
Count	Number ^RO

QueryRecordHierarchy Properties

Property	Returns
Description	String ^RO
Level	Number ^RO
Name	String ^RO
ParentFlag	Number ^RO

Query Metadata Collection Methods

Method	Returns
First()	Query Metadata object
Item(Number)	Query Metadata object
ItemByName(Name)	Query Metadata object
Next()	Query Metadata object

Query Metadata Collection Property

Property	Returns
Count	Number ^RO

Query Metadata Properties

Property	Returns
Name	String ^RO
Value	String ^RO

QueryStatistics Properties

Property	Returns
AvgExecTime	String ^RO
AvgFetchTime	String ^RO
AvgNumRows	Number ^RO
ExecCount	Number ^RO
LastExecDtTm	String ^RO

QuerySecurityProfile Properties

Property	Returns
AllowAnyJoin	Boolean ^RO
AllowDistinct	Boolean ^RO
AllowExpressions	Boolean ^RO
AllowSubqueries	Boolean ^RO
AllowUnions	Boolean ^RO
ApprovePrivateQuery	Boolean ^RO
ApprovePublicQuery	Boolean ^RO
CanCreatePublic	Boolean ^RO
CanCreateWorkFlow	Boolean ^RO
CanModifyQuery	Boolean ^RO
CanRunQuery	Boolean ^RO
CanRunToCrystal	Boolean ^RO
CanRunToExcel	Boolean ^RO
LimitUnapproved	Boolean ^RO
MaxInTreeCriteria	Boolean ^RO
MaxJoins	Boolean ^RO
MaxRowsToFetch	Boolean ^RO
MaxUnapprovedRows	Boolean ^RO

QueryDBRecord Collection Methods

Method	Returns
First()	QueryDBRecord object
Item(Number)	QueryDBRecord object
ItemByName(Name)	QueryDBRecord object
Next()	QueryDBRecord object

QueryDBRecord Collection Property

Property	Returns
Count	Number ^RO

QueryDBRecord Methods

Method	Returns
QueryDBRecordFieldByIndex(Index)	QueryDBRecordField object
QueryDBRecordFieldByName(Name)	QueryDBRecordField object

QueryDBRecord Properties

Property	Returns
Description	String ^RO
Name	String ^RO
QueryDBRecordFields	QueryDBRecordFields collection
RecordHierarchy	QueryRecordHierarchy Collection ^RO

QueryDBRecordField Collection Methods

Method	Returns
First()	QueryDBRecordField object
Item(Number)	QueryDBRecordField object
ItemByName(Name)	QueryDBRecordField object
Next()	QueryDBRecordField object
Sort(SortCriteria)	None

QueryDBRecordField Collection Property

Property	Returns
Count	Number ^RO

QueryDBRecordField Properties

Property	Returns
Decimal	Number ^RO
Description	String ^RO
Flag	Number ^RO
Format	Number ^RO
Length	Number ^RO
LongName	String ^RO
LookupTableName	String ^RO
LookupTableRecord	QueryDBRecord object ^RO
Name	String ^RO
ShortName	String ^RO
Type	Number ^RO

QueryPrompt Collection Methods

Method	Returns
First()	QueryPrompt object
Item(Number)	QueryPrompt object
ItemByName(Name)	QueryPrompt object
Next()	QueryPrompt object

QueryPrompt Collection Property

Property	Returns
Count	Number ^RO

QueryPrompt Properties

Property	Returns
EditType	Number
FieldDecimal	Number
FieldFormat	Number
FieldLength	Number
FieldName	String
FieldType	Number
HeadingText	String
HeadingType	Number
LangCount	Number ^RO
Name	String ^RO
PromptRecordFieldName	String ^RO
PromptTable	String
UniquePromptName	String
UseCount	Number ^RO

Tree Classes Methods and Properties

This section lists the methods and properties, as well as returns (if applicable), for the tree classes.

Branch Collection Properties

Property	Returns
Count	Number ^RO

Leaf Methods

Method	Returns
Cut()	Number
Delete()	Number
DeleteByRange(RangeFrom, RangeTo)	Number
InsertDynSib()	Number
InsertSib(RangeFrom, RangeTo)	Leaf object
MoveAsChild(Node)	Number
MoveAsChildByName(NodeName)	Number
MoveAsSib(Leaf)	Number
MoveAsSibByRange(RangeFrom, RangeTo)	Number
PasteSib()	Number
UpdateRanges(RangeFrom, RangeTo)	Number

Leaf Properties

Property	Returns
DisplayLevelNumber	Number ^RO
Dynamic	Boolean
HasNextSib	Boolean ^RO
HasPrevSib	Boolean ^RO
ImageName	String
IsChanged	Boolean ^RO
IsCut	Boolean ^RO
IsDeleted	Boolean ^RO
IsInserted	Boolean ^RO
NextSib	Leaf object ^RO
Parent	Node object ^RO
PrevSib	Leaf object ^RO
RangeFrom	String
RangeTo	String
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO

Level Collection Methods

Method	Returns
Add(LevelName)	Level object
Item(LevelName, LevelNumber)	Level object
Remove()	Number

Level Collection Properties

Property	Returns
Count	Number ^RO
First	Level object ^RO
Last	Level object ^RO
Next	Level object ^RO

Level Properties

Property	Returns
AllValuesAudit	Boolean
Description	String
Name	String
Number	Number
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO

Node Methods

Method	Returns
Branch()	Number
Cut()	Number
Delete()	Number
DeleteByName(NodeName)	Number
Expand(ExpandType)	Number
InsertChildLeaf(RangeFrom, RangeTo)	Leaf object
InsertChildNode(NodeName)	Node object
InsertChildRecord(NodeName)	Node object
InsertDynChildLeaf()	Leaf object
InsertSib(NodeName)	Node object
InsertSibRecord(NodeName)	Node object
MoveAsChild(Node)	Number
MoveAsChildByName(NodeName)	Number
MoveAsSib(Node)	Number
MoveAsSibByName(NodeName)	Number
PasteChild()	Number
PasteSib()	Number
RefreshDescription()	Number
Rename(NodeName)	Number
SwitchLevel(NewLevelNumber)	Number
Unbranch()	Number

Node Properties

Property	Returns
AllChildCount	Number ^RO
AllChildNodeCount	Number ^RO
ChildLeafCount	Number ^RO
ChildNodeCount	Number ^RO
ColImageName	String
Description	String ^RO
DisplayLevelNumber	Number ^RO
ExpImageName	String
FirstChildLeaf	Leaf object ^RO
FirstChildNode	Node object ^RO
HasChildLeaves	Boolean ^RO
HasChildNodes	Boolean ^RO
HasChildren	Boolean ^RO
HasNextSib	Boolean ^RO
HasPrevSib	Boolean ^RO
IsBranched	Boolean ^RO
IsChanged	Boolean ^RO
IsCut	Boolean ^RO
IsDeleted	Boolean ^RO
IsInserted	Boolean ^RO
IsRoot	Boolean ^RO
LastChildLeaf	Leaf object ^RO
LastChildNode	Node object ^RO
LevelNumber	Number
Name	String
NextSib	Leaf object ^RO
Parent	Node object ^RO
PrevSib	Leaf object ^RO
State	Number ^RO
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO
Type	String ^RO

Tree Methods

Method	Returns
Audit()	Number
AuditByName(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
Close()	Number
Copy(FromSetId, FromUserKeyValue, FromTreeName, FromEffDt, FromBranchName, ToSetId, ToUserKeyValue, ToTreeName, ToEffDt, ToBranchName)	Number
Create(SetID, UserKeyValue, TreeName, EffDt, StructureName)	Number
Delete(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
Exists(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
FindLeaf(RangeFrom, RangeTo)	Leaf object
FindNode(NodeName, Description)	Node object
FindRoot()	Node object
InsertRoot(NodeName)	Node object
LeafExists(RangeFrom, RangeTo)	Number
LockTree()	Number
Open(SetID, UserKeyValue, TreeName, EffDt, BranchName, Update)	Number
OpenForExport(SetID, UserKeyValue, TreeNameEffDt)	Number.
OpenWholeTree(SetID, UserKeyValue, TreeName, EffDt)	Number
NodeExists(NodeName)	Number
Rename(FromSetId, FromUserKeyValue, FromTreeName, FromEffDt, FromBranchName, ToTreeName)	Number
Save()	Number
SaveAs(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
SaveAsDraft(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
SaveDraft()	Number
SetImportMode(Nodes_Number, Leaves_Number)	Number
TreeLocksNumber(setID, UserKeyValue, TreeName, EffDt)	Number
UnlockTree()	Number
UpdateLock()	Number

Tree Properties

Property	Returns
AllValues	Boolean
AuditDetails	Boolean
Branches	Branch collection object ^RO
BranchImageName	String
BranchLevel	Number ^RO
BranchName	String ^RO
Category	String
Description	String
DuplicateLeaves	Boolean
EffDt	Date
HasDetailRanges	Boolean ^RO
HasLockedBranches	Boolean ^RO
IsBranched	Boolean ^RO
IsChanged	Boolean ^RO
IsOpen	Boolean ^RO
IsQueryTree	Boolean ^RO
IsValid	Boolean ^RO
IsVersionChanged	Boolean ^RO
IsWholeTree	Boolean ^RO
KeyBranchName	String ^RO
KeyEffDt	String ^RO
KeyName	String ^RO
KeySetID	String ^RO
KeyUserKeyValue	String ^RO
LeafCount	Number ^RO
LeafImageName	String
LeafOnClipboard	Boolean ^RO
LevelCount	Number ^RO
Levels	Level collection object ^RO
LevelUse	String
LockOwner	String, ^RO
Name	String
NodeColImage	String
NodeCount	Number ^RO
NodeExpImage	String
NodeOnClipboard	Boolean ^RO
ParentLevel	Number ^RO
ParentName	String ^RO
PerformanceMethod	String
PerformanceSelector	String
PerformanceSelectorOption	String
SetId	String
Status	String
Structure	Tree structure object ^RO
StructureName	String ^RO
TreeImageName	String
UserKeyValue	String
UseUpdateReservation	Boolean ^RO

Tree Structure Methods

Method	Returns
Close()	Number
Copy(FromStructId, ToStructId)	Number
Create(StructId, Type)	Number
Delete(StructId)	Number
Open(StructId, Update)	Number
Rename(FromStructId, ToStructId)	Number
Save()	Number

Tree Structure Properties

Property	Returns
Description	String
DetailComponent	String
DetailField	String
DetailMenu	String
DetailMenuBar	String
DetailMenuItem	String
DetailMultiNavigate	Boolean
DetailPage	String
DetailRecord	String
IndirectionMethod	String
KeyName	String ^RO
LevelComponent	String
LevellMenu	String
LevelMenuBar	String
LevelMenuItem	String
LevelPage	String
LevelRecord	String
Name	String
NodeComponent	String
NodeField	String
NodelMenu	String
NodeMenuBar	String
NodeMenuItem	String
NodeMultiNavigate	Boolean
NodePage	String
NodeRecord	String
NodeUserKeyField	String
SummarySetId	String
SummaryLevelNumber	String
SummaryTreeName	String
SummaryUserKeyValue	String
Type	String

Mapping of Functions to Methods and Properties

The first column in the following table lists built-in PeopleCode functions that existed prior to PeopleTools 8.0. The second column lists the new method or property that should be used instead of the function. The existing functions still work in PeopleTools 8.0, however, they are being retained for backward compatibility only. New applications should be created using the new classes, methods, and properties.

Existing function name	Use instead
ActiveRowCount	ActiveRowCount Rowset property
ClearSearchDefault	SearchDefault Field property
ClearSearchEdit	SearchEdit Field property
CompareLikeFields	CompareFields Record method
CopyFields	CopyFieldsTo or CopyChangedFieldsTo Record method
CopyRow	CopyTo Row method
CurrEffDt	DeleteEnabled Rowset property
CurrEffRowNum	RowNumber Row property, in combination with the GetCurrEffRow Rowset method
CurrEffSeq	EffSeq Rowset property
CurrentRowNumber	RowNumber Row property
DeleteRecord	Delete Record method
DeleteRow	DeleteRow Rowset method
FetchValue	Value Field property
FieldChanged	IsChanged Field property
GetRelField	GetRelated Field method
GetStoredFormat	StoredFormat Field property
Gray	Enabled Field property
Hide	Visible Field property
HideRow	Visible Row property
HideScroll	HideAllRows Rowset method
InsertRow	InsertRow Rowset method
IsHidden	Visible Row property
NextEffDt	GetNextEffRow().REC.FIELD.Value
NextRelEffDt	GetNextEffRow.()REC.FIELD.GetRelated(rec.field).value
PriorEffDt	GetPriorEffRow().REC.Field.Value
PriorRelEffDt	GetPriorEffRow().REC.FIELD.GetRelated(rec.field).value
RecordChanged	IsChanged Record property
RecordDeleted	IsDeleted Record property
RecordNew	IsNewRecord property
RemoteCall for Application Engine	CallAppEngine function
RowFlush	FlushRow Rowset method
RowScrollSelect	Select Rowset method
RowScrollSelectNew	SelectNew Rowset method
ScrollFlush	Flush Rowset method
ScrollSelect	Select Rowset method
ScrollSelectNew	SelectNew Rowset method
SetDefault	SearchDefault Field property
SetDefaultAll	SetDefault Rowset method
SetDefaultNext	GetNextEffRow().REC.FIELD.SetDefault()
SetDefaultNextRel	GetNextEffRow().REC.Field.GetRelated(REC.FIELD).SetDefault()
SetDefaultPrior	GetPriorEffRow().REC.FIELD.SetDefault()
SetDefaultPriorRel	GetPriorEffRow().REC.Field.GetRelated(REC.FIELD).SetDefault()
SetDisplayFormat	DisplayFormat Field property
SetLabel	Label Field property
SetSearchDefault	SearchDefault Field property
SetSearchEdit	SearchEdit Field property
SetTracePC	If using API (Session object), use Trace Setting Class properties.
SetTraceSQL	If using API (Session object), use Trace Setting Class properties.
SortScroll	Sort Rowset method
TotalRowCount	RowCount Rowset property
Ungray	Enabled Field property
UnHide	Visible Field property
UnHideRow	Visible Row property
UnhideScroll	ShowAllRows Rowset method
UpdateValue	Value Field property

Mapping of Old Names to New Names

In PeopleTools 8.1, the names of some of the definitions in PeopleSoft Application Designer changed. The names of related built-in functions have changed accordingly.

The first table lists the old terms and new terms.

In the second table, the left column lists the old names of the functions, system variables, or reserved words. The right column lists the new names. The existing functions, system variables, and reserved words in this table still work in PeopleTools 8.0, however, they are being retained for backward compatibility only. New applications should be created using the new functions, system variables, and reserved words.

Old Term	New Term
Operator	User
Panel	Page
Panel Group	Component
Business Component	Component Interface

Deprecated Function, System Variable or Reserved Word	New Function, System Variable or Reserved Word
DoModalPanelGroup built-in function	DoModalComponent built-in function
GetNextNumberWithGaps	GetNextNumberWithGapsCommit built-in function
IsModalPanelGroup built-in function	IsModalComponent built-in function
IsOperatorInClass built-in function	IsUserInPermissionList built-in function
PanelGroupChanged built-in function	ComponentChanged built-in function
ScheduleProcess built-in function	CreateProcessRequest built-in function
SetNextPanel built-in function	SetNextPage built-in function
TransferPanel built-in function	TransferPage built-in function
%OperatorClass System Variable	%PrimaryPermissionList System Variable
%OperatorID System Variable	%UserId System Variable
%OperatorRowLevelSecurityClass System Variable	%RowSecurityPermissionList System Variable
%Panel System Variable	%Page System Variable
%PanelGroup System Variable	%Component System Variable
PANEL reserved word	PAGE reserved word
PANELGROUP reserved word	COMPONENT reserved word
PanelGroup variable declaration	Component variable declaration

Business Components are now named Component Interfaces. For Component Interfaces, the old reserved word, methods, and system variables are no longer valid. You must use the new reserved word, methods, or system variables.

No Longer Valid	Use Instead
COMPONENT reserved word	COMPINTFC reserved word
GetComponent method	GetCompIntfc method
FindComponent method	FindCompIntfcs method
%Component system variable	%CompIntfc system variable

Deprecated Functions

The following functions are deprecated, and no longer work in release 8.4 and beyond.

Function	Description
%MessageAgent	Used with Message Agent activities
ChDir	Used only on the client with DOS
ChDrive	Used only on the client with DOS
CheckMenuItem	Used with menu items
Codeb	Used before true Unicode integration
DBCSTrim	Used before true Unicode integration
Findb	Used before true Unicode integration
GetControl	Used with ActiveX controls
GetControlOccurence	Used with ActiveX controls
GetCwd	Used only on the client with DOS
GetMessageInstance	Used with messaging
GetPubContractInstance	Used with messaging
GetSelectedTreeNode	Used with dynamic trees
GetSubContractInstance	Used with messaging
GetTreeNodeParent	Used with dynamic trees
GetTreeNodeRecordName	Used with dynamic trees
Lenb	Used before true Unicode integration
RefreshTree	Used with dynamic trees
ScheduleProcess	Used with Peoplesoft Process Scheduler
Substringb	Used before true Unicode integration
UnCheckMenuItem	Used with menu items
WinEscape	Used only on client
WinExec	Used only on client

Deprecated Methods and Properties

The following are the methods and properties that have been deprecated.

Method or Property	Use Instead
Session Class Connect method	%Session system variable
Session Class FindTree, FindTreeStructure methods	GetTree, GetTreeStructure session class methods (respectively)
Tree collection	All tree collection methods and properties have been deprecated. Use GetTree to access a tree instead.
Tree structure collection	All tree structure collection methods and properties have been deprecated. Use GetTreeStructure to access a tree structure instead.
Item tree branch collection method, and the First, Last, and Next tree branch collection properties
Tree class methods: FindNextDisplayObject FindPreviousDisplayObject
Tree class properties: CheckLeafUserData DisplayLeaf DisplayNode IsReadOnly

PeopleCode Syntax Quick Reference

The following is a description of the PeopleCode syntax, as derived from the PeopleCode parser. This description uses these metacharacters:

Metacharacter	Description
[ ]	Brackets are used to indicate optional portions.
...	Ellipses are used to indicate that the preceding part (often optional) repeats an arbitrary number of times.
\|	Vertical bars are used to separate alternatives. They indicate that one of the alternatives should be present. The alternatives extend only to the immediately enclosing parentheses or brackets (if any).
()	Parentheses are used to group portions of definitions to limit the scope of alternatives (\|) or optionality (...).
'symbols'	Quoted characters in keyword style are keywords or punctuation in the language. They should appear literally, without the quotation marks.

The following is the PeopleCode language syntax quick reference:

Term	Syntax
Program	ImportList (DeclList TopStList \| ClassDefn )
ImportList	[ ImportDecl ‘;’ ]...
ImportDecl	‘import’ PackageName [ *‘:’ ‘’** ]
PackageName	Id [ ‘:’ Id ]...
ClassDefn	ClassDecl [ ‘;’ ExtDecls ] [ ‘;’ MethodDefns ]
ClassDecl	‘class’\| ‘interface’' Id [ Extends ] [ ClassPublics ] [ ClassProtecteds ] [ ClassPrivates ] ‘end-class’ \| ‘end-interface’
Extends	‘extends’ \| ‘implements’ QualifiedId
QualifiedId	[ PackageName ‘:’ ] Id
ClassPublics	ClassPublic [ ‘;’ ClassPublic ]...
ClassPublic	MethodDecl \| PropertyDecl
MethodDecl	‘method’ Id ‘(’ [ MethodParameters ] ‘)’ [ 'abstract' ] [ ‘returns’ PeopleCodeType ]
MethodParameters	MethodParameter [ ‘,’ MethodParameter ]...
MethodParameter	‘&’ Id ‘as’ PeopleCodeType [ ‘out’ ]
PropertyDecl	‘property’ PeopleCodeType Id [ (‘get’ [ ‘set’ ] \| 'abstract' ) \| ‘readonly’ ]
ClassPrivates	‘private’ [ ClassPrivate [ ‘;’ ClassPrivate ]... ]
ClassPrivate	MethodDecl \| InstanceDecl \| ConstantDecl
ClassProtecteds	‘protected’ [ ClassProtected [ ‘;’ ClassProtected ]... ]
ClassProtected	MethodDecl \| InstanceDecl \| ConstantDecl
InstanceDecl	‘instance’ VarDeclare
ExtDecls	ExtDecl [ ‘;’ ExtDecl ]...
MethodDefns	MethodDefn [ ‘;’ MethodDefn ]...
MethodDefn	MethodMethod \| GetMethod \| SetMethod
MethodMethod	‘method’ Id StList ‘end-method’
GetMethod	‘get’ Id StList ‘end-get’
SetMethod	‘set’ Id StList ‘end-set’
TopStList	TopStmt [ ‘;’ TopStmt ]...
TopStmt	Stmt
StList	Stmt [ ‘;’ Stmt ]...
Stme	[ LValue [ Assign ] \| If \| Evaluate \| While \| Repeat \| For \| Accept \| Break \| Return \| Exit \| Error \| Warning \| Try \| Throw \| LocalDecl ]
Assign	‘=’ Expression
If	‘if’ LogicalExpression ‘then’ StList [ ‘else’ StList ] ‘end-if’
Evaluate	‘evaluate’ Expression [ WhenExpr... StList ]... [ ‘when-other’ StList ] ‘end-evaluate’
WhenExpr	‘when’ [ RelOp ] Expression
While	‘while’ LogicalExpression StList ‘end-while’
Repeat	‘repeat’ StList ‘until’ LogicalExpression
For	‘for’ Variable ‘=’ Expression ‘to’ Expression [ ‘step’ Expression ] StList ‘end-for’
Accept	‘accept’
Return	‘return’ [ Expression ]
Break	‘break'
Exit	‘exit’ [ Expression ]
Warning	‘warning’ Expression
Error	‘error’ Expression
Try	‘try’ StList ( ‘catch’ QualifiedId ‘&’ Id StList )... ‘end-try’
Throw	‘throw’ Expresssion
LocalDecl	‘local’ PeopleCodeType ‘&’ Id [ ( ',' ‘&’ Id)... \| ‘=’ Expression ]
Continue	'Continue'
LogicalExpression	LogicalTerm [ ‘or’ LogicalTerm ]...
LogicalTerm	Relation [ ‘and’ Relation ]...
Relation	‘not’ Relation \| Expression [ Relop Expression ]
Relop	‘not’ Relop \| ‘<’ \| ‘<=’ \| ‘=’ \| ‘>=’ \| ‘>’ \| ‘!=’ \| ‘<>’
Expression	Term [ ( ‘+’ \| ‘-’ \| ‘\|’ ) Term ]...
Term	Power [ ( *‘’ \| ‘/’** ) Power ]...
Power	Primary [ ‘’** Primary ]...
Primary	LValue [ ‘as’ QualifiedId ] \| Number \| String \| ‘true’ \| ‘false’ \| 'null' \| ‘-’ Primary \| ‘create’ QualifiedId Call
LValue	LValueStart [ LValueObject \| LValueSubscript ]...
LValueStart	Variable \| Id Call \| '@' Primary \| '%' BuiltinVar \| ‘(’ LogicalExpression ‘)’
LValueObject	'.' Id [ Call ] \| Call
LValueSubscript	'[' Expression [ ',' Expression ]... ']'
Variable	‘&’ Id \| Id [ ‘.’ ( Id \| String ) ] \| ‘^’
Call	‘(’ [ Expression [ ‘,’ Expression ]... ] ‘)’
Constant	Number \| String \| ‘true’ \| ‘false’ \| 'null' \| QualifiedId ‘:’ Id
DecList	[ Decl ‘;’ ]...
Decl	‘local’ VarDeclare \| ‘function’ Function \| ConstDecl \| ExtDecl
VarDeclare	PeopleCodeType ‘&’ Id [ ‘,’ ‘&’ Id ]...
Function	Id [ ‘(’ InternalParameters ‘)’ ] [ ‘returns’ PeopleCodeType ] [ ‘noexport’ ] [ ‘doc’ String ] TopStList ‘end-function’
InternalParameters	[ InternalParameter [ ‘,’ InternalParameter ]... ]
InternalParameter	‘&’ Id [ ‘as’ PeopleCodeType ]
ConstDecl	‘constant’‘&’ Id ‘=’ ( Number \| String \| ‘true’ \| ‘false’ \| 'null' )
ExtDecl	‘global’ VarDeclare \| ‘component’ VarDeclare \| ‘declare’ Declare
Declare	‘function’ Id ( ‘library’ DeclareLibrary \| ‘peoplecode’ DeclarePC )
DeclareLibrary	String [ ‘alias’ String ] [ ‘(’ ExternalParameters ‘)’ ] [ ‘returns’ ExternalType [ ‘as’ PeopleCodeType ] ]
ExternalParameters	[ ExternalParameter [ ‘,’ ExternalParameter ]... ]
ExternalParameter	ExternalType [ ‘value’ \| ‘ref’ ] [ ‘as’ PeopleCodeType ]
DeclarePC	Variable EventType
PeopleCode Type	[ ‘array’ ‘of’ ]... ( ‘number’ \| ‘string’ \| ‘date’ \| ‘time’ \| ‘datetime’ \| ‘any’ \| ‘boolean’ \| ‘object’ \| ‘array’ \| ‘integer’ \| ‘float’ \| QualifiedId )
ExternalType	‘boolean’ \| ‘integer’ \| ‘long’ \| ‘uinteger’ \| ‘ulong’ \| ‘string’ \| ‘lstring’ \| ‘ustring’ \| ‘float’ \| ‘double’