Interface OutboundMessageService

All Superinterfaces:
Service

public interface OutboundMessageService
extends Service
Service for generating outbound data using outbound interfaces from studio.
  • Method Details

    • writeModelBasedOutbound

      java.util.List<Message> writeModelBasedOutbound​(java.util.List<ModelOutboundInterfaceWriteRequest> writeRequests, PlatformUserContext context) throws java.lang.Exception
      Generates an outbound Message for the given OutboundInterface into the destination specified by OutboundQueueName for the list of models passed. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Messages are returned for reference purposes.
      Throws:
      java.lang.Exception
    • writeModelBasedOutbound

      Message writeModelBasedOutbound​(ModelOutboundInterfaceWriteRequest writeRequest, PlatformUserContext context) throws java.lang.Exception
      Generates an outbound Message for the given OutboundInterface into the destination specified by OutboundQueueName for the list of models passed. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Message is returned for reference purposes.
      Throws:
      java.lang.Exception
    • writeNetChangeOutbound

      java.util.List<Message> writeNetChangeOutbound​(java.util.List<OutboundInterfaceWriteRequest> writeRequests, PlatformUserContext context) throws java.lang.Exception
      Generates a NetChange Message for the given OutboundInterface into the destination specified by OutboundQueueName. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Messages are returned for reference purposes.
      Throws:
      java.lang.Exception
    • writeNetChangeOutbound

      Message writeNetChangeOutbound​(OutboundInterfaceWriteRequest writeRequest, PlatformUserContext context) throws java.lang.Exception
      Generates a NetChange Message for the given OutboundInterface into the destination specified by OutboundQueueName. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Message is returned for reference purposes.
      Throws:
      java.lang.Exception
    • writeSysIdBasedOutbound

      java.util.List<Message> writeSysIdBasedOutbound​(java.util.List<SysIdOutboundInterfaceWriteRequest> writeRequests, PlatformUserContext context) throws java.lang.Exception
      Generates an outbound Message for the given OutboundInterface into the destination specified by OutboundQueueName for the list of sysIds passed. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Messages are returned for reference purposes.
      Throws:
      java.lang.Exception
    • writeSysIdBasedOutbound

      Message writeSysIdBasedOutbound​(SysIdOutboundInterfaceWriteRequest writeRequest, PlatformUserContext context) throws java.lang.Exception
      Generates an outbound Message for the given OutboundInterface into the destination specified by OutboundQueueName for the list of sysIds passed. This method will first generate a message on MessageStorageServive and then enqueue it into the OutboundQueue. The enqueued Message is returned for reference purposes.
      Throws:
      java.lang.Exception