RecordmMsg (IntegrationM Groovy API)

java.lang.Object
- com.cultofbits.integrationm.service.dictionary.recordm.RecordmMsg

```
public class RecordmMsg
extends Object
```
The RecordmMsg class represents an event message related to Record instances. It provides information about the action performed on an instance, the user involved, the instance identifier, the definition version, and the timestamp of the event.
An instance of this class is accessible, in the scripts, through the binded variable called msg.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class RecordmMsg.Field
Represents a field that may have been changed.

Nested Classes
Modifier and Type	Class and Description
`class`	`RecordmMsg.Field` Represents a field that may have been changed.

Constructor Summary

Constructors
Constructor and Description

RecordmMsg(Map<String,Object> msg)

Constructors
Constructor and Description
`RecordmMsg(Map<String,Object> msg)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordmMsg.Field`	`field(String name)` Selects a field name for change detection.
`Object`	`get(String key)` Get one of the message's values.
`String`	`getAction()` Retrieves the action associated with this event.
`String`	`getDefinitionName()` Retrieves the definition name associated to this event.
`Integer`	`getDefinitionVersion()` Retrieves the instance definition version associated with this event.
`Integer`	`getId()` Retrieves the instance identifier associated with this event.
`RecordmInstance`	`getInstance()` Access to the instance in the message.
`RecordmInstance`	`getOldInstance()` Access to the old instance in an update message.
`Map<String,Object>`	`getRaw()` Get the raw representation of the messsage as a `Map`
`Long`	`getTimestamp()` Retrieves the timestamp associated with this event.
`String`	`getUser()` Retrieves the username of the user associated with this event.
`String`	`value(Function<Map<String,Object>,Boolean> predicate)` Shortcut method to get the first value of a field of the updated Instance.
`String`	`value(String name)` Shortcut method to get the first value of a field of the updated Instance.
`Object`	`value(String name, Class aClass)` Shortcut method to get the first value of a field of the updated Instance.
`List<String>`	`values(String name)` Get all the values of fields with the specified name.
`List<Object>`	`values(String name, Class aClass)` Get all the values of fields with the specified name.

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

- Constructor Detail
  - RecordmMsg
```
public RecordmMsg(Map<String,Object> msg)
```
- Method Detail
  - field
```
public RecordmMsg.Field field(String name)
```
    Selects a field name for change detection.
    
    Parameters:
    
    name - the field name
    
    Returns:
    
    a RecordmMsg.Field which can be used to test for changes to any field of this name.
  - get
```
public Object get(String key)
```
    Get one of the message's values.
    
    Parameters:
    
    key - the field
  - getAction
```
public String getAction()
```
    Retrieves the action associated with this event.
    The action represents the type of operation performed on an instance, and it can be one of the following values:
    - add: Indicates that the event represents an addition or creation operation.
    - update: Indicates that the event represents an update or modification operation.
    - delete: Indicates that the event represents a deletion or removal operation.
    Returns:
    
    a String representing the action associated with the event. The possible values are "add", "update", or "delete".
  - getDefinitionName
```
public String getDefinitionName()
```
    Retrieves the definition name associated to this event.
    
    Returns:
    
    a String representing the definition associated with the event.
  - getDefinitionVersion
```
public Integer getDefinitionVersion()
```
    Retrieves the instance definition version associated with this event.
    
    Returns:
    
    an Integer representing the instance definition version associated with the event.
  - getId
```
public Integer getId()
```
    Retrieves the instance identifier associated with this event.
    
    Returns:
    
    an Integer representing the instance identifier associated with the event.
  - getInstance
```
public RecordmInstance getInstance()
```
    Access to the instance in the message.
    Can be the updated instance on update messages or the created instance on create messages.
    
    Returns:
    
    a RecordmInstance
  - getOldInstance
```
public RecordmInstance getOldInstance()
```
    Access to the old instance in an update message.
    On other kinds of messages it returns an empty instance.
    
    Returns:
    
    a RecordmInstance
  - getRaw
```
public Map<String,Object> getRaw()
```
    Get the raw representation of the messsage as a Map
  - getTimestamp
```
public Long getTimestamp()
```
    Retrieves the timestamp associated with this event.
    
    Returns:
    
    a Long representing the timestamp of the event, typically in milliseconds since the epoch.
  - getUser
```
public String getUser()
```
    Retrieves the username of the user associated with this event.
    
    Returns:
    
    a String representing the username of the user associated with the event.
  - value
```
public String value(Function<Map<String,Object>,Boolean> predicate)
```
    Shortcut method to get the first value of a field of the updated Instance.
    
    Parameters:
    
    predicate - a Function that accepts a Map representing each field and returns true when the field matches.
    
    Returns:
    
    the String value of the field.
  - value
```
public String value(String name)
```
    Shortcut method to get the first value of a field of the updated Instance.
    
    Parameters:
    
    name - the name of the field
    
    Returns:
    
    the String value of the field. Use ${value(String, Class)} to get the value as a specific type
  - value
```
public Object value(String name,
                    Class aClass)
```
    Shortcut method to get the first value of a field of the updated Instance.
    
    Parameters:
    
    name - the name of the field
    
    aClass - the type to convert the field to. See ${RecordmInstance.value(String, Class)} for supported types.
    
    Returns:
    
    the value of the field.
  - values
```
public List<String> values(String name)
```
    Get all the values of fields with the specified name.
    Multiple values can be returned for either multiple fields or different fields with the same name.
    
    Parameters:
    
    name - the name of the field(s)
    
    Returns:
    
    a List of the String values of the fields. Use ${values(String, Class)} to get the values as a specific type
  - values
```
public List<Object> values(String name,
                           Class aClass)
```
    Get all the values of fields with the specified name.
    Multiple values can be returned for either multiple fields or different fields with the same name.
    
    Parameters:
    
    name - the name of the field(s)
    
    aClass - the type to convert the field to. See RecordmInstance.value(String, Class) for supported types.
    
    Returns:
    
    a List of the values of the fields.

Class RecordmMsg

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordmMsg

Method Detail

field

get

getAction

getDefinitionName

getDefinitionVersion

getId

getInstance

getOldInstance

getRaw

getTimestamp

getUser

value

value

value

values

values