org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704

Class SignalMessage

java.lang.Object

org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704.SignalMessage

public class SignalMessage
extends Object

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>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignalMessage.Builder<_B>
static class	SignalMessage.Select
static class	SignalMessage.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected List<Error>	error
protected MessageInfo	messageInfo
protected PullRequest	pullRequest
protected Receipt	receipt

Constructor Summary

Constructors

Constructor and Description
SignalMessage()

Method Summary

Modifier and Type	Method and Description
static SignalMessage.Builder<Void>	builder()
static SignalMessage.Builder<Void>	copyExcept(SignalMessage _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> SignalMessage.Builder<_B>	copyOf(SignalMessage _other)
static <_B> SignalMessage.Builder<_B>	copyOf(SignalMessage _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static SignalMessage.Builder<Void>	copyOnly(SignalMessage _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(SignalMessage.Builder<_B> _other) Copies all state of this object to a builder.
<_B> void	copyTo(SignalMessage.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse) Copies all state of this object to a builder.
List<Object>	getAny() Gets the value of the any property.
List<Error>	getError() Gets the value of the error property.
MessageInfo	getMessageInfo() Gets the value of the messageInfo property.
PullRequest	getPullRequest() Gets the value of the pullRequest property.
Receipt	getReceipt() Gets the value of the receipt property.
<_B> SignalMessage.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> SignalMessage.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
SignalMessage.Builder<Void>	newCopyBuilder()
SignalMessage.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setMessageInfo(MessageInfo value) Sets the value of the messageInfo property.
void	setPullRequest(PullRequest value) Sets the value of the pullRequest property.
void	setReceipt(Receipt value) Sets the value of the receipt property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messageInfo

protected MessageInfo messageInfo

pullRequest

protected PullRequest pullRequest

receipt

protected Receipt receipt

error

protected List<Error> error

any

protected List<Object> any

Constructor Detail

SignalMessage

public SignalMessage()

Method Detail

getMessageInfo

public MessageInfo getMessageInfo()

Gets the value of the messageInfo property.

Returns:

possible object is MessageInfo

setMessageInfo

public void setMessageInfo(MessageInfo value)

Sets the value of the messageInfo property.

Parameters:

value - allowed object is MessageInfo

getPullRequest

public PullRequest getPullRequest()

Gets the value of the pullRequest property.

Returns:

possible object is PullRequest

setPullRequest

public void setPullRequest(PullRequest value)

Sets the value of the pullRequest property.

Parameters:

value - allowed object is PullRequest

getReceipt

public Receipt getReceipt()

Gets the value of the receipt property.

Returns:

possible object is Receipt

setReceipt

public void setReceipt(Receipt value)

Sets the value of the receipt property.

Parameters:

value - allowed object is Receipt

getError

public List<Error> 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 Error

getAny

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

copyTo

public <_B> void copyTo(SignalMessage.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf(org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704.SignalMessage) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> SignalMessage.Builder<_B> newCopyBuilder(_B _parentBuilder)

newCopyBuilder

public SignalMessage.Builder<Void> newCopyBuilder()

builder

public static SignalMessage.Builder<Void> builder()

copyOf

public static <_B> SignalMessage.Builder<_B> copyOf(SignalMessage _other)

copyTo

public <_B> void copyTo(SignalMessage.Builder<_B> _other,
                        com.kscs.util.jaxb.PropertyTree _propertyTree,
                        com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf(org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704.SignalMessage) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> SignalMessage.Builder<_B> newCopyBuilder(_B _parentBuilder,
                                                     com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                     com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

newCopyBuilder

public SignalMessage.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                  com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

public static <_B> SignalMessage.Builder<_B> copyOf(SignalMessage _other,
                                                    com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                    com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

public static SignalMessage.Builder<Void> copyExcept(SignalMessage _other,
                                                     com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

public static SignalMessage.Builder<Void> copyOnly(SignalMessage _other,
                                                   com.kscs.util.jaxb.PropertyTree _propertyTree)