Package com.flower.docs.service.api.scope

Interface ScopeService

  • All Superinterfaces:
    CRUDService<com.flower.docs.domain.scope.Scope>
    public interface ScopeService
extends CRUDService<com.flower.docs.domain.scope.Scope>
    Manages Business scopes
    Author:
    Florian Deruette

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<com.flower.docs.domain.scope.Scope> getAll()
      Get all Scope corresponding to the Scope
      com.flower.docs.domain.file.DocumentFile getRules​(boolean includeContent)
      Gets the files used to determines scope business rules
      com.flower.docs.domain.file.DocumentFile setRules​(com.flower.docs.domain.file.DocumentFile ruleFile)
      Sets the files used to determines scope business rules

    • Method Detail

      • getAll

        java.util.List<com.flower.docs.domain.scope.Scope> getAll()
                                                   throws com.flower.docs.domain.exception.TechnicalException,
                                                          com.flower.docs.domain.exception.FunctionalException
        Get all Scope corresponding to the Scope
        Returns:
        All scopes
        Throws:
        com.flower.docs.domain.exception.TechnicalException
        com.flower.docs.domain.exception.FunctionalException

      • setRules

        com.flower.docs.domain.file.DocumentFile setRules​(com.flower.docs.domain.file.DocumentFile ruleFile)
                                           throws com.flower.docs.domain.exception.TechnicalException,
                                                  com.flower.docs.domain.exception.FunctionalException
        Sets the files used to determines scope business rules
        Parameters:
        ruleFile - The file providing business rules Scope.getFile()
        Returns:
        The stored file without content
        Throws:
        com.flower.docs.domain.exception.TechnicalException
        com.flower.docs.domain.exception.FunctionalException

      • getRules

        com.flower.docs.domain.file.DocumentFile getRules​(boolean includeContent)
                                           throws com.flower.docs.domain.exception.TechnicalException,
                                                  com.flower.docs.domain.exception.FunctionalException
        Gets the files used to determines scope business rules
        Parameters:
        includeContent - Determines if the file should be got with its content or not DocumentFile.getContent()
        Returns:
        The rule file
        Throws:
        com.flower.docs.domain.exception.TechnicalException
        com.flower.docs.domain.exception.FunctionalException