Package com.helger.phase4.ebms3header

Class Ebms3SignalMessage

java.lang.Object
com.helger.phase4.ebms3header.Ebms3SignalMessage
All Implemented Interfaces:
com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable
@CodingStyleguideUnaware public class Ebms3SignalMessage extends Object implements Serializable, com.helger.commons.lang.IExplicitlyCloneable
In the core part of ebMS-3 specification, an eb:Signal Message is allowed to contain eb:MessageInfo and at most one Receipt Signal, at most one eb:PullRequest element, and/or a series of eb:Error elements. In part 2 of the ebMS-3 specification, new signals may be introduced, and for this reason, an extensibility point is added here to the eb:SignalMessage element to allow it to contain any elements.

Java class for SignalMessage complex type

.

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


 <complexType name="SignalMessage">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="MessageInfo" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}MessageInfo"/>
         <element name="PullRequest" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}PullRequest" minOccurs="0"/>
         <element name="Receipt" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}Receipt" minOccurs="0"/>
         <element name="Error" type="{http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/}Error" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </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

    • Ebms3SignalMessage

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

  • Method Details

    • getMessageInfo

      @Nullable public Ebms3MessageInfo getMessageInfo()
      Gets the value of the messageInfo property.
      Returns:
      possible object is Ebms3MessageInfo

    • setMessageInfo

      public void setMessageInfo(@Nullable Ebms3MessageInfo value)
      Sets the value of the messageInfo property.
      Parameters:
      value - allowed object is Ebms3MessageInfo

    • getPullRequest

      @Nullable public Ebms3PullRequest getPullRequest()
      Gets the value of the pullRequest property.
      Returns:
      possible object is Ebms3PullRequest

    • setPullRequest

      public void setPullRequest(@Nullable Ebms3PullRequest value)
      Sets the value of the pullRequest property.
      Parameters:
      value - allowed object is Ebms3PullRequest

    • getReceipt

      @Nullable public Ebms3Receipt getReceipt()
      Gets the value of the receipt property.
      Returns:
      possible object is Ebms3Receipt

    • setReceipt

      public void setReceipt(@Nullable Ebms3Receipt value)
      Sets the value of the receipt property.
      Parameters:
      value - allowed object is Ebms3Receipt

    • getError

      @Nonnull @ReturnsMutableObject("JAXB implementation style") public List<Ebms3Error> getError()
      Gets the value of the error 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 error property.

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

       getError().add(newItem);

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

      Returns:
      The value of the error 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.

    • 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

    • setError

      public void setError(@Nullable List<Ebms3Error> 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.

    • hasErrorEntries

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

    • hasNoErrorEntries

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

    • getErrorCount

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

    • getErrorAtIndex

      @Nullable public Ebms3Error getErrorAtIndex(@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!

    • addError

      public void addError(@Nonnull Ebms3Error 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 Ebms3SignalMessage 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 Ebms3SignalMessage 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.