Package com.logicaldoc.enterprise.reading

Class ReadingRequestTool

java.lang.Object

com.logicaldoc.enterprise.reading.ReadingRequestTool

public class ReadingRequestTool
extends Object

Utility methods to handle reading requests from within Automation

Since:

8.8.6

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
ReadingRequestTool()

Method Summary

Modifier and Type	Method	Description
void	askReadingConfirmation(long docId, long recipientId, long requestorId, boolean alertConfirmation, String comment)	Asks a user to confirm the reading of a document
void	askReadingConfirmation(Collection<Long> docIds, Collection<Long> userIds, Collection<Long> groupIds, long requestorId, boolean alertConfirmation, String comment, com.logicaldoc.core.document.DocumentHistory transaction)	Asks some users to confirm the reading of a set of documents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReadingRequestTool

public ReadingRequestTool()

Method Details

askReadingConfirmation

public void askReadingConfirmation(long docId,
 long recipientId,
 long requestorId,
 boolean alertConfirmation,
 String comment)
                            throws com.logicaldoc.core.PersistenceException

Asks a user to confirm the reading of a document

Parameters:

docId - Identifier of the document

recipientId - Identifier of the user that must confirm the reading

requestorId - Identifier of the user that sends the reading confirmation request

alertConfirmation - If the requestor must be notified when the recipient has read the document

comment - an optional message to include in the notification

Throws:

com.logicaldoc.core.PersistenceException - Error in the database layer

askReadingConfirmation

public void askReadingConfirmation(Collection<Long> docIds,
 Collection<Long> userIds,
 Collection<Long> groupIds,
 long requestorId,
 boolean alertConfirmation,
 String comment,
 com.logicaldoc.core.document.DocumentHistory transaction)
                            throws com.logicaldoc.core.PersistenceException

Asks some users to confirm the reading of a set of documents

Parameters:

docIds - identifiers of the documents

userIds - identifiers of the recipients

groupIds - identifiers of the groups whose members are recipients

requestorId - Identifier of the user that sends the reading confirmation request

alertConfirmation - if the requestor must be notified on reading confirmation

comment - an optional message to include in the notification

transaction - an optional history to assign to this event

Throws:

com.logicaldoc.core.PersistenceException - Error in the database layer