Interface OapiMessageRef


public interface OapiMessageRef
A reference to a message by its ID.

The following attributes and references are supported:

  • Method Details

    • getIdentifiers

      OapiIdentifiers getIdentifiers()
      Returns a list of message identifier correlations and assignments.
      Returns:
      a list of message identifier correlations and assignments
      See Also:
    • setIdentifiers

      void setIdentifiers(OapiIdentifiers value)
      Set a list of message identifier correlations and assignments.
      Parameters:
      value - the new value of the 'Identifiers' containment reference.
      See Also:
    • getId

      BigInteger getId()
      Returns a unique numeric identifier.
      Returns:
      a unique numeric identifier
      See Also:
    • setId

      void setId(BigInteger value)
      Set a unique numeric identifier.
      Parameters:
      value - the new value of the 'Id' attribute.
      See Also:
    • getImplMaxOccurs

      Object getImplMaxOccurs()
      Returns the maximum number of times the message may be sent. The default value is "unbounded".
      Returns:
      the maximum number of times the message may be sent
      See Also:
    • setImplMaxOccurs

      void setImplMaxOccurs(Object value)
      Set the maximum number of times the message may be sent.
      Parameters:
      value - the new value of the 'Impl Max Occurs' attribute.
      See Also:
    • getImplMinOccurs

      BigInteger getImplMinOccurs()
      Returns the minimum number of times the message may be sent. The default value is "1".
      Returns:
      the minimum number of times the message may be sent
      See Also:
    • setImplMinOccurs

      void setImplMinOccurs(BigInteger value)
      Set the minimum number of times the message may be sent.
      Parameters:
      value - the new value of the 'Impl Min Occurs' attribute.
      See Also:
    • getMsgType

      String getMsgType()
      Returns a short name defining the message type.
      Returns:
      a short name defining the message type
      See Also:
    • setMsgType

      void setMsgType(String value)
      Set a short name defining the message type.
      Parameters:
      value - the new value of the 'Msg Type' attribute.
      See Also:
    • getName

      String getName()
      Returns the name of the message.
      Returns:
      the name of the message
      See Also:
    • setName

      void setName(String value)
      Set the name of the message.
      Parameters:
      value - the new value of the 'Name' attribute.
      See Also:
    • getScenario

      String getScenario()
      Returns a use case of the message. The default value is "base".
      Returns:
      a use case of the message
      See Also:
    • setScenario

      void setScenario(String value)
      Set a use case of the message.
      Parameters:
      value - the new value of the 'Scenario' attribute.
      See Also: