Package pl.edu.icm.unity.engine.api.policyDocument

Interface PolicyDocumentManagement

public interface PolicyDocumentManagement
Policy documents management API
Author:
P.Piernik

  • Method Details

    • addPolicyDocument

      long addPolicyDocument(PolicyDocumentCreateRequest policyDocument) throws pl.edu.icm.unity.base.exceptions.EngineException
      Adds new policy document
      Parameters:
      policyDocument -
      Returns:
      created policy document id
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • updatePolicyDocument

      void updatePolicyDocument(PolicyDocumentUpdateRequest policyDocument) throws pl.edu.icm.unity.base.exceptions.EngineException
      Updates policy document, skip revision update
      Parameters:
      policyDocument -
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • updatePolicyDocumentWithRevision

      void updatePolicyDocumentWithRevision(PolicyDocumentUpdateRequest policyDocument) throws pl.edu.icm.unity.base.exceptions.EngineException
      Updates policy document. Revision of the updated document is increment
      Parameters:
      policyDocument -
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • removePolicyDocument

      void removePolicyDocument(long id) throws pl.edu.icm.unity.base.exceptions.EngineException
      Removes policy document by given id
      Parameters:
      id -
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • getPolicyDocuments

      Collection<PolicyDocumentWithRevision> getPolicyDocuments() throws pl.edu.icm.unity.base.exceptions.EngineException
      Gets all policy documents
      Returns:
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException

    • getPolicyDocument

      PolicyDocumentWithRevision getPolicyDocument(long id) throws pl.edu.icm.unity.base.exceptions.EngineException
      Get single policy document by given id
      Parameters:
      id -
      Returns:
      Throws:
      pl.edu.icm.unity.base.exceptions.EngineException