Foundations Object Model

SubscriptionDescriptionService2

global with sharing class SubscriptionDescriptionService2

Service to extract data from the describers of messaging subscriptions.

Methods

getDescription

global static SubscriptionDescriptionService2.GetDescriptionResult getDescription(EndpointKey endpointKey)

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

Input Parameters

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

Return Value

A GetDescriptionResult containing the description or associated error.

getMarshaller

global static SubscriptionDescriptionService2.GetMarshallerResult getMarshaller(EndpointKey endpointKey)

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

Input Parameters

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

Return Value

A GetMarshallerResult containing the marshaller or associated error.

createDataTargetRoot

global static SubscriptionDescriptionService2.CreateDataTargetRootResult createDataTargetRoot(EndpointKey endpointKey)

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

Input Parameters

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

Return Value

A CreateDataTargetRootResult containing the DataTargetRoot or associated error.

SubscriptionDescriptionService2.ErrorResult

global interface ErrorResult

A result optionally containing errors.

Methods

getErrors

List<String> getErrors()

Return Value

The associated errors.

SubscriptionDescriptionService2.GetDescriptionResult

global interface GetDescriptionResult extends ErrorResult

A result containing a SubscriptionDescription2 or associated error.

This class extends SubscriptionDescriptionService2.ErrorResult

Methods

getDescription

SubscriptionDescription2 getDescription()

Return Value

The associated SubscriptionDescription2.

getDescriptionNotNull

SubscriptionDescription2 getDescriptionNotNull()

Return Value

The associated SubscriptionDescription2, throwing an exception if null.

SubscriptionDescriptionService2.GetMarshallerResult

global interface GetMarshallerResult extends ErrorResult

A result containing a LinkingMessageToTargetObjectMarshaller or associated error.

This class extends SubscriptionDescriptionService2.ErrorResult

Methods

getMarshaller

LinkingMessageToTargetObjectMarshaller getMarshaller()

Return Value

The associated LinkingMessageToTargetObjectMarshaller.

getMarshallerNotNull

LinkingMessageToTargetObjectMarshaller getMarshallerNotNull()

Return Value

The associated LinkingMessageToTargetObjectMarshaller, throwing an exception if null.

SubscriptionDescriptionService2.CreateDataTargetRootResult

global interface CreateDataTargetRootResult extends ErrorResult

A result containing a DataTargetRoot or associated error.

This class extends SubscriptionDescriptionService2.ErrorResult

Methods

getDataTargetRoot

DataTargetRoot getDataTargetRoot()

Return Value

The associated DataTargetRoot.

getDataTargetRootNotNull

DataTargetRoot getDataTargetRootNotNull()

Return Value

The associated DataTargetRoot, throwing an exception if null.

© Copyright 2009–2022 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.