Package com.helger.phase4.ebms3header

Class Ebms3Messaging

java.lang.Object
com.helger.phase4.ebms3header.Ebms3Messaging
All Implemented Interfaces:
com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
@CodingStyleguideUnaware public class Ebms3Messaging extends Object implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
The eb:Messaging element is the top element of ebMS-3 headers, and it is placed within the SOAP Header element (either SOAP 1.1 or SOAP 1.2). The eb:Messaging element may contain several instances of eb:SignalMessage and eb:UserMessage elements. However in the core part of the ebMS-3 specification, only one instance of either eb:UserMessage or eb:SignalMessage must be present. The second part of ebMS-3 specification may need to include multiple instances of either eb:SignalMessage, eb:UserMessage or both. Therefore, this schema is allowing multiple instances of eb:SignalMessage and eb:UserMessage elements for part 2 of the ebMS-3 specification. Note that the eb:Messaging element cannot be empty (at least one of eb:SignalMessage or eb:UserMessage element must present).

Java class for Messaging complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="Messaging">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="SignalMessage" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}SignalMessage" maxOccurs="unbounded" minOccurs="0"/>
         <element name="UserMessage" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}UserMessage" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attGroup ref="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}headerExtension"/>
       <anyAttribute processContents='lax' namespace='##other'/>
     </restriction>
   </complexContent>
 </complexType>

This class was annotated by ph-jaxb-plugin -Xph-annotate

This class contains methods created by ph-jaxb-plugin -Xph-equalshashcode

This class contains methods created by ph-jaxb-plugin -Xph-tostring

This class contains methods created by ph-jaxb-plugin -Xph-list-extension

This class contains methods created by ph-jaxb-plugin -Xph-cloneable2

This class contains methods created by ph-jaxb-plugin -Xph-value-extender

