Package com.onenetwork.platform.data.validation

Class ValidationContext

java.lang.Object
com.onenetwork.platform.data.validation.ValidationContext
public class ValidationContext
extends java.lang.Object
Describes a validation "context" (e.g. "ZBKS.BookUpdate" or "ZBKS.OrderCancellation"). A validation context is used to determine the validation rules to be run, what data is passed to the rules, and what action is taken if any validation rules fail.

  • Constructor Summary

    Constructors 
    Constructor Description
    ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts)  
    ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, boolean hidden)  
    ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes)  
    ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes, boolean hidden)  
    ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes, boolean hidden, boolean unvalidated)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getName()
    Returns the name of this context.
    java.util.List<java.lang.String> getRuleSubtypes()  
    java.util.Map<java.lang.String,​ValidationSubContext> getSubContexts()
    Returns all this Context's SubContexts, keyed by name.
    boolean isHidden()  
    boolean isUnvalidated()
    If a ValidationContext is unvalidated, expressions using that ValidationContext will not be validated.
    void setHidden​(boolean hidden)  
    void setRuleSubtypes​(java.util.List<java.lang.String> ruleSubtypes)  
    void setUnvalidated​(boolean unvalidated)
    If a ValidationContext is unvalidated, expressions using that ValidationContext will not be validated.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ValidationContext

      public ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts)
      Parameters:
      name - context name
      subContexts - List of all subContexts

    • ValidationContext

      public ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, boolean hidden)
      Parameters:
      name - context name
      subContexts - List of all subContexts
      hidden - set to true if this ValidationContext should not be displayed on the frontend

    • ValidationContext

      public ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes)
      Parameters:
      name -
      subContexts -
      ruleSubtypes -

    • ValidationContext

      public ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes, boolean hidden)
      Parameters:
      name -
      subContexts -
      ruleSubtypes -
      hidden - set to true if this ValidationContext should not be displayed on the frontend

    • ValidationContext

      public ValidationContext​(java.lang.String name, java.util.List<ValidationSubContext> subContexts, java.util.List<java.lang.String> ruleSubtypes, boolean hidden, boolean unvalidated)
      Parameters:
      name -
      subContexts -
      ruleSubtypes -
      hidden -
      unvalidated -

  • Method Details

    • getName

      public java.lang.String getName()
      Returns the name of this context.

    • getSubContexts

      public java.util.Map<java.lang.String,​ValidationSubContext> getSubContexts()
      Returns all this Context's SubContexts, keyed by name.

    • getRuleSubtypes

      public java.util.List<java.lang.String> getRuleSubtypes()
      Returns:
      the ruleSubtypes

    • setRuleSubtypes

      public void setRuleSubtypes​(java.util.List<java.lang.String> ruleSubtypes)
      Parameters:
      ruleSubtypes - the ruleSubtypes to set

    • setHidden

      public void setHidden​(boolean hidden)
      Parameters:
      hidden - set to true if this ValidationContext should not be displayed on the frontend

    • isHidden

      public boolean isHidden()
      Returns:
      true if this ValidationContext should not be displayed on the frontend

    • isUnvalidated

      public boolean isUnvalidated()
      If a ValidationContext is unvalidated, expressions using that ValidationContext will not be validated.
      Returns:
      true if this ValidationContext is unvalidated.

    • setUnvalidated

      public void setUnvalidated​(boolean unvalidated)
      If a ValidationContext is unvalidated, expressions using that ValidationContext will not be validated.
      Parameters:
      unvalidated -