de.yaacc.yxc.YxcGroupResult Class Reference

Outcome of a group operation. More...

Collaboration diagram for de.yaacc.yxc.YxcGroupResult:

Classes
enum	Outcome
enum	Step
	The step an operation stopped at. More...

Public Member Functions
Outcome	getOutcome ()
boolean	isSuccess ()
Step	getStep ()
String	getDeviceIp ()
String	getDetail ()
String	getGroupId ()
String	toString ()

Static Public Member Functions
static YxcGroupResult	failed (Step step, String deviceIp, String detail)

Detailed Description

Outcome of a group operation.

Expected failures (a device does not answer, refuses a call, or does not reach the expected state in time) are values, not exceptions. getDetail() is English text for logs, not for the UI.

Member Function Documentation

getDeviceIp()

String de.yaacc.yxc.YxcGroupResult.getDeviceIp

(

)

Returns

the address of the device the step was for, null on success or if no device is to blame

getGroupId()

String de.yaacc.yxc.YxcGroupResult.getGroupId

(

)

Returns

the id of the group the operation created or changed, null if there is none

getStep()

Step de.yaacc.yxc.YxcGroupResult.getStep

(

)

Returns

the step that failed, null on success

Referenced by de.yaacc.yxc.YxcGroupMessages.kindOf().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /github/workspace/yaacc/src/main/java/de/yaacc/yxc/YxcGroupResult.java