See Also:

  • Constructor Details

    • Ebms3Messaging

      public Ebms3Messaging()
      Default constructor
      Note: automatically created by ph-jaxb-plugin -Xph-value-extender

  • Method Details

    • getSignalMessage

      @Nonnull @ReturnsMutableObject("JAXB implementation style") public List<Ebms3SignalMessage> getSignalMessage()
      Gets the value of the signalMessage property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the signalMessage property.

      For example, to add a new item, do as follows: 

       getSignalMessage().add(newItem);

      Objects of the following type(s) are allowed in the list Ebms3SignalMessage

      Returns:
      The value of the signalMessage property.

    • getUserMessage

      @Nonnull @ReturnsMutableObject("JAXB implementation style") public List<Ebms3UserMessage> getUserMessage()
      Gets the value of the userMessage property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the userMessage property.

      For example, to add a new item, do as follows: 

       getUserMessage().add(newItem);

      Objects of the following type(s) are allowed in the list Ebms3UserMessage

      Returns:
      The value of the userMessage property.

    • getAny

      @Nonnull @ReturnsMutableObject("JAXB implementation style") public List<Object> getAny()
      Gets the value of the any property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

      For example, to add a new item, do as follows: 

       getAny().add(newItem);

      Objects of the following type(s) are allowed in the list Object Element

      Returns:
      The value of the any property.

    • getId

      @Nullable public String getId()
      Gets the value of the id property.
      Returns:
      possible object is String

    • setId

      public void setId(@Nullable String value)
      Sets the value of the id property.
      Parameters:
      value - allowed object is String

    • isS11MustUnderstand

      public Boolean isS11MustUnderstand()
      if SOAP 1.1 is being used, this attribute is required
      Returns:
      possible object is String

    • setS11MustUnderstand

      public void setS11MustUnderstand(@Nullable Boolean value)
      Sets the value of the s11MustUnderstand property.
      Parameters:
      value - allowed object is String
      See Also:

    • isS12MustUnderstand

      public boolean isS12MustUnderstand()
      if SOAP 1.2 is being used, this attribute is required
      Returns:
      possible object is Boolean

    • setS12MustUnderstand

      public void setS12MustUnderstand(@Nullable Boolean value)
      Sets the value of the s12MustUnderstand property.
      Parameters:
      value - allowed object is Boolean
      See Also:

    • getOtherAttributes

      @Nullable public Map<QName,String> getOtherAttributes()
      Gets a map that contains attributes that aren't bound to any typed property on this class.

      the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

      Returns:
      always non-null

    • equals

      public boolean equals(Object o)
      Created by ph-jaxb-plugin -Xph-equalshashcode
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Created by ph-jaxb-plugin -Xph-equalshashcode
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Created by ph-jaxb-plugin -Xph-tostring
      Overrides:
      toString in class Object

    • setSignalMessage

      public void setSignalMessage(@Nullable List<Ebms3SignalMessage> aList)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      aList - The new list member to set. May be null.

    • setUserMessage

      public void setUserMessage(@Nullable List<Ebms3UserMessage> aList)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      aList - The new list member to set. May be null.

    • setAny

      public void setAny(@Nullable List<Object> aList)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      aList - The new list member to set. May be null.

    • hasSignalMessageEntries

      public boolean hasSignalMessageEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if at least one item is contained, false otherwise.

    • hasNoSignalMessageEntries

      public boolean hasNoSignalMessageEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if no item is contained, false otherwise.

    • getSignalMessageCount

      @Nonnegative public int getSignalMessageCount()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      The number of contained elements. Always ≥ 0.

    • getSignalMessageAtIndex

      @Nullable public Ebms3SignalMessage getSignalMessageAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      index - The index to retrieve
      Returns:
      The element at the specified index. May be null
      Throws:
      IndexOutOfBoundsException - if the index is invalid!

    • addSignalMessage

      public void addSignalMessage(@Nonnull Ebms3SignalMessage elem)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      elem - The element to be added. May not be null.

    • hasUserMessageEntries

      public boolean hasUserMessageEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if at least one item is contained, false otherwise.

    • hasNoUserMessageEntries

      public boolean hasNoUserMessageEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if no item is contained, false otherwise.

    • getUserMessageCount

      @Nonnegative public int getUserMessageCount()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      The number of contained elements. Always ≥ 0.

    • getUserMessageAtIndex

      @Nullable public Ebms3UserMessage getUserMessageAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      index - The index to retrieve
      Returns:
      The element at the specified index. May be null
      Throws:
      IndexOutOfBoundsException - if the index is invalid!

    • addUserMessage

      public void addUserMessage(@Nonnull Ebms3UserMessage elem)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      elem - The element to be added. May not be null.

    • hasAnyEntries

      public boolean hasAnyEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if at least one item is contained, false otherwise.

    • hasNoAnyEntries

      public boolean hasNoAnyEntries()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      true if no item is contained, false otherwise.

    • getAnyCount

      @Nonnegative public int getAnyCount()
      Created by ph-jaxb-plugin -Xph-list-extension
      Returns:
      The number of contained elements. Always ≥ 0.

    • getAnyAtIndex

      @Nullable public Object getAnyAtIndex(@Nonnegative int index) throws IndexOutOfBoundsException
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      index - The index to retrieve
      Returns:
      The element at the specified index. May be null
      Throws:
      IndexOutOfBoundsException - if the index is invalid!

    • addAny

      public void addAny(@Nonnull Object elem)
      Created by ph-jaxb-plugin -Xph-list-extension
      Parameters:
      elem - The element to be added. May not be null.

    • cloneTo

      public void cloneTo(@Nonnull Ebms3Messaging ret)
      This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb-plugin -Xph-cloneable2
      Parameters:
      ret - The target object to clone to. May not be null.

    • clone

      @Nonnull @ReturnsMutableCopy public Ebms3Messaging clone()
      Created by ph-jaxb-plugin -Xph-cloneable2
      Specified by:
      clone in interface com.helger.commons.lang.IExplicitlyCloneable
      Overrides:
      clone in class Object
      Returns:
      The cloned object. Never null.