List Object Contract Definition

ListObject contract:

<ListObject name="Lo${NAME}" generateLoadMethod="true" schemaVersion="1.1">
  <DataSource name="${DATASOURCE_REFERENCE}" />
  <Item objectClass="Li${NAME}" />
  <Methods>
    <Method name="beforeSaveAsync" />
    <Method name="afterSaveAsync" />
    <Method name="afterLoadAsync" />
    <Method name="beforeLoadAsync" />
    <Method name="afterDoValidateAsync" />
    <Method name="beforeDoValidateAsync" />
  </Methods>
</ListObject>

<DataSource> Attribute

The DataSource attribute defines the relation of the list object to the data source. It holds the SQL-statement to load the list. By convention, there is a 1:1 relationship between a business object and a datasource for the list object. Each list object contract has just one DataSource node. The only and required attribute of the DataSource element is the unique name of the data source. For example - <DataSource name="DsLoMyBpaMED" />

<Item> Attribute

The Item attribute specifies the class of the list items that this list object contains. The item definition defines the structure and properties of the list items. Each List Object contract has exactly one Item element which specifies its List Item. The only and required attribute of the Item element is the objectClass of the list item. For example - <Item objectClass="LiMyBpaMED" />

<Methods> Attributes

The Method attribute lists all methods available for the list object. Every list object can have both generated and customized methods. Declare all methods of a list object, including pre-, post-, and replace methods in the <Method> sub elements in the <Methods> element. The only and required attribute of the Method sub element is the name of the method. For example:

<Methods>
  <Method name="beforeSaveAsync" />
  <Method name="afterSaveAsync" />
  <Method name="afterLoadAsync" />
  <Method name="beforeLoadAsync" />
  <Method name="afterDoValidateAsync" />
  <Method name="beforeDoValidateAsync" />
  <Method name="loadAsync" />
  <Method name="saveAsync" />
</Methods>

<AdvancedSearchObjects> Attributes

AdvancedSearchObjects attribute contains specifications and profiles to support advanced search options in the app. For more information, see Advanced Search. The AdvancedSearchObjects element has no attributes but a list of AdvancedSearchObject sub elements. The only and required attribute of the AdvancedSearchObject sub element is its unique name.

Use the attributes in AdvancedSearchAttribute node to describe the Advanced Search layout. This table lists the attributes of the AdvancedSearchObject element.

Required and Optional Attributes by Parameter Type

This table lists the required and optional attributes depending on the advanced search parameter type.

Here’s the explanation of the earlier table by using an example.

< AdvancedSearchAttribute label = "LoPrmContracts_PhaseId" property="phase" type="Selection" toggleId="PrmContractPhase" />
< AdvancedSearchAttribute label = "LoPrmContracts_DateFromId" property="dateFrom" type="Date"/>
< AdvancedSearchAttribute label = "LoPrmContracts_DateThruId" property="dateThru" type="Date"/>
< AdvancedSearchAttribute label = "RefSightDistance" property="distance" latitudeProperty="latitude" longitudeProperty="longitude" stepSize="2" editable="true" type="Distance" />
< AdvancedSearchAttribute label = "LoPrmContracts_Owner" property="ownerPKey" lookupProcess="USER::LookupProcess" lookupProcessReturnValue="userPKey" lookupObject="LuUser" lookupObjectDisplayValue="name" type="Lookup" />
<AdvancedSearchObjects>
    <AdvancedSearchObject name="AsoContracts">
      <AdvancedSearchAttributes profileId="default">
        <AdvancedSearchAttribute label="LoPrmContracts_PhaseId" property="phase" type="Selection" toggleId="PrmContractPhase" />
        <AdvancedSearchAttribute label="LoPrmContracts_DateFromId" property="dateFrom" type="Date" />
        <AdvancedSearchAttribute label="LoPrmContracts_DateThruId" property="dateThru" type="Date" />
  < AdvancedSearchAttribute label = "RefSightDistance" property="distance" latitudeProperty="latitude" longitudeProperty="longitude" stepSize="2" editable="true" type="Distance" />
        <AdvancedSearchAttribute label="LoPrmContracts_Owner" property="ownerPKey" lookupProcess="User::LookupProcess" lookupProcessReturnValue="userPKey" lookupObject="LuUser" lookupObjectDisplayValue="name" type="Lookup" />
      </AdvancedSearchAttributes>
    </AdvancedSearchObject>
  </AdvancedSearchObjects>

In this example, if the parameter type is Selection, the required attributes are label, property, and type. It should also include any one of these attributes: toggleId, dataSource, or call, as specified in the table. If the parameter type is Date, the required attributes are label, property, and type. If the parameter type is Distance, the required attributes are label, property, type, longitudeProperty, and latitudeProperty. If the parameter type is Lookup, the required attributes are label, property, type, lookupProcess, lookupProcessReturnValue,lookupObject, and lookupObjectDisplayValue.

<Parameter> Attribute

<Parameter> describes the parameters passed to a certain Process. Parameter is only applicable if the parent <AdvancedSearchAttribute> is of type Lookup. The <Parameter> element contains the <Input> element. <Parameter> itself does not have anyattributes. The table lists the attributes of the <Input> element.

AdvancedSearchAttribute Default Value Macros

These macros can be used as default values where applicable:

<AdvancedSearchAttribute> Comparators

These comparators are valid for the defaultOperator attribute of the <AdvancedSearchAttribute>element.