Component Interface Attributes
This section discusses the name, keys, properties, collections, and methods of component interfaces.
Each component interface requires a unique name that is specified when the component interface is created. The calling programs use the name of the component interface to access properties and methods.
Keys are special properties containing values that retrieve an instance (Get keys) or a list of instances (Find keys) of the component interface. When you create a new component interface, Get and Find keys are created based on the search record definition for the underlying component. However, you can add, remove, or change keys in PeopleSoft Application Designer. Create keys are created for components that have the Add action enabled.
Properties provide access to both component data and component interface settings. Component interfaces include two types of properties: standard and user-defined.
Standard properties are assigned automatically when a component interface is created.
Standard properties can be set to true or false. These properties are not displayed in the PeopleSoft Application Designer. Examples of standard properties include InteractiveMode, GetHistoryItems, and EditHistoryItems.
User-defined properties map to record fields on the PeopleSoft component and are displayed in the PeopleSoft Application Designer.
A property can correspond to a field or a scroll (collection). You can control which user-defined properties are included on the component interface.
Note: Every PeopleSoft Application Designer definition—including the component interface—has a definition properties dialog box in which you make design-time settings for the definition. Those properties should not be confused with the runtime properties that are discussed here.
A component interface collection is a special type of property that corresponds to a scroll. It contains fields and subordinate scrolls as defined in its underlying component. By default, each collection uses the name of the primary record for the underlying scroll.
A method is a function that performs a specific task on a component interface at runtime. As with component interface properties, two main types of methods are available: standard and user-defined. For example, you can use methods to save or create a new purchase order. Runtime access to each method is determined by the security that you have for that specific method.
Standard methods are those that are available for all component interfaces.
The Find, Get, Save, and Cancel methods are automatically generated by PeopleSoft Application Designer when a new component interface is created. The Create method is created for components that have the Add action enabled. In the component interface designer, standard methods are highlighted in gray.
User-defined methods are created in PeopleSoft Application Designer to provide added functionality to the component interface.
These methods are functions that are made accessible through the component interface. Each function maps to a user-defined method. In the component interface designer, user-defined methods are highlighted in blue.