Understanding Standard Properties

Standard properties do not appear in the component interface view in PeopleSoft Application Designer. The following tables name and define the standard properties, and list the interfaces for PeopleCode, Java, and C++.

This table contains the component interface properties:

Property Name	Description, Programming Syntax
CreateKeyInfoCollection	Returns a collection of items that describes the Create keys. This property is read-only. Use these interfaces to call with other programming languages. Java: IcompIntfcPropertyInfoCollection getCreateKeyInfoCollection() C++: HPSAPI_COMPINTFCPROPERTYINFOCOLLECTION <CI_NAME>_GetCreateKeyInfoCollection(HPSAPI_<CI_NAME>)
GetKeyInfoCollection	Returns a collection of items that describes the Get keys. This property is read-only. Use these interfaces to call with other programming languages. Java: IcompIntfcPropertyInfoCollection getGetKeyInfoCollection() C++: HPSAPI_COMPINTFCPROPERTYINFOCOLLECTION<CI_NAME>_GetGetKeyInfoCollection(HPSAPI_<CI_NAME>)
FindKeyInfoCollection	Returns a collection of items that describes the Find keys. This property is read-only. Use these interfaces to call with other programming languages. Java: IcompIntfcPropertyInfoCollection getFindKeyInfoCollection() C++: HPSAPI_COMPINTFCPROPERTYINFOCOLLECTION<CI_NAME>_GetFindKeyInfoCollection(HPSAPI_<CI_NAME>)
GetHistoryItems	Controls whether the component interface runs in Update/Display mode or Update/Display All mode when the underlying component is effective-dated. If GetHistoryItems is set to true, then historical data can be retrieved but not modified. GetHistoryItems work in accordance with EditHistoryItems. The default value is False. This property is read-only. Use these interfaces to call with other programming languages. Java: boolean getGetHistoryItems(), void setGetHistoryItems(boolean) C++: BOOL <CI_NAME>_GetGetHistoryItems(HPSAPI_<CI_NAME>), void<CI_NAME>_SetGetHistoryItems(HPSAPI_<CI_NAME>, BOOL)
EditHistoryItems	Controls whether the component interface runs in Update/Display All mode, Update/Display mode, or Correction mode when the underlying component is effective-dated. If EditHistory items are set to true, then historical data can be modified. EditHistory items work in accordance with GetHistory items. The default value is False. This property is read-only. Use these interfaces to call with other programming languages. Java: boolean getEditHistoryItems(), void setEditHistoryItems(boolean) C++: BOOL <CI_NAME>_GetEditHistoryItems(HPSAPI_<CI_NAME>), void<CI_NAME>_SetEditHistoryItems(HPSAPI_<CI_NAME >, BOOL)
InteractiveMode	Controls whether to apply values and run business rules immediately, or whether items are queued and business rules are run later, in a single step. Note: You should use interactive mode when testing and debugging a component interface. Interactive mode in a production environment slows performance because of the number of server trips required. If you are using a component interface as part of a batch process in which thousands of rows are to be inserted, running in interactive mode may reduce performance so much on some UNIX servers that the application times out with a connection failure. The default value is False. This property is read-only. Use these interfaces to call with other programming languages. Java: boolean getInteractiveMode(), void setInteractiveMode(boolean) C++: BOOL <CI_NAME>_GetInteractiveMode(HPSAPI_<CI_NAME>), void<CI_NAME>_SetInteractiveMode(HPSAPI_<CI_NAME>, BOOL )
StopOnFirstError	When this property is set to True, the first error generated by the component interface halts the program. The default value is False. This property is read-only. Java: boolean getStopOnFirstError(), setStopOnFirstError(boolean) C++: BOOL <CI_NAME>_GetStopOnFirstError(HPSAPI_<CI_NAME>), void<CI_NAME>_SetStopOnFirstError(HPSAPI_<CI_NAME>, BOOL)
CompIntfcName	Returns the name of the component interface class as named in PeopleSoft Application Designer. This property is read-only. Java: String getCompIntfcName() C++: LPTSTR <CI_NAME>_GetCompIntfcName((HPSAPI_<CI_NAME>)
ComponentName	Returns the name of the component as named in PeopleSoft Application Designer. This property is read-only. Java: boolean getComponentName() C++: LPTSTR <CI_NAME>_GetComponentName(HPSAPI_<CI_NAME>)
Description	Returns the description of the component interface class as set in PeopleSoft Application Designer. This property is read-only. Java: boolean getDescription() C++: LPTSTR <CI_NAME>_GetDescription((HPSAPI_<CI_NAME>)
Market	Returns the Market setting of the component used to build this component interface. This property is read-only. Java: String getMarket() C++: LPTSTR <CI_NAME>_GetMarket((HPSAPI_<CI_NAME>)
GetDummyRows	When a new scroll is inserted on a page, that scroll is displayed even though it has no underlying data. Any scroll that is empty has one dummy row displayed with only the defaults set. This property is True if the dummy row is to be displayed, False if it is not. The default value for this property is True. This property is read-write. Java: boolean getGetDummyRows(), void setGetDummyRows(boolean) C++: BOOL <CI_NAME>_GetGetDummyRows(HPSAPI_<CI_NAME>), void<CI_NAME>_SetGetDummyRows(HPSAPI_<CI_NAME>, BOOL)
PropertyInfoCollection	Returns a collection of items that describes a specific property. The specific properties that are available in the propertyinfocollection are listed here. This property is read-only. Use these interfaces to call with other programming languages. Java: IcompIntfcPropertyInfoCollection getPropertyInfoCollection() C++: HPSAPI_COMPINTFCPROPERTYINFOCOLLECTION <CI_NAME>_GetPropertyInfoCollection(HPSAPI_<CI_NAME>)

The Component Interface Property Info Collection object (CompIntfPropInfoCollection) supports the following PeopleCode API Reference: CompIntfPropInfoCollection Object Properties.

Property Name	Description, Programming Syntax
Name	This property returns the name of the object executing the property as a string. This property is read-only. Java: String getName() C++: LPTSTR CompIntfcPropertyInfo_GetName(HPSAPI_COMPINTFCPROPERTYINFO)
RecordName	This property returns the record name associated with the object executing the property. This property is read-only. Java: String getRecordName() C++: LPTSTR CompIntfcPropertyInfo_GetRecordName(HPSAPI_COMPINTFCPROPERTYINFO)
FieldName	This property returns the field name associated with the object executing the property. This property is read-only. Java: String getFieldName() C++: LPTSTR CompIntfcPropertyInfo_GetFieldName(HPSAPI_COMPINTFCPROPERTYINFO \)
LabelLong	This property returns the record field Long Name value as a string. If a component override exists for this value, it is not included. This property is read-only. Java: String getLabelLong() C++: LPTSTR CompIntfcPropertyInfo_GetLabelLong(HPSAPI_COMPINTFCPROPERTYINFO)
LabelShort	This property returns the record field ShortName value as a string. If a component override exists for this value, it is not included. This property is read-only. Java: String getLabelShort() C++: LPTSTR CompIntfcPropertyInfo_GetLabelShort(HPSAPI_COMPINTFCPROPERTYINFO) COM: String LabelShort
IsCollection	This property returns True if the object executing the property is a data collection, False otherwise. If IsCollection is True, other field-oriented properties like Required, Type, Xlat, Yes, No, Prompt, and Format are undefined. If IsCollection is False, the object represents a field and all the previous properties are defined as described. This property is read-only. Java: boolean getIsCollection() C++: BOOL CompIntfcPropertyInfo_GetIsCollection(HPSAPI_COMPINTFCPROPERTYINFO)
Type	This property returns the field type, as a number, of the object. This property is read-only. Java: long getType() C++: PSI32 CompIntfcPropertyInfo_GetType(HPSAPI_COMPINTFCPROPERTYINFO)
OAType	This property returns the field type, as a number, of the object. This property is read-only. Java: long getOAType() C++: PSI32 CompIntfcPropertyInfo_GetOAType(HPSAPI_COMPINTFCPROPERTYINFO)
Format	This property returns the field format for the object executing the property (that is, name, phone, zip, SSN, and so on) as a number. This property is read-only. Java: String getFormat() C++: PSI32 CompIntfcPropertyInfo_GetFormat(HPSAPI_COMPINTFCPROPERTYINFO)
Key	This property returns True if the object executing the property is a key, False otherwise. This property is read-only. Java: boolean getKey() C++: BOOL CompIntfcPropertyInfo_GetKey(HPSAPI_COMPINTFCPROPERTYINFO hCompIntfcPropertyInfo)
Required	This property returns True if the object executing the property is a required property, False otherwise. This property is read-only. Java: boolean getRequired() C++: BOOL CompIntfcPropertyInfo_GetRequired(HPSAPI_COMPINTFCPROPERTYINFO)
Xlat	This property returns True if the object executing the property is associated with an XLAT table, False otherwise. This property is read-only. Java: String getXlat() C++: BOOL CompIntfcPropertyInfo_GetXlat(HPSAPI_COMPINTFCPROPERTYINFO)
Yesno	This property returns True if the object executing the property is associated with the Yes/No table, False otherwise. This property is read-only. Java: boolean getYesno() C++: BOOL CompIntfcPropertyInfo_GetYesno(HPSAPI_COMPINTFCPROPERTYINFO)
Prompt	This property returns True if the object executing the property is associated with a prompt table, False otherwise. This property is read-only. Java: boolean getPrompt() C++: BOOL CompIntfcPropertyInfo_GetPrompt(HPSAPI_COMPINTFCPROPERTYINFO)
Length	This property returns the length of the object executing the property. This property is read-only. Java: long getLength() C++: PSI32 CompIntfcPropertyInfo_GetLength(HPSAPI_COMPINTFCPROPERTYINFO)
DecimalPosition	This property returns the decimal position for the object executing the property. This property is read-only. Java: long getDecimalPosition() C++: PSI32 CompIntfcPropertyInfo_GetDecimalPosition(HPSAPI_COMPINTFCPROPERTYINFO)
IsReadOnly	This property returns True if the property marked read-only in the component interface definition; False otherwise. This property is read-only. Java: boolean getIsReadOnly() C++: BOOL CompIntfcPropertyInfo_GetIsReadOnly(HPSAPI_COMPINTFCPROPERTYINFO)
Altkey	This property returns True if the object executing the property is an alternate key, False otherwise. This property is read-only. Java: boolean getAltkey() C++: BOOL CompIntfcPropertyInfo_GetAltkey(HPSAPI_COMPINTFCPROPERTYINFO)
Listboxitem	This property returns True if the object executing the property is associated with a list box, False otherwise. This property is read-only. Java: boolean getListboxitem() C++: BOOL CompIntfcPropertyInfo_GetListboxitem(HPSAPI_COMPINTFCPROPERTYINFO)

Example of PropertyInfoCollection

Here is a Java example that calls PropertyInfoCollection:

IcompIntfcPropertyInfoCollection oLO_PropInfoColl
IcompIntfcPropertyInfo oLO_PropInfoItem
oLO_PropInfoColl = oCI.getPropertyInfoCollection();
for (int I=0; I < oLO_PropInfoColl.getCount(); I++) {
   oLO_PropInfoItem = oLO_PropInfoColl.item(i);
   System.out.println("\t Name = " + oLO_PropInfoColl.getName());
   System.out.println("\t Record Name = " + oLO_PropInfoColl.getRecordName());
   System.out.println("\t Field Name = " + oLO_PropInfoColl.getFieldName());
   System.out.println("\t Label Long = " + oLO_PropInfoColl.getLabelLong());
   System.out.println("\t Label Short = " + oLO_PropInfoColl.getLabelShort());
   System.out.println("\t IsCollection = " + oLO_PropInfoColl.getIsCollection());
   System.out.println("\t Type = " + oLO_PropInfoColl.getType());
   System.out.println("\t OAType = " + oLO_PropInfoColl.getOAType());
   System.out.println("\t Format = " + oLO_PropInfoColl.getFormat());
   System.out.println("\t Is Get Key? = " + oLO_PropInfoColl.getKey());
   System.out.println("\t Is Required = " + oLO_PropInfoColl.getRequired());
   System.out.println("\t Is Xlat? = " + oLO_PropInfoColl.getXlat());
   System.out.println("\t Is Yesno? = " + oLO_PropInfoColl.getYesno());
   System.out.println("\t Prompt = " + oLO_PropInfoColl.getPrompt());
   System.out.println("\t Length = " + oLO_PropInfoColl.getLength());
   System.out.println("\t DecimalPosition = " + oLO_PropInfoColl.
      getDecimalPosition());
   System.out.println("\t Is Read Only? = " + oLO_PropInfoColl.
      getIsReadOnly());
   System.out.println("\t Is Alt Key? = " + oLO_PropInfoColl.getAltkey());
   System.out.println("\t Is ListBox item? = " + oLO_PropInfoColl.
      getListboxitem());

Object Adapter

The name of the property is OAType, and it holds the value of the object adapter type. Exposing this property and supplying the associated methods enables you to detect possible data type mismatches between the database and the component interface object.

The Java methods are:

Term	Definition
getOAType()	Returns the object adapter type.
getType()	Returns the type of the property of a particular database field.

For example:

public static void printPropertyType(String propName, ICompIntfcPropertyInfo i⇒
PropertyInfo) {
String strOAType = null;
String strDBType = null;
    try {
        switch ((int)iPropertyInfo.getOAType()) {
            /* Object Adapter Type == 0 */
            case CIPropertyTypes.PSPROPERTY_OA_TYPE_BOOL:
                    strOAType = "BOOL";
                    break;
             /* Object Adapter Type == 1 */
             case CIPropertyTypes.PSPROPERTY_OA_TYPE_NUMBER: 
                    strOAType = "INTEGER";
                    break;
             /* Object Adapter Type == 2 */
             case CIPropertyTypes.PSPROPERTY_OA_TYPE_FLOAT: 
                    strOAType = "FLOAT";
                    break;
             /* Object Adapter Type == 3 */
             case CIPropertyTypes.PSPROPERTY_OA_TYPE_STRING: 
                    strOAType = "STRING";
                    break;
            }
        switch ((int)iPropertyInfo.getType()) {
            /* Database Type == 0 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_CHARACTER: 
                    strDBType = "CHARACTER";
                    break;
            /* Database Type == 1 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_LONG_CHARACTER: 
                    strDBType = "LONG_CHARACTER";
                    break;
            /* Database Type == 2 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_NUMBER: 
                    strDBType = "NUMBER";
                    break;
            /* Database Type == 3 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_SIGNED_NUMBER:
                    strDBType = "SIGNED NUMBER";
                    break;
            /* Database Type == 4 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_DATE:
                    strDBType = "DATE";
                    break;
            /* Database Type == 5 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_TIME:
                    strDBType = "TIME";
                    break;
            /* Database Type == 6 */
            case CIPropertyTypes.PSPROPERTY_DB_TYPE_DATETIME: 
                    strDBType = "DATETIME";
                    break;
            }
        }
        catch (Exception e) {
            e.printStackTrace();
        }

        System.out.println("\n" + propName + 
             " Object Adapter Type is:  " + strOAType +
             ", Database Type is:  " + strDBType);
    }

Component Interface Collection Property

This table describes the component interface collection property Count.

Name	Description, Programming Syntax
Count	Returns the number of items in a collection. Java: long getCount() C++: PSI32 CompIntfcCollection_GetCount(HPSAPI_<CI_NAME>)

Data Item Property

This table describes the data item property ItemNum:

Name	Description, Programming Syntax
ItemNum	Returns the position of the row within the given collection of a DataRow. Java: long getItemNum() C++: PSI32 <CI_NAME>_GetItemNum(HPSAPI_<CI_NAME>)

Note:

The component interface classes contain information about PropertyInfo properties and related PeopleCode.