Package com.onenetwork.platform.integ.msg

Class OutboundInterfaceWriteRequest

java.lang.Object
com.onenetwork.platform.integ.msg.OutboundInterfaceWriteRequest
Direct Known Subclasses:
ModelOutboundInterfaceWriteRequest, ReportOutboundInterfaceWriteRequest, SysIdOutboundInterfaceWriteRequest
public class OutboundInterfaceWriteRequest
extends java.lang.Object
Encapsulates request parameters required to generate outbound data using a SQL Query without specific input like Model objects or surrogate ids.

  • Constructor Details

    • OutboundInterfaceWriteRequest

      public OutboundInterfaceWriteRequest​(java.lang.String outboundInterfaceName, java.lang.String outboundInterfaceVersion, QueueRef outboundQueueRef, SqlParams sqlParams)
      Parameters:
      outboundInterfaceName - outbound interface name
      outboundInterfaceVersion - outbound interface version (can use null to indicate most recent version)
      outboundQueueRef - queue into which the outbound message should be placed
      sqlParams - parameters to be bound to the query defined in the outbound interface

    • OutboundInterfaceWriteRequest

      public OutboundInterfaceWriteRequest​(java.lang.String outboundInterfaceName, java.lang.String outboundInterfaceVersion, QueueRef outboundQueueRef, SqlParams sqlParams, java.lang.Long netChangeThresholdInMillis)
      Parameters:
      outboundInterfaceName - outbound interface name
      outboundInterfaceVersion - outbound interface version (can use null to indicate most recent version)
      outboundQueueRef - queue into which the outbound message should be placed
      sqlParams - parameters to be bound to the query defined in the outbound interface
      netChangeThreshold - when executed as a net change query, the start date will be reduced by this amount in millis prior to execution; null for no correction

  • Method Details

    • getOutboundInterfaceName

      public java.lang.String getOutboundInterfaceName()
      Returns the outbound interface name

    • getOutboundInterfaceVersion

      public java.lang.String getOutboundInterfaceVersion()
      Returns the outbound interface version

    • getOutboundQueueRef

      public QueueRef getOutboundQueueRef()
      Returns the destination queue

    • getAdditionalOutboundQueueRefs

      public java.util.List<QueueRef> getAdditionalOutboundQueueRefs()
      Returns the additional destination queues

    • setAdditionalOutboundQueueRefs

      public void setAdditionalOutboundQueueRefs​(java.util.List<QueueRef> additionalQueueRefs)
      Parameters:
      queueRefs - - option additional queues if the outbound message needs to be delivered to multiple queues, developer should set this value

    • getSqlParams

      public SqlParams getSqlParams()
      Returns the params to be bound, if any

    • setSqlParams

      public void setSqlParams​(SqlParams sqlParams)
      Sets params to be bound, if any

    • getNetChangeThreshold

      public java.lang.Long getNetChangeThreshold()
      Returns:
      the netChangeThreshold in millis

    • getNetChangeId

      public java.lang.String getNetChangeId()
      Returns:
      the

    • setNetChangeId

      public void setNetChangeId​(java.lang.String netChangeId)
      Parameters:
      netChangeId - - optional netChangeId value if developer does not want autogenerated netChangeId to be used

    • getClientFileName

      public java.lang.String getClientFileName()
      Returns:
      the clientFileName

    • setClientFileName

      public void setClientFileName​(java.lang.String clientFileName)
      Parameters:
      clientFileName - the clientFileName to set

    • isEnqueueInNewTransaction

      public boolean isEnqueueInNewTransaction()
      Returns:
      the enqueueInNewTransaction iff true, will enqueue the message in new transaction. Default value is true

    • setEnqueueInNewTransaction

      public void setEnqueueInNewTransaction​(boolean enqueueInNewTransaction)
      Parameters:
      enqueueInNewTransaction - the enqueueInNewTransaction to set

    • isLocalize

      public boolean isLocalize()
      Returns:
      true iff the results should be localized (e.g. states, enumerations, etc)

    • setLocalize

      public void setLocalize​(boolean localize)
      Parameters:
      localize - set to true iff the results should be localized (e.g. states, enumerations, etc). Default is false.

    • isByteOrderMark

      public boolean isByteOrderMark()
      Returns:
      true iff Byte Order Mark characters should be added to outbound file

    • setByteOrderMark

      public void setByteOrderMark​(boolean byteOrderMark)
      Parameters:
      byteOrderMark - set to true iff Byte Order Mark characters should be added to outbound file

    • getMessageMetadata

      public java.lang.String getMessageMetadata()
      Metadata to be applied to the Message created

    • setMessageMetadata

      public void setMessageMetadata​(java.lang.String messageMetadata)
      Sets the Metadata to be applied to the Message created

    • setInboundInterfaceName

      public void setInboundInterfaceName​(java.lang.String inboundInterfaceName)
      It is sometimes useful to set the inbound interface on a message when generating outbound. For example, this can be used when you enqueue an outbound P2PI message - it will use this inbound interface by default when enqueuing to the destination.
      Parameters:
      inboundInterfaceName - the inboundInterfaceName to set

    • setInboundInterfaceVersion

      public void setInboundInterfaceVersion​(java.lang.String inboundInterfaceVersion)
      It is sometimes useful to set the inbound interface on a message when generating outbound. For example, this can be used when you enqueue an outbound P2PI message - it will use this inbound interface by default when enqueuing to the destination.
      Parameters:
      inboundInterfaceName - the inboundInterfaceName to set

    • getInboundInterfaceName

      public java.lang.String getInboundInterfaceName()

    • getInboundInterfaceVersion

      public java.lang.String getInboundInterfaceVersion()

    • getSender

      public java.lang.String getSender()
      Sender to put on the generated outbound message(s). If not provided, a proper sender for this instance is assigned to the message(s).

    • setSender

      public void setSender​(java.lang.String sender)
      Sender to put on the generated outbound message(s). If not provided, a proper sender for this instance is assigned to the message(s).

    • getPreferredTimeZone

      public java.util.TimeZone getPreferredTimeZone()
      TimeZone in which all Date column should be formatted.

    • setPreferredTimeZone

      public void setPreferredTimeZone​(java.util.TimeZone preferredTimeZone)
      TimeZone in which all Date column should be formatted.

    • getConfigJSON

      public java.lang.String getConfigJSON()
      Additional arbitrary configuration data in JSON format. This data can be retrieved and acted upon within the outbound generator.

    • setConfigJSON

      public void setConfigJSON​(java.lang.String configJSON)
      Additional arbitrary configuration data in JSON format. This data can be retrieved and acted upon within the outbound generator.

    • getActionName

      public java.lang.String getActionName()
      Used to indicate the action which triggered the outbound, in case that needs to be reported in the outbound file

    • setActionName

      public void setActionName​(java.lang.String actionName)
      Used to indicate the action which triggered the outbound, in case that needs to be reported in the outbound file