IMessageHeader (Eagle Core API)

All Superinterfaces:: IRogValidatable

All Known Implementing Classes:: MessageHeader

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Fri Dec 05 11:53:59 EST 2025")
 @AdmGenerated(compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 11:53 AM",
              buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding")
public interface IMessageHeader
extends IRogValidatable

The 'MessageHeader' type.

ADM Details

ADM Type	Embedded Entity
Factory	MessageFactory

ADM Field Summary

Field	Type	Id	Description
channelId	String	32729	No doc provided.
credentials	`Credentials`	32732	No doc provided.
error	`ErrorContext`	32730	No doc provided.
origin	String	32737	No doc provided.
requestId	String	32733	No doc provided.
senderVersion	`Version`	32731	No doc provided.
sessionId	String	32735	No doc provided.
sourceId	String	32736	No doc provided.
transactionId	String	32734	No doc provided.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearChannelId()` Clears the value of 'channelId'.
`void`	`clearCredentials()` Clears the value of 'credentials'.
`void`	`clearError()` Clears the value of 'error'.
`void`	`clearOrigin()` Clears the value of 'origin'.
`void`	`clearRequestId()` Clears the value of 'requestId'.
`void`	`clearSenderVersion()` Clears the value of 'senderVersion'.
`void`	`clearSessionId()` Clears the value of 'sessionId'.
`void`	`clearSourceId()` Clears the value of 'sourceId'.
`void`	`clearTransactionId()` Clears the value of 'transactionId'.
`String`	`getChannelId()` Gets the value of 'channelId'.
`<T extends XString> T`	`getChannelIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getChannelIdTo(XString val)` Copies the value of 'channelId' into the provided XString.
`XString`	`getChannelIdUnsafe()` Gets the raw value of 'channelId'.
`Credentials`	`getCredentials()` Gets the value of 'credentials'.
`void`	`getCredentialsTo(Credentials val)` Copies the value of Credentials into the provided value.
`ErrorContext`	`getError()` Gets the value of 'error'.
`void`	`getErrorTo(ErrorContext val)` Copies the value of ErrorContext into the provided value.
`String`	`getOrigin()` Gets the value of 'origin'.
`<T extends XString> T`	`getOriginTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getOriginTo(XString val)` Copies the value of 'origin' into the provided XString.
`XString`	`getOriginUnsafe()` Gets the raw value of 'origin'.
`String`	`getRequestId()` Gets the value of 'requestId'.
`<T extends XString> T`	`getRequestIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getRequestIdTo(XString val)` Copies the value of 'requestId' into the provided XString.
`XString`	`getRequestIdUnsafe()` Gets the raw value of 'requestId'.
`Version`	`getSenderVersion()` Gets the value of 'senderVersion'.
`void`	`getSenderVersionTo(Version val)` Copies the value of Version into the provided value.
`String`	`getSessionId()` Gets the value of 'sessionId'.
`<T extends XString> T`	`getSessionIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSessionIdTo(XString val)` Copies the value of 'sessionId' into the provided XString.
`XString`	`getSessionIdUnsafe()` Gets the raw value of 'sessionId'.
`String`	`getSourceId()` Gets the value of 'sourceId'.
`<T extends XString> T`	`getSourceIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSourceIdTo(XString val)` Copies the value of 'sourceId' into the provided XString.
`XString`	`getSourceIdUnsafe()` Gets the raw value of 'sourceId'.
`String`	`getTransactionId()` Gets the value of 'transactionId'.
`<T extends XString> T`	`getTransactionIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getTransactionIdTo(XString val)` Copies the value of 'transactionId' into the provided XString.
`XString`	`getTransactionIdUnsafe()` Gets the raw value of 'transactionId'.
`boolean`	`hasChannelId()` Checks for the presence of 'channelId'.
`boolean`	`hasCredentials()` Checks for the presence of 'credentials'.
`boolean`	`hasError()` Checks for the presence of 'error'.
`boolean`	`hasOrigin()` Checks for the presence of 'origin'.
`boolean`	`hasRequestId()` Checks for the presence of 'requestId'.
`boolean`	`hasSenderVersion()` Checks for the presence of 'senderVersion'.
`boolean`	`hasSessionId()` Checks for the presence of 'sessionId'.
`boolean`	`hasSourceId()` Checks for the presence of 'sourceId'.
`boolean`	`hasTransactionId()` Checks for the presence of 'transactionId'.
`void`	`lendChannelId(XString val)` Lends the value of 'channelId' to this object.
`void`	`lendCredentials(Credentials val)` 'Lends' a reference of the Credentials to the message for this field.
`void`	`lendError(ErrorContext val)` 'Lends' a reference of the ErrorContext to the message for this field.
`void`	`lendOrigin(XString val)` Lends the value of 'origin' to this object.
`void`	`lendRequestId(XString val)` Lends the value of 'requestId' to this object.
`void`	`lendSenderVersion(Version val)` 'Lends' a reference of the Version to the message for this field.
`void`	`lendSessionId(XString val)` Lends the value of 'sessionId' to this object.
`void`	`lendSourceId(XString val)` Lends the value of 'sourceId' to this object.
`void`	`lendTransactionId(XString val)` Lends the value of 'transactionId' to this object.
`void`	`setChannelId(String val)` Sets the value of 'channelId'.
`void`	`setChannelIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setChannelIdFrom(XString val)` Copies the provided XString value into this object's 'channelId'.
`void`	`setCredentials(Credentials val)` Sets the value of 'credentials'.
`void`	`setError(ErrorContext val)` Sets the value of 'error'.
`void`	`setOrigin(String val)` Sets the value of 'origin'.
`void`	`setOriginFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setOriginFrom(XString val)` Copies the provided XString value into this object's 'origin'.
`void`	`setRequestId(String val)` Sets the value of 'requestId'.
`void`	`setRequestIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setRequestIdFrom(XString val)` Copies the provided XString value into this object's 'requestId'.
`void`	`setSenderVersion(Version val)` Sets the value of 'senderVersion'.
`void`	`setSessionId(String val)` Sets the value of 'sessionId'.
`void`	`setSessionIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSessionIdFrom(XString val)` Copies the provided XString value into this object's 'sessionId'.
`void`	`setSourceId(String val)` Sets the value of 'sourceId'.
`void`	`setSourceIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSourceIdFrom(XString val)` Copies the provided XString value into this object's 'sourceId'.
`void`	`setTransactionId(String val)` Sets the value of 'transactionId'.
`void`	`setTransactionIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setTransactionIdFrom(XString val)` Copies the provided XString value into this object's 'transactionId'.
`Credentials`	`takeCredentials()` 'Takes' a reference to the credentials field from the message.
`ErrorContext`	`takeError()` 'Takes' a reference to the error field from the message.
`Version`	`takeSenderVersion()` 'Takes' a reference to the senderVersion field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable
getValidationErrors, isValid

- Method Detail
  - setOrigin
```
void setOrigin(String val)
```
    Sets the value of 'origin'.
    
    Parameters:
    
    val - The value to set.
  - getOrigin
```
String getOrigin()
```
    Gets the value of 'origin'.
    
    Returns:
    
    The value of 'origin'
  - lendOrigin
```
void lendOrigin(XString val)
```
    Lends the value of 'origin' to this object.
    This method is equivalent to setOrigin except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setOriginFrom
```
void setOriginFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setOrigin(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getOriginTo
```
<T extends XString> T getOriginTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setOriginFrom
```
void setOriginFrom(XString val)
```
    Copies the provided XString value into this object's 'origin'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setOrigin(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getOriginTo
```
void getOriginTo(XString val)
```
    Copies the value of 'origin' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getOrigin() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getOrigin()
  - getOriginUnsafe
```
XString getOriginUnsafe()
```
    Gets the raw value of 'origin'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getOrigin()
  - clearOrigin
```
void clearOrigin()
```
    Clears the value of 'origin'.
    
    See Also:
    
    setOrigin(String)
  - hasOrigin
```
boolean hasOrigin()
```
    Checks for the presence of 'origin'.
    
    See Also:
    
    getOrigin()
  - setSourceId
```
void setSourceId(String val)
```
    Sets the value of 'sourceId'.
    
    Parameters:
    
    val - The value to set.
  - getSourceId
```
String getSourceId()
```
    Gets the value of 'sourceId'.
    
    Returns:
    
    The value of 'sourceId'
  - lendSourceId
```
void lendSourceId(XString val)
```
    Lends the value of 'sourceId' to this object.
    This method is equivalent to setSourceId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setSourceIdFrom
```
void setSourceIdFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setSourceId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getSourceIdTo
```
<T extends XString> T getSourceIdTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setSourceIdFrom
```
void setSourceIdFrom(XString val)
```
    Copies the provided XString value into this object's 'sourceId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSourceId(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getSourceIdTo
```
void getSourceIdTo(XString val)
```
    Copies the value of 'sourceId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSourceId() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getSourceId()
  - getSourceIdUnsafe
```
XString getSourceIdUnsafe()
```
    Gets the raw value of 'sourceId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getSourceId()
  - clearSourceId
```
void clearSourceId()
```
    Clears the value of 'sourceId'.
    
    See Also:
    
    setSourceId(String)
  - hasSourceId
```
boolean hasSourceId()
```
    Checks for the presence of 'sourceId'.
    
    See Also:
    
    getSourceId()
  - setChannelId
```
void setChannelId(String val)
```
    Sets the value of 'channelId'.
    
    Parameters:
    
    val - The value to set.
  - getChannelId
```
String getChannelId()
```
    Gets the value of 'channelId'.
    
    Returns:
    
    The value of 'channelId'
  - lendChannelId
```
void lendChannelId(XString val)
```
    Lends the value of 'channelId' to this object.
    This method is equivalent to setChannelId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setChannelIdFrom
```
void setChannelIdFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setChannelId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getChannelIdTo
```
<T extends XString> T getChannelIdTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setChannelIdFrom
```
void setChannelIdFrom(XString val)
```
    Copies the provided XString value into this object's 'channelId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setChannelId(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getChannelIdTo
```
void getChannelIdTo(XString val)
```
    Copies the value of 'channelId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getChannelId() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getChannelId()
  - getChannelIdUnsafe
```
XString getChannelIdUnsafe()
```
    Gets the raw value of 'channelId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getChannelId()
  - clearChannelId
```
void clearChannelId()
```
    Clears the value of 'channelId'.
    
    See Also:
    
    setChannelId(String)
  - hasChannelId
```
boolean hasChannelId()
```
    Checks for the presence of 'channelId'.
    
    See Also:
    
    getChannelId()
  - setSessionId
```
void setSessionId(String val)
```
    Sets the value of 'sessionId'.
    
    Parameters:
    
    val - The value to set.
  - getSessionId
```
String getSessionId()
```
    Gets the value of 'sessionId'.
    
    Returns:
    
    The value of 'sessionId'
  - lendSessionId
```
void lendSessionId(XString val)
```
    Lends the value of 'sessionId' to this object.
    This method is equivalent to setSessionId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setSessionIdFrom
```
void setSessionIdFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setSessionId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getSessionIdTo
```
<T extends XString> T getSessionIdTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setSessionIdFrom
```
void setSessionIdFrom(XString val)
```
    Copies the provided XString value into this object's 'sessionId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSessionId(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getSessionIdTo
```
void getSessionIdTo(XString val)
```
    Copies the value of 'sessionId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSessionId() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getSessionId()
  - getSessionIdUnsafe
```
XString getSessionIdUnsafe()
```
    Gets the raw value of 'sessionId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getSessionId()
  - clearSessionId
```
void clearSessionId()
```
    Clears the value of 'sessionId'.
    
    See Also:
    
    setSessionId(String)
  - hasSessionId
```
boolean hasSessionId()
```
    Checks for the presence of 'sessionId'.
    
    See Also:
    
    getSessionId()
  - setTransactionId
```
void setTransactionId(String val)
```
    Sets the value of 'transactionId'.
    
    Parameters:
    
    val - The value to set.
  - getTransactionId
```
String getTransactionId()
```
    Gets the value of 'transactionId'.
    
    Returns:
    
    The value of 'transactionId'
  - lendTransactionId
```
void lendTransactionId(XString val)
```
    Lends the value of 'transactionId' to this object.
    This method is equivalent to setTransactionId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setTransactionIdFrom
```
void setTransactionIdFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setTransactionId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getTransactionIdTo
```
<T extends XString> T getTransactionIdTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setTransactionIdFrom
```
void setTransactionIdFrom(XString val)
```
    Copies the provided XString value into this object's 'transactionId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTransactionId(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getTransactionIdTo
```
void getTransactionIdTo(XString val)
```
    Copies the value of 'transactionId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTransactionId() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getTransactionId()
  - getTransactionIdUnsafe
```
XString getTransactionIdUnsafe()
```
    Gets the raw value of 'transactionId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getTransactionId()
  - clearTransactionId
```
void clearTransactionId()
```
    Clears the value of 'transactionId'.
    
    See Also:
    
    setTransactionId(String)
  - hasTransactionId
```
boolean hasTransactionId()
```
    Checks for the presence of 'transactionId'.
    
    See Also:
    
    getTransactionId()
  - setRequestId
```
void setRequestId(String val)
```
    Sets the value of 'requestId'.
    
    Parameters:
    
    val - The value to set.
  - getRequestId
```
String getRequestId()
```
    Gets the value of 'requestId'.
    
    Returns:
    
    The value of 'requestId'
  - lendRequestId
```
void lendRequestId(XString val)
```
    Lends the value of 'requestId' to this object.
    This method is equivalent to setRequestId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setRequestIdFrom
```
void setRequestIdFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    NOTE:
    This is the same as calling setRequestId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getRequestIdTo
```
<T extends XString> T getRequestIdTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setRequestIdFrom
```
void setRequestIdFrom(XString val)
```
    Copies the provided XString value into this object's 'requestId'.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setRequestId(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getRequestIdTo
```
void getRequestIdTo(XString val)
```
    Copies the value of 'requestId' into the provided XString.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getRequestId() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getRequestId()
  - getRequestIdUnsafe
```
XString getRequestIdUnsafe()
```
    Gets the raw value of 'requestId'.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getRequestId()
  - clearRequestId
```
void clearRequestId()
```
    Clears the value of 'requestId'.
    
    See Also:
    
    setRequestId(String)
  - hasRequestId
```
boolean hasRequestId()
```
    Checks for the presence of 'requestId'.
    
    See Also:
    
    getRequestId()
  - setCredentials
```
void setCredentials(Credentials val)
```
    Sets the value of 'credentials'.
    
    Parameters:
    
    val - The value to set.
  - lendCredentials
```
void lendCredentials(Credentials val)
```
    'Lends' a reference of the Credentials to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getCredentials
```
Credentials getCredentials()
```
    Gets the value of 'credentials'.
    
    Returns:
    
    The value of 'credentials'
  - getCredentialsTo
```
void getCredentialsTo(Credentials val)
```
    Copies the value of Credentials into the provided value.
    IF the value is not set, then the contents of the provided Credentials are cleared.
    
    Parameters:
    
    val - the value to copy into
    
    See Also:
    
    Credentials.copyInto(Credentials)
  - takeCredentials
```
Credentials takeCredentials()
```
    'Takes' a reference to the credentials field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - hasCredentials
```
boolean hasCredentials()
```
    Checks for the presence of 'credentials'.
    
    See Also:
    
    getCredentials()
  - clearCredentials
```
void clearCredentials()
```
    Clears the value of 'credentials'.
    
    See Also:
    
    setCredentials(Credentials)
  - setSenderVersion
```
void setSenderVersion(Version val)
```
    Sets the value of 'senderVersion'.
    
    Parameters:
    
    val - The value to set.
  - lendSenderVersion
```
void lendSenderVersion(Version val)
```
    'Lends' a reference of the Version to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getSenderVersion
```
Version getSenderVersion()
```
    Gets the value of 'senderVersion'.
    
    Returns:
    
    The value of 'senderVersion'
  - getSenderVersionTo
```
void getSenderVersionTo(Version val)
```
    Copies the value of Version into the provided value.
    IF the value is not set, then the contents of the provided Version are cleared.
    
    Parameters:
    
    val - the value to copy into
    
    See Also:
    
    Version.copyInto(Version)
  - takeSenderVersion
```
Version takeSenderVersion()
```
    'Takes' a reference to the senderVersion field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - hasSenderVersion
```
boolean hasSenderVersion()
```
    Checks for the presence of 'senderVersion'.
    
    See Also:
    
    getSenderVersion()
  - clearSenderVersion
```
void clearSenderVersion()
```
    Clears the value of 'senderVersion'.
    
    See Also:
    
    setSenderVersion(Version)
  - setError
```
void setError(ErrorContext val)
```
    Sets the value of 'error'.
    
    Parameters:
    
    val - The value to set.
  - lendError
```
void lendError(ErrorContext val)
```
    'Lends' a reference of the ErrorContext to the message for this field.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - getError
```
ErrorContext getError()
```
    Gets the value of 'error'.
    
    Returns:
    
    The value of 'error'
  - getErrorTo
```
void getErrorTo(ErrorContext val)
```
    Copies the value of ErrorContext into the provided value.
    IF the value is not set, then the contents of the provided ErrorContext are cleared.
    
    Parameters:
    
    val - the value to copy into
    
    See Also:
    
    ErrorContext.copyInto(ErrorContext)
  - takeError
```
ErrorContext takeError()
```
    'Takes' a reference to the error field from the message.
    NOTE:
    A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.
    An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - hasError
```
boolean hasError()
```
    Checks for the presence of 'error'.
    
    See Also:
    
    getError()
  - clearError
```
void clearError()
```
    Clears the value of 'error'.
    
    See Also:
    
    setError(ErrorContext)

Interface IMessageHeader

ADM Details

Method Summary

Methods inherited from interface com.neeve.rog.IRogValidatable

Method Detail

setOrigin

getOrigin

lendOrigin

Usage Notes

setOriginFrom

getOriginTo

setOriginFrom

getOriginTo

getOriginUnsafe

clearOrigin

hasOrigin

setSourceId

getSourceId

lendSourceId

Usage Notes

setSourceIdFrom

getSourceIdTo

setSourceIdFrom

getSourceIdTo

getSourceIdUnsafe

clearSourceId

hasSourceId

setChannelId

getChannelId

lendChannelId

Usage Notes

setChannelIdFrom

getChannelIdTo

setChannelIdFrom

getChannelIdTo

getChannelIdUnsafe

clearChannelId

hasChannelId

setSessionId

getSessionId

lendSessionId

Usage Notes

setSessionIdFrom

getSessionIdTo

setSessionIdFrom

getSessionIdTo

getSessionIdUnsafe

clearSessionId

hasSessionId

setTransactionId

getTransactionId

lendTransactionId

Usage Notes

setTransactionIdFrom

getTransactionIdTo

setTransactionIdFrom

getTransactionIdTo

getTransactionIdUnsafe

clearTransactionId

hasTransactionId

setRequestId

getRequestId

lendRequestId

Usage Notes

setRequestIdFrom

getRequestIdTo

setRequestIdFrom

getRequestIdTo

getRequestIdUnsafe

clearRequestId

hasRequestId

setCredentials

lendCredentials

getCredentials

getCredentialsTo

takeCredentials

hasCredentials

clearCredentials

setSenderVersion

lendSenderVersion