Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Properties
SCValidationRule

Object containing a validation rule. More...

Public Member Functions

IValidationRuleResult Execute (SCDocument doc, SCExtractionResult field, SCProcess batch)
 Execute a validation check on the passed through field on a given document. More...
 

Properties

string Description [get]
 Description of the locator. More...
 
Guid Id [get]
 GUID of the locator. More...
 
string Name [get]
 Name of the locator. More...
 
ValidationRuleTypes ValidationRuleType [get]
 Validation rule type of the locator. More...
 

Detailed Description

Object containing a validation rule.

Member Function Documentation

◆ Execute()

IValidationRuleResult Execute ( SCDocument  doc,
SCExtractionResult  field,
SCProcess  batch 
)
inline

Execute a validation check on the passed through field on a given document.

Parameters
docDocument to check
fieldExtraction field to use
batchBatch object required for execution of script validation rules

Property Documentation

◆ Description

string Description
get

Description of the locator.

◆ Id

Guid Id
get

GUID of the locator.

◆ Name

string Name
get

Name of the locator.

◆ ValidationRuleType

ValidationRuleTypes ValidationRuleType
get

Validation rule type of the locator.