Messaging (Oxalis :: AS4 5.3.0 API)

java.lang.Object
- org.oasis_open.docs.ebxml_msg.ebms.v3_0.ns.core._200704.Messaging

```
public class Messaging
extends Object
```
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>
 
```

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Object>`	`any`
`protected String`	`id`
`protected Boolean`	`mustUnderstand`
`protected Boolean`	`mustUnderstand12`
`protected List<SignalMessage>`	`signalMessage`
`protected List<UserMessage>`	`userMessage`

Constructor Summary

Constructors
Constructor and Description

Messaging()

Constructors
Constructor and Description
`Messaging()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Messaging.Builder<Void>`	`builder()`
`static Messaging.Builder<Void>`	`copyExcept(Messaging _other, com.kscs.util.jaxb.PropertyTree _propertyTree)`
`static <_B> Messaging.Builder<_B>`	`copyOf(Messaging _other)`
`static <_B> Messaging.Builder<_B>`	`copyOf(Messaging _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)`
`static Messaging.Builder<Void>`	`copyOnly(Messaging _other, com.kscs.util.jaxb.PropertyTree _propertyTree)`
`<_B> void`	`copyTo(Messaging.Builder<_B> _other)` Copies all state of this object to a builder.
`<_B> void`	`copyTo(Messaging.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.
`String`	`getId()` Gets the value of the id property.
`Map<QName,String>`	`getOtherAttributes()` Gets a map that contains attributes that aren't bound to any typed property on this class.
`List<SignalMessage>`	`getSignalMessage()` Gets the value of the signalMessage property.
`List<UserMessage>`	`getUserMessage()` Gets the value of the userMessage property.
`Boolean`	`isMustUnderstand()` if SOAP 1.1 is being used, this attribute is required
`boolean`	`isMustUnderstand12()` if SOAP 1.2 is being used, this attribute is required
`<_B> Messaging.Builder<_B>`	`newCopyBuilder(_B _parentBuilder)`
`<_B> Messaging.Builder<_B>`	`newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)`
`Messaging.Builder<Void>`	`newCopyBuilder()`
`Messaging.Builder<Void>`	`newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)`
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setMustUnderstand(Boolean value)` Sets the value of the mustUnderstand property.
`void`	`setMustUnderstand12(Boolean value)` Sets the value of the mustUnderstand12 property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - signalMessage
```
protected List<SignalMessage> signalMessage
```
  - userMessage
```
protected List<UserMessage> userMessage
```
  - any
```
protected List<Object> any
```
  - id
```
protected String id
```
  - mustUnderstand
```
protected Boolean mustUnderstand
```
  - mustUnderstand12
```
protected Boolean mustUnderstand12
```
- Constructor Detail
  - Messaging
```
public Messaging()
```
- Method Detail
  - getSignalMessage
```
public List<SignalMessage> 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 SignalMessage
  - getUserMessage
```
public List<UserMessage> 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 UserMessage
  - 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 Element Object
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - isMustUnderstand
```
public Boolean isMustUnderstand()
```
    if SOAP 1.1 is being used, this attribute is required
    
    Returns:
    
    possible object is String
  - setMustUnderstand
```
public void setMustUnderstand(Boolean value)
```
    Sets the value of the mustUnderstand property.
    
    Parameters:
    
    value - allowed object is String
  - isMustUnderstand12
```
public boolean isMustUnderstand12()
```
    if SOAP 1.2 is being used, this attribute is required
    
    Returns:
    
    possible object is Boolean
  - setMustUnderstand12
```
public void setMustUnderstand12(Boolean value)
```
    Sets the value of the mustUnderstand12 property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOtherAttributes
```
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
  - copyTo
```
public <_B> void copyTo(Messaging.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.Messaging) 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> Messaging.Builder<_B> newCopyBuilder(_B _parentBuilder)
```
  - newCopyBuilder
```
public Messaging.Builder<Void> newCopyBuilder()
```
  - builder
```
public static Messaging.Builder<Void> builder()
```
  - copyOf
```
public static <_B> Messaging.Builder<_B> copyOf(Messaging _other)
```
  - copyTo
```
public <_B> void copyTo(Messaging.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.Messaging) 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> Messaging.Builder<_B> newCopyBuilder(_B _parentBuilder,
                                                 com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
```
  - newCopyBuilder
```
public Messaging.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
                                              com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
```
  - copyOf
```
public static <_B> Messaging.Builder<_B> copyOf(Messaging _other,
                                                com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
```
  - copyExcept
```
public static Messaging.Builder<Void> copyExcept(Messaging _other,
                                                 com.kscs.util.jaxb.PropertyTree _propertyTree)
```
  - copyOnly
```
public static Messaging.Builder<Void> copyOnly(Messaging _other,
                                               com.kscs.util.jaxb.PropertyTree _propertyTree)
```

Class Messaging

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

signalMessage

userMessage

any

id

mustUnderstand

mustUnderstand12

Constructor Detail

Messaging

Method Detail

getSignalMessage

getUserMessage

getAny

getId

setId

isMustUnderstand

setMustUnderstand

isMustUnderstand12

setMustUnderstand12

getOtherAttributes

copyTo

newCopyBuilder

newCopyBuilder

builder

copyOf

copyTo

newCopyBuilder

newCopyBuilder

copyOf

copyExcept

copyOnly