assetQC
 All Classes Namespaces Files Functions Variables
Public Member Functions | Static Public Attributes
assetQC.api.validator.Validator Class Reference
Inheritance diagram for assetQC.api.validator.Validator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def condition
def getInstance
def logger
def postRun
def preRun
def run

Static Public Attributes

list assetTypes = []
 enable = True
list fixers = []
list hostApps = []
 priority = None

Detailed Description

Defines a validation method 'run' which is used to ensure.

This class is intended to be sub-classed and extended.

Constructor & Destructor Documentation

def assetQC.api.validator.Validator.__init__ (   self,
  instance 
)

Here is the call graph for this function:


Member Function Documentation

def assetQC.api.validator.Validator.condition (   self,
  ctx 
)
Method for sub-classes to override with a condition that the object
will run in.

Return True to indicate the Validator should be run, False otherwise.

Here is the call graph for this function:

def assetQC.api.validator.Validator.postRun (   self,
  ctx 
)
Run after the Fixer 'run' method. 

Users can optionally override this method in a sub-class.

:param ctx: Context of function.
:type ctx: assetQC.api.context.Context 
:return: None

Here is the caller graph for this function:

def assetQC.api.validator.Validator.preRun (   self,
  ctx 
)
Run before the Validator 'run' method. 

Users can optionally override this method in a sub-class.

:param ctx: Context of function.
:type ctx: assetQC.api.context.Context
:return: None

Here is the caller graph for this function:

def assetQC.api.validator.Validator.run (   self,
  ctx 
)
Runs the Validator function on the given Asset Instance 

Users MUST override this method in a sub-class.

:param ctx: Context of function.
:type ctx: assetQC.api.context.Context 
:return: None

Here is the caller graph for this function:


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables