com.smarterapps.automateitplugin.sdk

Class PluginValidationResult

java.lang.Object

com.smarterapps.automateitplugin.sdk.PluginValidationResult

public final class PluginValidationResult
extends java.lang.Object

This class represents a validation result of a PluginTrigger and PluginAction.
It is used to indicate whether the validated object has passed all validation checks and can be used by AutomateIt

See Also:

PluginTrigger.validateData(Context, PluginDataFieldCollection), PluginAction.validateData(Context, PluginDataFieldCollection)

Constructor Summary

Constructors

Constructor and Description
PluginValidationResult(boolean isValid, java.lang.String errorMessage) Instantiates a new plugin validation result.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Gets the error message.
static PluginValidationResult	getValidResult() Returns a valid result object
boolean	isValid() Returns the validation result indication (valid/invalid)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginValidationResult

public PluginValidationResult(boolean isValid,
                              java.lang.String errorMessage)

Instantiates a new plugin validation result.

Parameters:

isValid - The validation result indication (valid/invalid)

errorMessage - The error message. set to empty string if no error message is specified

Method Detail

getValidResult

public static PluginValidationResult getValidResult()

Returns a valid result object

Returns:

a valid result object

isValid

public boolean isValid()

Returns the validation result indication (valid/invalid)

Returns:

True, if is valid

getErrorMessage

public java.lang.String getErrorMessage()

Gets the error message.

Returns:

The error message, or empty string if no error is set