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

Interface PolicyDocumentManagement

public interface PolicyDocumentManagement

Policy documents management API

Author:

P.Piernik

Method Summary

Modifier and Type	Method	Description
long	addPolicyDocument(PolicyDocumentCreateRequest policyDocument)	Adds new policy document
PolicyDocumentWithRevision	getPolicyDocument(long id)	Get single policy document by given id
Collection<PolicyDocumentWithRevision>	getPolicyDocuments()	Gets all policy documents
void	removePolicyDocument(long id)	Removes policy document by given id
void	updatePolicyDocument(PolicyDocumentUpdateRequest policyDocument)	Updates policy document, skip revision update
void	updatePolicyDocumentWithRevision(PolicyDocumentUpdateRequest policyDocument)	Updates policy document.

Method Details

addPolicyDocument

long addPolicyDocument(PolicyDocumentCreateRequest policyDocument)
                throws EngineException

Adds new policy document

Parameters:

policyDocument -

Returns:

created policy document id

Throws:

EngineException

updatePolicyDocument

void updatePolicyDocument(PolicyDocumentUpdateRequest policyDocument)
                   throws EngineException

Updates policy document, skip revision update

Parameters:

policyDocument -

Throws:

EngineException

updatePolicyDocumentWithRevision

void updatePolicyDocumentWithRevision(PolicyDocumentUpdateRequest policyDocument)
                               throws EngineException

Updates policy document. Revision of the updated document is increment

Parameters:

policyDocument -

Throws:

EngineException

removePolicyDocument

void removePolicyDocument(long id)
                   throws EngineException

Removes policy document by given id

Parameters:

id -

Throws:

EngineException

getPolicyDocuments

Collection<PolicyDocumentWithRevision> getPolicyDocuments()
                                                   throws EngineException

Gets all policy documents

Returns:

Throws:

EngineException

getPolicyDocument

PolicyDocumentWithRevision getPolicyDocument(long id)
                                      throws EngineException

Get single policy document by given id

Parameters:

id -

Returns:

Throws:

EngineException