Console Webservice API

ValidityCheck

Other API in Package

Console

Console System

Internal Console

Method Summary
String getError()

Returns the generic error, if any.

Data getErrors()

If validation fails, this returns the data along with the reason for failed validation. For example, if a column name is FirstName and it fails validation there will be an error message with key FirstNameError.

int getPage()

When used with SmartDocuments, this returns the page number containing invalid data.

boolean isValid()

Returns true if the data passes validation.

  setError(String error)

Sets the main error

  setErrors(Data errorData)

Sets errors if any

  setValid(boolean valid)

Sets valid

String toString()

Returns a description of this object.

Method Detail


String getError()

Returns the generic error, if any.

Returns:  String

Since: 11-01-2012

top

Data getErrors()

If validation fails, this returns the data along with the reason for failed validation. For example, if a column name is FirstName and it fails validation there will be an error message with key FirstNameError.

Returns:  Data

Since: 08-04-2012

top

int getPage()

When used with SmartDocuments, this returns the page number containing invalid data.

Returns:  int

Since: 11-01-2012

top

boolean isValid()

Returns true if the data passes validation.

Returns:  boolean

Since: 08-04-2012

top

setError(String error)

Sets the main error

Parameters:

  • String   error Required parameter.

Since: 04-15-2020

top

setErrors(Data errorData)

Sets errors if any

Parameters:

  • Data   errorData Required parameter.

Since: 04-15-2020

top

setValid(boolean valid)

Sets valid

Parameters:

  • boolean   valid Required parameter.

Since: 04-15-2020

top

String toString()

Returns a description of this object.

Returns:  String

Since: 08-04-2012

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM