fferpcore.LinkControlBody

global LinkControlBody()

Creates an empty LinkControlBody.

global String serialize()

Converts the fferpcore.LinkControlBody into a JSON string.

Return Value

This service returns a string object.

global static fferpcore.LinkControlBody deserialize(String jsonString)

Convert the given JSON string into a LinkControlBody.

Input Parameters

Return Value

This service returns a LinkControlBody object.

global static fferpcore.LinkControlBody createInstance()

Not used outside unit tests. Use constructor instead.

global fferpcore.LinkControlBody withStateOk()

Indicates that the linked object was successfully created or updated.

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withStateError()

Indicates that an error occurred when creating or updating the linked object.

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withLinkedObjectId(Id linkedObjectId)

Specifies the ID of the linked object.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global virtual fferpcore.LinkControlBody withLinkId(String linkId)

Specify the ID of the linked target.

Input Parameters

Return Value

The original instance to allow fluent method calls.

global fferpcore.LinkControlBody withLinkDeveloperName(String linkDeveloperName)

Specifies a developer name to identify the link.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withDescription(String description)

Specifies the description of the link.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withErrorMessage(String errorMessage)

Indicates an error occurred and specifies a single associated error message.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withErrorMessages(List<String> errorMessages)

Indicates an error occurred and specifies multiple associated error messages.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global fferpcore.LinkControlBody withErrorBody(fferpcore.ErpErrorBody errorBody)

Indicates an error occurred and specifies an associated error body.

Input Parameters

Return Value

This service returns an LinkControlBody object.

global static fferpcore.MessageDescription.Node getOutgoingDescriptionNode(Schema.SObjectType context, String linkDeveloperName)

Generates a node for use within a fferpcore.MessageDescription to describe an outgoing link control body within a message.

Input Parameters

Return Value

This service returns an MessageDescription.Node 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.

new fferpcore.MessageDescription(
    new fferpcore.Context.SObjectSource(SomeObject__c.CorrelationId__c),
    fferpcore.LinkControlBody.getOutgoingDescriptionNode(SomeObject__c.SObjectType, 'SO_Link'),
    new fferpcore.Context.SObjectContext(SomeObject__c.SObjectType));

global static fferpcore.MessageDescription.Node getResponseDescriptionNode(Schema.SObjectType context, String linkDeveloperName)

Generates a node for use within a fferpcore.MessageDescription to describe a responding link control body within a message.

Input Parameters

Return Value

This service returns an MessageDescription.Node 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.

new fferpcore.MessageDescription(
    new fferpcore.Context.SObjectSource(SomeObject__c.CorrelationId__c),
    fferpcore.LinkControlBody.getResponseDescriptionNode(SomeObject__c.SObjectType, 'SO_Link'),
    new fferpcore.Context.SObjectContext(SomeObject__c.SObjectType));

global String getState()

Gets the state of the link, either 'Ok' or 'Error'.

Return Value

This service returns a string object.

global Id getLinkedObjectId()

Gets the Id of the linked object.

Return Value

This service returns an Id object.

global virtual String getLinkId()

Return Value

The link ID of the target.

global String getLinkDeveloperName()

Gets the developer name used to identify the link.

Return Value

This service returns a string object.

global String getDescription()

Gets the description of the link.

Return Value

This service returns a string object.

global fferpcore.ErpErrorBody getErrorBody()

Gets an error body containing the error messages concerning the link.

Return Value

This service returns an ErpErrorBody object.