fferpcore.SubscriptionDescriptionService2

global with sharing class SubscriptionDescriptionService2

ErrorResult
GetDescriptionResult
GetMarshallerResult
CreateDataTargetRootResult

Service to extract data from the describers of messaging subscriptions.

Methods

global static fferpcore.SubscriptionDescriptionService2.GetDescriptionResult getDescription(fferpcore.EndpointKey endpointKey)
global static fferpcore.SubscriptionDescriptionService2.GetMarshallerResult getMarshaller(fferpcore.EndpointKey endpointKey)
global static fferpcore.SubscriptionDescriptionService2.CreateDataTargetRootResult createDataTargetRoot(fferpcore.EndpointKey endpointKey)

getDescription

global static fferpcore.SubscriptionDescriptionService2.GetDescriptionResult getDescription(fferpcore.EndpointKey endpointKey)

Obtain the fferpcore.SubscriptionDescription2 for the subscription with the given endpoint key.

Input Parameters

Name	Type	Description
endpointKey	fferpcore.EndpointKey	The endpoint key of the subscription.

Return Value

A GetDescriptionResult containing the description or associated error.

getMarshaller

global static fferpcore.SubscriptionDescriptionService2.GetMarshallerResult getMarshaller(fferpcore.EndpointKey endpointKey)

Obtain the fferpcore.LinkingMessageToTargetObjectMarshaller for the subscription with the given endpoint key.

Input Parameters

Name	Type	Description
endpointKey	fferpcore.EndpointKey	The endpoint key of the subscription.

Return Value

A GetMarshallerResult containing the marshaller or associated error.

createDataTargetRoot

global static fferpcore.SubscriptionDescriptionService2.CreateDataTargetRootResult createDataTargetRoot(fferpcore.EndpointKey endpointKey)

Obtain the fferpcore.DataTargetRoot for the subscription with the given endpoint key.

Input Parameters

Name	Type	Description
endpointKey	fferpcore.EndpointKey	The endpoint key of the subscription.

Return Value

A CreateDataTargetRootResult containing the DataTargetRoot or associated error.

fferpcore.SubscriptionDescriptionService2.ErrorResult

global interface ErrorResult

A result optionally containing errors.

Methods

List<String> getErrors()

getErrors

List<String> getErrors()

Return Value

The associated errors.

fferpcore.SubscriptionDescriptionService2.GetDescriptionResult

global interface GetDescriptionResult extends ErrorResult

A result containing a fferpcore.SubscriptionDescription2 or associated error.

This class extends fferpcore.SubscriptionDescriptionService2.ErrorResult

Methods

SubscriptionDescription2 getDescription()
SubscriptionDescription2 getDescriptionNotNull()

getDescription

SubscriptionDescription2 getDescription()

Return Value

The associated SubscriptionDescription2.

getDescriptionNotNull

SubscriptionDescription2 getDescriptionNotNull()

Return Value

The associated SubscriptionDescription2, throwing an exception if null.

fferpcore.SubscriptionDescriptionService2.GetMarshallerResult

global interface GetMarshallerResult extends ErrorResult

A result containing a fferpcore.LinkingMessageToTargetObjectMarshaller or associated error.

This class extends fferpcore.SubscriptionDescriptionService2.ErrorResult

Methods

LinkingMessageToTargetObjectMarshaller getMarshaller()
LinkingMessageToTargetObjectMarshaller getMarshallerNotNull()

getMarshaller

LinkingMessageToTargetObjectMarshaller getMarshaller()

Return Value

The associated LinkingMessageToTargetObjectMarshaller.

getMarshallerNotNull

LinkingMessageToTargetObjectMarshaller getMarshallerNotNull()

Return Value

The associated LinkingMessageToTargetObjectMarshaller, throwing an exception if null.

fferpcore.SubscriptionDescriptionService2.CreateDataTargetRootResult

global interface CreateDataTargetRootResult extends ErrorResult

A result containing a fferpcore.DataTargetRoot or associated error.

This class extends fferpcore.SubscriptionDescriptionService2.ErrorResult

Methods

DataTargetRoot getDataTargetRoot()
DataTargetRoot getDataTargetRootNotNull()

getDataTargetRoot

DataTargetRoot getDataTargetRoot()

Return Value

The associated DataTargetRoot.

getDataTargetRootNotNull

DataTargetRoot getDataTargetRootNotNull()

Return Value

The associated DataTargetRoot, throwing an exception if null.