global static String createToken()

Creates a new 36 character token for use in a new process. The token is derived from the current time and current user. This is has reasonable likelihood of being unique.

global static fferpcore.ProcessMessage forNewProcess(Id recordId, String processToken, String replyTo)

Creates a Process fferpcore.Message for a new process.

Input Parameters

Return Value

The generated ProcessMessage

global static fferpcore.ProcessMessage newCompleteMessage(Id recordId, String processToken, Map<String, Object> userData)

Creates a Process fferpcore.Message to signify that a process is complete.

Input Parameters

Return Value

The generated ProcessMessage

global static fferpcore.ProcessMessage fromMessage(Map<String, Object> messageBody)

Deserializes a fferpcore.ProcessMessage from a message body that has already been deserialized using JSON.deserializeUntyped(). See DeliveredMessage.getDeserializedBody().

Input Parameters

Return Value

The deserialized ProcessMessage.

global Integer getMessageVersion()

Return Value

The Process Message Version of this messsage.

global fferpcore.ProcessMessage createReply(String responseState, String message)

Creates a reply to the message with the state and message provided.

Input Parameters

Return Value

The generated ProcessMessage.

global String serialize()

Serializes the message for delivery over Foundations.

global Id getSubjectId()

Return Value

The ID of the record that is the subject of this process message.

global String getProcessToken()

Return Value

The token that identifies this attempt at the process.

global String getStatus()

Return Value

The process status code.

global void setStatus(String status)

Input Parameters

global String getMessage()

Return Value

The optional message associated with the status.

global void setMessage(String message)

Input Parameters

global Map<String, Object> getData()

Return Value

The map of user data values that will be included with the message.

global String getReplyTo()

Return Value

The message type developer name on which the process initiator expects to receive replies.

global Boolean isComplete()

Return Value

True of the process status is PROCES_STATE_COMPLETE

global Boolean isPending()

Return Value

True of the process status is PROCES_STATE_PENDING

global MessageDescriptionBuilder(SObjectType objectType, SObjectField correlationField)

Constructs a MessageDescriptionBuilder.

Input Parameters

global fferpcore.ProcessMessage.MessageDescriptionBuilder withReplyToMessageType(String replyTo)

Specifies a value for the Process fferpcore.Message Reply To message key. Used by the initiator of the process.

Input Parameters

Return Value

This MessageDescriptionBuilder to support fluent coding style.

global fferpcore.ProcessMessage.MessageDescriptionBuilder withMessageVersion(Integer version)

Specifies a value for the Process fferpcore.Message Version message key.

Input Parameters

Return Value

This MessageDescriptionBuilder to support fluent coding style.

global fferpcore.ProcessMessage.MessageDescriptionBuilder withHeaderFields(Map<String, fferpcore.MessageDescription.Node> fields)

Specifies additional message description fields to include in the process message header. The fields are applied after the standard fields. As a result, standard fields can be overwritten. We recommend prefixing custom header fields with 'X-'.

Input Parameters

Return Value

This MessageDescriptionBuilder to support fluent coding style.

global fferpcore.ProcessMessage.MessageDescriptionBuilder withDataFields(Map<String, fferpcore.MessageDescription.Node> fields)

Specifies additional message descripton fields to include in the data part of the process message.

Input Parameters

Return Value

This MessageDescriptionBuilder to support fluent coding style.

global fferpcore.MessageDescription build()

Constructs a fferpcore.MessageDescription based on the current state of the MessageDescriptionBuilder.

global ProcessMessageContext()

global ProcessMessageContext(SObjectType subjectType)

The default is for internal use only and is not recommended for use. Use the constructor that takes SObjectType as an argument instead.

global virtual override Type getClass()

This method is provided to support serialization to Javascript. This method returns the class type of the associated context.

Return Value

This service returns a Type object.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

fferpcore.Context.SObjectContext context = new fferpcore.Context.SObjectContext(ExampleObject__c.SObjectType);

System.assertEquals(fferpcore.Context.SObjectContext.class, context.getClass());

global virtual override List<fferpcore.Context.Source> getPotentialChildren()

This method returns a complete list of the fields on this particular SObject that are in the form of a Context.Source.

Return Value

This service returns a list of Source objects.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * We will assume the following fields only on ExampleObject__c:
 * Name
 * Email__c
 * Phone__c
 * Address__c
 * In reality use this would return all standard Salesforce fields eg. CreatedById etc
 */

fferpcore.Context.SObjectContext context = new fferpcore.Context.SObjectContext(ExampleObject__c.SObjectType);

List<fferpcore.Context.Source> returnValue = context.getPotentialChildren();

System.assertEquals(4, returnValue.size());

global virtual override fferpcore.Context.Source getSource(String key)

This method looks up a source by using its key if that key is related to the current context.

Input Parameters

Return Value

This service returns a Source object.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * We will assume the following fields only on ExampleObject__c:
 * Name
 * Email__c
 * Phone__c
 * Address__c
 * In actual use this would return all standard Salesforce fields eg. CreatedById etc
 */

fferpcore.Context.SObjectContext context = new fferpcore.Context.SObjectContext(ExampleObject__c.SObjectType);

fferpcore.Context.Source returnValue = context.getSource('Name');

System.assertEquals('Name', returnValue.getKey());

global NewProcessMessageDataSource(SObjectType objectType, Set<Id> recordIds, String processToken)

Constructs a fferpcore.DataSource for a new process.

Input Parameters

global override void requireField(String key)

Implementation of the requireField() method from DataSource.

Input Parameters

global override Iterator<fferpcore.DataSource.Row> runQuery()

Implementation of the runQuery() method from DataSource.

global ExistingProcessMessageDataSource(SObjectType objectType, Map<Id, fferpcore.ProcessMessage> messages)

Constructs an ExistingProcessMessageDataSource.

Input Parameters

global override void requireField(String key)

Implementation of the requireField() method from DataSource.

Input Parameters

global override Iterator<fferpcore.DataSource.Row> runQuery()

Implementation of the runQuery() method from DataSource.