global static void registerProduct(fferpcore.RegistrationService.RegistrationRequest request)

Register a Foundations Product with all of its potential subscriptions and publications. If the product is already registered then the registration will be updated as for an upgrade.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global static void unregisterProduct(String developerName)

Remove a product, its publications and subscribers. It may not be possible to remove all rows due to referential integrity. In this situation the product and any remaining publications/subscribers need to be marked as obsolete.

Input Parameters

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.

global without sharing class HCMUninstall implements UninstallHandler
{
    global void onUninstall(UninstallContext context)
    {
        fferpcore.RegistrationService.unregisterProduct('HCM');
    }
}

global RegistrationRequest(String developerName, String name, System.Version version)

Constructor that specifies the developer name, name and version for a product we want to register with Foundations.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.RegistrationRequest withProductProxy(String productProxy)

This fluent method is used to specify a product proxy developer name associated with all publications and subscriptions for this product.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global String getDeveloperName()

Return Value

The developer name associated with the product this registration represents.

global String getName()

Return Value

The name associated with the product this registration represents.

global Version getVersion()

Return Value

The version number associated with the product this registration represents.

global List<fferpcore.RegistrationService.PublicationRequest> getPublicationRequests()

Return Value

Any publications requests associated with this registration.

global List<fferpcore.RegistrationService.SubscriptionRequest> getSubscriptionRequests()

Return Value

Any subscriptions requests associated with this registration.

global String getProductProxy()

Return Value

The product proxy name associated with this registration.

global fferpcore.RegistrationService.PublicationRequest addPublication(String messageTypeDeveloperName)

This fluent method is used to add a publication request. When the RegistrationRequest is registered with Foundations this PublicationRequest will become a Publication object associated with the linked product specified in this registration request.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest addSubscription(String messageTypeDeveloperName, Type messageHandler)

This fluent method is used to add a subscription request. When the RegistrationRequest is registered with Foundations this SubscriptionRequest will become a Subscription object associated with the linked product specified in this registration request.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global PublicationRequest(String messageTypeDeveloperName)

Constructor that specifies which message type this publication will be associated with.
This method should not be called directly as it will be called implicitly when a RegistrationRequest adds a publication.

Input Parameters

global fferpcore.RegistrationService.PublicationRequest withDescription(String value)

This fluent method is used to specify a description for this publication when registered with Foundations.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.PublicationRequest withDocumentationUrl(String value)

This fluent method is used to specify a URL pointing to this publications online help page.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.PublicationRequest withDescriber(Type describer)

This fluent method is used to specify a describer for this publication when registered with Foundations. The describer class specifies the structure of the messages sent from this publication.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.PublicationRequest withIdentifier(String identifier)

This fluent method is used to specify a identifier associated with this publication.
This identifier cannot be the same for any 2 publications:
- With the same Product
- With the same fferpcore.Message Type
- With the same Product Proxy

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.PublicationRequest withSendingHook(Type sendingHook)

Specifies the sending hook responsible for delivering the messages.

Input Parameters

Return Value

The PublicationRequest. This enables other methods to be invoked.

global fferpcore.RegistrationService.PublicationRequest withReplacedIdentifier(String identifier)

Specifies the identifier of an existing publication, which is to be overridden.

Input Parameters

Return Value

The PublicationRequest. This enables other methods to be invoked.

global fferpcore.RegistrationService.PublicationRequest withMessageTypeDescription(String description)

Specifies a description for the message type. This is only used if the message type does not currently exist or does not have a description.

Input Parameters

Return Value

The PublicationRequest. This enables other methods to be invoked.

global fferpcore.RegistrationService.PublicationRequest withVirtualObject(String virtualObject, String provider)

Specify the associated virtual object and provider.

Input Parameters

Return Value

The PublicationRequest. This enables other methods to be invoked.

global fferpcore.RegistrationService.PublicationRequest withSourceObject(String sourceObject)

Specify the associated source object. For example, Account.

Input Parameters

Return Value

The PublicationRequest. This enables other methods to be invoked.

global String getMessageTypeDeveloperName()

Return Value

The developer name associated with the message type assigned to this publication.

global String getMessageTypeDescription()

Return Value

The description of the message type associated with this publication.

global String getDescription()

Return Value

The description assigned to this publication.

global String getDocumentationUrl()

Return Value

The documentation url assigned to this publication.

global Type getDescriber()

Return Value

The describer class assigned to this publication.

global String getIdentifier()

Return Value

The identifier associated with this publication request.

global Type getSendingHook()

Return Value

The class responsible for delivering the messages.

global Boolean isReplacement()

Return Value

A boolean value that indicates whether this publication is to override an existing publication.

global String getReplacedIdentifier()

Return Value

The identifier of an existing publication, which is to be overridden.

global String getVirtualObject()

Return Value

The virtual object to be published.

global String getVirtualObjectProvider()

Return Value

The source of the data used to generate the virtual objects.

global String getSourceObject()

Return Value

The associated source object.

global SubscriptionRequest(String messageTypeDeveloperName, Type messageHandler)

