IApexDataSource
IApexDataSource interface
Represents a data source that can be used in an Apex Data relationship.
Tip: Samples available on GitHub. For more information, see IApexDataSource and ExternalData samples.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
global interface IApexDataSource
The IApexDataSource interface exposes the following members.
Methods
| Member name | Description |
|---|---|
| IApexDataSource.describeObjects method | Describes the specified objects provided by the IApexDataSource implementation. |
| IApexDataSource.getChildRelationships method | Gets the names of the child objects related to the specified object provided by the IApexDataSource implementation. |
| IApexDataSource.getGlobalDescribe method | Gets the names of the objects available to DDPs from this IApexDataSource implementation. |
| IApexDataSource.query method | Queries and returns the information requested in the specified QueryRequestInfo class instance from the DocGen Package being executed. |
Remarks
Implement this interface to identify the implementation for use with the Apex Data feature in DDPs. All of the methods included with this interface must be implemented.
IApexDataService methods
The IApexDataSource interface exposes the following members.
Methods
| Member name | Description |
|---|---|
| IApexDataSource.describeObjects method | Describes the specified objects provided by the IApexDataSource implementation. |
| IApexDataSource.getChildRelationships method | Gets the names of the child objects related to the specified object provided by the IApexDataSource implementation. |
| IApexDataSource.getGlobalDescribe method | Gets the names of the objects available to DDPs from this IApexDataSource implementation. |
| IApexDataSource.query method | Queries and returns the information requested in the specified QueryRequestInfo class instance from the DocGen Package being executed. |
IApexDataSource.describeObjects method
Describes the specified objects provided by the IApexDataSource implementation.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
List<Loop.ExternalData.DataObject> describeObjects(List<String> objectNames)
Parameters
objectNames
Type: List<String>
A list of object names to be described.
The value of this parameter must represent a subset of the objects defined by the IApexDataSource.getGlobalDescribe method method.
Return Value
Type: List<DataObject>
A list of DataObject classes, each of which represents a specified object.
Remarks
The names of the objects specified in objectNames must be present in the list of object names returned by the IApexDataSource.getGlobalDescribe methodmethod of the IApexDataSource implementation.
All objects and fields referenced by the query method of the IApexDataSource implementation must be included in the results of this method.
IApexDataSource.getChildRelationships method
Gets the names of child objects related to the specified object provided by the IApexDataSource implementation.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Set<String> getChildRelationships(String objectName)
Parameters
objectName
Type: String
The parent object for which to retrieve child objects.
Return Value
Type: Set<String>
A Set containing object names, each of which represents a child object for which the specified object is the parent in a relationship.
Remarks
The name of the object specified in objectName must be present in the list of object names returned by the getGlobalDescribe method of the IApexDataSource implementation.
IApexDataSource.getGlobalDescribe method
Gets the names of objects available to DDPs from this IApexDataSource implementation.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Set<String> getGlobalDescribe()
Return Value
Type: Set<String>
A Set containing object names, each of which represents an object available to DDPs from this IApexDataSource implementation.
Remarks
Any object referenced or returned by other members of this IApexDataSource implementation must be included in the results of this method.
IApexDataSource.query method
Queries and returns the information requested in the specified QueryRequestInfo instance from the DocGen Package being run.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Loop.ExternalData.QueryResultSet query(Loop.ExternalData.QueryRequestInfo requestInfo)
Parameters
requestInfo
Type: ExternalData
The information provided for the query request from the DocGen Package being run.
Return Value
Type: QueryResultSet
A QueryResultSet that represents the information requested in the specified QueryRequestInfo instance from the DocGen Package being executed.
Remarks
The objects and fields referenced in the QueryRequestInfo instance specified in requestInfo must be present in the objects and fields returned by the describeObjects method of the IApexDataSource implementation for the corresponding object names.
When this method is invoked, the QueryRequestInfo instance provides 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. Once the query process is completed, this method returns a QueryResultSet that contains a corresponding QueryResult for each queried object.