CircuitStatus (Isode MHFCM API)

java.lang.Object
- com.isode.mhfcm.CircuitStatus

public class CircuitStatus
extends java.lang.Object

Object used to represent circuit status.

Since:: 16.4

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CircuitStatus.Status
Different types of CircuitStatus message.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CircuitStatus.Status`	`getStatus()`	Determine the status associated with this CircuitStatus
`static CircuitStatus.Status`	`getStatus(java.lang.String c)`	Determine the Status enum for a particular code string
`java.util.Date`	`getTimeOfChange()`	Determine the time of the last state change.
`java.lang.String`	`toString()`

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

- Method Detail
  - getStatus
```
public CircuitStatus.Status getStatus()
```
    Determine the status associated with this CircuitStatus
    
    Returns:
    
    a type. Will never be null.
  - getTimeOfChange
```
public java.util.Date getTimeOfChange()
```
    Determine the time of the last state change. For DATA_BEING_RECEIVED, this is the time of the start of transmission. For all other status values, this is the time of the end of transmission.
    
    Returns:
    
    the time of the last state change
  - getStatus
```
public static CircuitStatus.Status getStatus(java.lang.String c)
```
    Determine the Status enum for a particular code string
    
    Parameters:
    
    c - the code string (must not be null)
    
    Returns:
    
    a Status enum corresponding to the specified code, or null if there is no matching Status
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object