Constructor that specifies which message type this subscription will be associated with and which class will be invoked when this subscription receives messages.
This method should not be called directly as it will be called implicitly when a RegistrationRequest adds a subscription.

Input Parameters

global fferpcore.RegistrationService.SubscriptionRequest withExcludeFromSelf(Boolean value)

Input Parameters

global fferpcore.RegistrationService.SubscriptionRequest withDeliveryOrder(Integer value)

Use within a product to ensure dependent messages are delivered in the right order, for example Skills after Workers so a Worker exists before Skills are added to it.

Input Parameters

global fferpcore.RegistrationService.SubscriptionRequest withDescription(String value)

This fluent method is used to specify a description for this subscription when registered with Foundations.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withDocumentationUrl(String value)

This fluent method is used to specify a URL pointing to this subscriptions online help page.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withHandlerData(String value)

This fluent method is used to specify handler data for this subscription when registered with Foundations.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withBulkCapacity(Integer value)

This fluent method is used to specify the number of messages can be received at once during a batch job for this subscription when registered with Foundations.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withSynchronousCapacity(Integer value)

This fluent method is used to specify the number of messages that can be received at once during synchronous operation. The subscription is enabled for automatic switching to batch delivery when the number of messages exceeds this threshold.

global fferpcore.RegistrationService.SubscriptionRequest withDescriber(Type value)

This fluent method is used to specify the describer for this subscription when registered with Foundations. The describer class specifies the information this subscription looks for when it receives a message.

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withIdentifier(String identifier)

This fluent method is used to specify a identifier associated with this subscription. This identifier cannot be the same for any 2 subscriptions:
- With the same Product
- With the same fferpcore.Message Type
- With the same Product Proxy

Input Parameters

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.

global without sharing class ClickLinkInstall implements InstallHandler
{
    global void onInstall(InstallContext context)
    {
        fferpcore.RegistrationService.RegistrationRequest request = 
            new fferpcore.RegistrationService.RegistrationRequest('HCM', 'HCM Name', new Version(1, 0, 0)).
                withProductProxy('ClickLink');

        request.addPublication('Resource.Update').
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withDescriber(ThisPublicationsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        request.addSubscription('Resource.Update', YourHandlerClass.class).
            withExcludeFromSelf(true).
            withDeliveryOrder(1).
            withDescription('I handle the Resource.Update message type for the HCM_FakeWorker__c object.').
            withDocumentationURL('http://financialforce.com').
            withHandlerData('I am handler data').
            withBulkCapacity(500).
            withDescriber(ThisSubscriptionsDescriber.class).
            withIdentifier('HCM_FakeWorker__c');

        fferpcore.RegistrationService.registerProduct(request);
    }
}

global fferpcore.RegistrationService.SubscriptionRequest withAutomaticLinkControlOnException(String errorLinkDeveloperName, fferpcore.RegistrationService.PublicationRequest errorPublication)

This fluent method is used to specify a publication and link control developer name (id) on which to send error details if an exception is thrown from the delivery handler.

Input Parameters

global fferpcore.RegistrationService.SubscriptionRequest withMessageTypeDescription(String description)

Specifies a description for the message type. This is only used if the message type does not currently exist or does not have a description.

Input Parameters

Return Value

The SubscriptionRequest. This enables other methods to be invoked.

global fferpcore.RegistrationService.SubscriptionRequest withVirtualObject(String targetObject, String consumer)

Specify the associated target object and consumer.

Input Parameters

Return Value

The SubscriptionRequest. This enables other methods to be invoked.

global String getMessageTypeDeveloperName()

Return Value

The developer name of the message type associated with this subscription.

global String getMessageTypeDescription()

Return Value

The description of the message type associated with this subscription.

global Type getMessageHandler()

Return Value

The message handler class which will be invoked when this subscription receives a message.

global Boolean isExcludeFromSelf()

Return Value

Whether or not this subscription will receive messages from a publication which sends messages on the same message type in the same product.

global Integer getDeliveryOrder()

Return Value

The order that this subscription will receive messages in.

global String getDescription()

Return Value

The description assigned to this subscription.

global String getDocumentationUrl()

Return Value

The documentation url assigned to this subscription.

global String getHandlerData()

Return Value

The handler data assigned to this subscription.

global Integer getBulkCapacity()

Return Value

The bulk capacity assigned to this subscription.

global Type getDescriber()

Return Value

The describer class assigned to this subscription.

global String getIdentifier()

Return Value

The identifier associated with this publication request.

global fferpcore.RegistrationService.PublicationRequest getErrorPublication()

Return Value

The error publication assigned to this subscription.

global String getErrorLinkDeveloperName()

Return Value

The error link control developer name with this publication request.

global Integer getSynchronousCapacity()

Return Value

The synchronous capacity before the subscription receives delivieries in batch.

global String getTargetObject()

Return Value

The name of the object being created.

global String getVirtualObjectConsumer()

Return Value

The name of the consumer. Used on corresponding VirtualDataObjectTargetMapping records.