FieldSelectionsHolder

Description

The FieldSelectionsHolder type contains the GetFieldSelections response and any errors for fields that were not successfully returned. The FieldSelectionsHolder type parameters are listed below.

Parameters

Name	Type	Description
field	FieldIdentifier	Holds the identification information for a field.
type	Selection-Type	Indicates the type of field selection.
attribute	Field-Attribute	Indicates the style or selection mode for Binary/Trinary fields.
option	SelectionOption	Holds identification information and ordering information for a field selection.
status	Status	Holds status information for any messages or failures that are encountered.

Usage

The FieldSelectionsHolder type returns available field selections for Single Selection, Multi-Selection, and Binary/Trinary fields that are specified in the GetFieldSelections call. If any errors occur during the call, they are returned in the status element in the order in which they were processed.

XML

The following XML shows FieldSelectionsHolder as seen in GetFieldSelectionsResponse.

<ae:GetFieldSelectionsResponse>
   <ae:return>
      <ae:field xsi:type="ae:FieldIdentifier">
         <ae:displayName>Active/Inactive</ae:displayName>
         <ae:id>80</ae:id>
         <ae:uuid>e90174d9-76fa-4ac2-b2bd-13944626c685</ae:uuid>
         <ae:dbName>ACTIVEINACTIVE</ae:dbName>
      </ae:field>
      <ae:type>BINARY-SELECTION</ae:type>
      <ae:attribute>BINARY-ATTRIBUTE-LISTBOX</ae:attribute>
      <ae:option>
         <ae:id>
            <ae:displayName>Active</ae:displayName>
            <ae:id>0</ae:id>
         </ae:id>
         <ae:orderIndex>0</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>Inactive</ae:displayName>
            <ae:id>1</ae:id>
         </ae:id>
         <ae:orderIndex>1</ae:orderIndex>
      </ae:option>
   </ae:return>
   <ae:return>
      <ae:field xsi:type="ae:FieldIdentifier">
         <ae:displayName>Priority</ae:displayName>
         <ae:id>73</ae:id>
         <ae:uuid>3141e866-7b20-4916-af87-9de705cc4b43</ae:uuid>
         <ae:dbName>PRIORITY</ae:dbName>
      </ae:field>
      <ae:type>SINGLE-SELECTION</ae:type>
      <ae:option>
         <ae:id>
            <ae:displayName>1</ae:displayName>
            <ae:id>18</ae:id>
            <ae:uuid>2270dd22-6c3a-437b-babf-42e59f3ca08a</ae:uuid>
         </ae:id>
         <ae:orderIndex>0</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>2</ae:displayName>
            <ae:id>19</ae:id>
            <ae:uuid>e880ba36-5744-44ca-acfd-b7eb09aee99d</ae:uuid>
         </ae:id>
         <ae:orderIndex>1</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>3</ae:displayName>
            <ae:id>20</ae:id>
            <ae:uuid>a79ad52e-aa2d-4cc3-a2e3-f284dd85810e</ae:uuid>
         </ae:id>
         <ae:orderIndex>2</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>4</ae:displayName>
            <ae:id>21</ae:id>
            <ae:uuid>611a1daa-d1d3-4b88-85d3-c7964af578fa</ae:uuid>
         </ae:id>
         <ae:orderIndex>3</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>5</ae:displayName>
            <ae:id>22</ae:id>
            <ae:uuid>2cf46646-d56d-492b-88e8-6e3b252081f7</ae:uuid>
         </ae:id>
         <ae:orderIndex>4</ae:orderIndex>
      </ae:option>
   </ae:return>
   <ae:return>
      <ae:field xsi:type="ae:FieldIdentifier">
         <ae:displayName>Functional Areas</ae:displayName>
         <ae:id>188</ae:id>
         <ae:uuid>c2e67944-af40-4153-be79-3cce0fd8e17c</ae:uuid>
         <ae:dbName>FUNCTIONAL_AREAS</ae:dbName>
      </ae:field>
      <ae:type>MULTI-SELECTION</ae:type>
      <ae:option>
         <ae:id>
            <ae:displayName>Administrator Tool</ae:displayName>
            <ae:id>65</ae:id>
            <ae:uuid>46da9a27-12eb-428f-bbfd-830540973269</ae:uuid>
         </ae:id>
         <ae:orderIndex>0</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>End User Interface</ae:displayName>
            <ae:id>66</ae:id>
            <ae:uuid>3514834d-e105-47fa-ba85-3b2fa847e120</ae:uuid>
         </ae:id>
         <ae:orderIndex>1</ae:orderIndex>
      </ae:option>
      <ae:option>
         <ae:id>
            <ae:displayName>Installer</ae:displayName>
            <ae:id>67</ae:id>
            <ae:uuid>3988a7d9-277e-473f-8b15-9b9842ab01b7</ae:uuid>
         </ae:id>
         <ae:orderIndex>2</ae:orderIndex>
      </ae:option>
   </ae:return>
</ae:GetFieldSelectionsResponse>