QueryRequestInfo class
Stores information that defines the query for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
global class QueryRequestInfo
The QueryRequestInfo class exposes the following members.
Constructors
| Member name | Description |
|---|---|
| QueryRequestInfo class | Creates an instance of the QueryRequestInfo class. |
Methods
| Member name | Description |
|---|---|
| QueryRequestInfo.GetObjectNames method | Gets the list of object names to be queried for the DocGen Package being run. |
Properties
| Member name | Description |
|---|---|
| QueryRequestInfo.DDPId property | Gets or sets the ID of the DocGen Package being run. |
| QueryRequestInfo.DeliveryOptionId property | Gets or sets the ID of the Delivery Option selected for the DocGen Package being run. |
| QueryRequestInfo.FormData property | Gets or sets the form field tags and values of fields included on the DocGen Package form, if applicable, for the DocGen Package being run. |
| QueryRequestInfo.RecordId property | Gets or sets the ID of the record for the DocGen Package being run. |
| QueryRequestInfo.Relationships property | Gets or sets a list of Relationship objects defined for the DocGen Package being run. |
| QueryRequestInfo.TopLevelIds property | Gets or sets a list of Id objects, representing other top-level objects included for the DocGen Package being run. |
Remarks
This class stores information that defines the query for the DocGen Package being run, such as the IDs of the DocGen Package, the selected Delivery Option, the record on which the DocGen Package is being executed, and other top-level objects, as well as any applicable form data from the DocGen Package form, relationships defined for the DocGen Package, and the names of the objects being queried. The class is provided to the query method of a class that has implemented the IApexDataSource interface, to query and return results for the DocGen Package being run.
This class is defined within the ExternalData class.
QueryRequestInfo constructor
Creates an instance of the QueryRequestInfo class.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
QueryRequestInfo()
QueryRequestInfo methods
The QueryRequestInfo class exposes the following members.
Methods
| Member name | Description |
|---|---|
| QueryRequestInfo.GetObjectNames method | Gets the list of object names to be queried for the DocGen Package being run. |
QueryRequestInfo.GetObjectNames method
Gets the list of object names to be queried for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
List<String> GetObjectNames()
Return Value
Type: List<String>
The list of object names to be queried.
Remarks
Each object returned by this method must have a corresponding QueryResult instance in the QueryResultSet instance returned for the corresponding query. For more information, see the query method of the IApexDataSource interface.
QueryRequestInfo properties
The QueryRequestInfo class exposes the following members.
Properties
| Member name | Description |
|---|---|
| QueryRequestInfo.DDPId property | Gets or sets the ID of the DocGen Package being run. |
| QueryRequestInfo.DeliveryOptionId property | Gets or sets the ID of the Delivery Option selected for the DocGen Package being run. |
| QueryRequestInfo.FormData property | Gets or sets the form field tags and values of fields included on the DocGen Package form, if applicable, for the DocGen Package being run. |
| QueryRequestInfo.RecordId property | Gets or sets the ID of the record for the DocGen Package being run. |
| QueryRequestInfo.Relationships property | Gets or sets a list of Relationship objects defined for the DocGen Package being run. |
| QueryRequestInfo.TopLevelIds property | Gets or sets a list of Id objects, representing other top-level objects included for the DocGen Package being run. |
QueryRequestInfo.DDPId property
Gets or sets the ID of the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Id DDPId
Return Value
Type: Id
The ID of the DocGen Package being run.
QueryRequestInfo.DeliveryOptionId property
Gets or sets the ID of the Delivery Option selected for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Id DeliveryOptionId
Return Value
Type: Id
The ID of the Delivery Option selected for the DocGen Package being executed.
QueryRequestInfo.FormData property
Gets or sets the form field tags and values of fields included on the DocGen Package form, if applicable, for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Map<String, String> FormData
Return Value
Type: Map<String, String>
A Map containing the form field tags and values of fields included on the DocGen Package form, if applicable.
QueryRequestInfo.RecordId property
Gets or sets the ID of the record for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Id RecordId
Return Value
Type: Id
The ID of the record for the DocGen Package being run.
QueryRequestInfo.Relationships property
Gets or sets a list of Relationship objects defined for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
List<Relationship> Relationships
Return Value
Type: List<Relationship>
A list of Relationship objects defined for the DocGen Package being run.
QueryRequestInfo.TopLevelIds property
Gets or sets a list of Id objects, representing other top-level objects included for the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Set<Id> TopLevelIds
Return Value
Type: Set<Id>
A list of Id objects, representing other top-level objects included for the DocGen Package being run.