Class AbstractActionManager

    • Field Detail

      • actionFact

        private ActionManagerFactory actionFact
        ActionManager factory used to create new ActionManager
      • aaKey

        private java.lang.String aaKey
        Action name in a Additional Action dictionary
      • actionDictionnary

        protected COSDictionary actionDictionnary
        The action dictionary checked by this class
    • Constructor Detail

      • AbstractActionManager

        AbstractActionManager​(ActionManagerFactory amFact,
                              COSDictionary adict,
                              PreflightContext ctx,
                              java.lang.String aaKey)
        Parameters:
        amFact - Instance of ActionManagerFactory used to create ActionManager to check Next actions.
        adict - the COSDictionary of the action wrapped by this class.
        ctx - the validation context .
        aaKey - The name of the key which identify the action in a additional action dictionary.
    • Method Detail

      • isAdditionalAction

        public boolean isAdditionalAction()
        Returns:
        the isAdditionalAction
      • getActionDictionnary

        public COSDictionary getActionDictionnary()
        Returns:
        the actionDictionary
      • getAdditionalActionKey

        public java.lang.String getAdditionalActionKey()
        Returns:
        the aaKey
      • validNextActions

        protected boolean validNextActions()
                                    throws ValidationException
        This method create a list of Action Managers which represent actions in the Next entry of the current action dictionary. For each Next Action, the innerValid is called and the method returns false if a validation fails.
        Returns:
        True if all Next Action are valid, false otherwise.
        Throws:
        ValidationException
      • valid

        public boolean valid​(boolean additionalActionAuth)
                      throws ValidationException
        Validate an Action dictionary. Return false if the dictionary is invalid (ex : missing key). If the ActionManager represents an AdditionalAction, this method returns false and updates the error list when the additionalActionAuth parameter is set to false. This method call the innerValid method to process specific checks according to the action type. If innerValid successes, all actions contained in the Next entry of the Action dictionary are validated.
        Parameters:
        additionalActionAuth - boolean to know if an additional action is authorized.
        Returns:
        the validation state of the Action dictionary.
        Throws:
        ValidationException
      • innerValid

        protected abstract boolean innerValid()
                                       throws ValidationException
        This method must be implemented by inherited classes to process specific validation.
        Returns:
        True if the action is valid, false otherwise.
        Throws:
        ValidationException