Interface CommonImportRule

    • Method Detail

      • getArgumentCount

        Long getArgumentCount()
        Get the value for ArgumentCount. (How many arguments are expected for this object.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getVar1

        String getVar1()
        Get the value for Var1. (Variable 1)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getVar2

        String getVar2()
        Get the value for Var2. (Variable 2)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setVar1

        void setVar1​(String newVar1)
        Set the value for Var1. (Variable 1) This value is optional.
        Parameters:
        newVar1 - the new value for Var1.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setVar2

        void setVar2​(String newVar2)
        Set the value for Var2. (Variable 2) This value is optional.
        Parameters:
        newVar2 - the new value for Var2.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getArgumentDescription

        String getArgumentDescription​(Long index)
        Obtain a description for an argument.
        Parameters:
        index - Index (zero-based) of the argument whose description is sought.
        Returns:
        Translatable description of the argument field, or null if the argument is neither expected nor used.
      • getImportRuleDefinition

        ImportRuleDefinition getImportRuleDefinition()
        Retrieve the underlying ImportRuleDefinition.
        Returns:
        ImportRuleDefinition