Package ch.ivyteam.ivy.process.model.value

Class SignalCode

java.lang.Object

ch.ivyteam.ivy.model.SimpleValueObject<String>

ch.ivyteam.ivy.process.model.value.EventCode<SignalCode>

ch.ivyteam.ivy.process.model.value.SignalCode

All Implemented Interfaces:

Serializable, Comparable<SignalCode>

public class SignalCode
extends EventCode<SignalCode>

A Signal code or Signal pattern.

SignalCodes are refined by inserting a colon (:)
Example: new SignalCode("datarepository:updated")

Signal patterns can additionally contain wildcards or macros.
Examples:

• Signal pattern with wildcard: new SignalCode("user:*:created")
• Signal pattern with macro: new SignalCode("order:canceled:<%=in.orderNr%>")

Since:

6.1.0

See Also:

• Serialized Form

API:

This is a public API.

Constructor Summary

Constructors

Constructor	Description
SignalCode(String value)	Creates a SignalCode.

Method Summary

Modifier and Type	Method	Description
static String	getValidationMessage(String signalCode)	Generates a format checker message for the given input
static SignalCode	of(String signalCode)	Creates a new SignalCode object with the given input.

Methods inherited from class ch.ivyteam.ivy.process.model.value.EventCode

append, append, countParts, getPart, getPartAsNumber, isEmpty

Methods inherited from class ch.ivyteam.ivy.model.SimpleValueObject

equals, hashCode, toString

Constructor Details

SignalCode

public SignalCode(String value)

Creates a SignalCode.

 import ch.ivyteam.ivy.process.model.value.SignalCode;
 SignalCode signalCode = new SignalCode("datarepository:updated");

Parameters:

value -

API:

This public API is available in Java.

Method Details

getValidationMessage

public static String getValidationMessage(String signalCode)

Generates a format checker message for the given input

Parameters:

signalCode - to get a validation message for

Returns:

the validation message

API:

This public API is available in Java.

of

public static SignalCode of(String signalCode)

Creates a new SignalCode object with the given input.

 import ch.ivyteam.ivy.process.model.value.SignalCode;
 SignalCode signalCode = SignalCode.of("datarepository:updated");

Parameters:

signalCode - to convert

Returns:

a created SignalCode

Since:

10.0.24 / 12.0

API:

This public API is available in Java.