Package com.priint.pubserver.documentchecking

Interface DocumentCheckServiceLocal

public interface DocumentCheckServiceLocal

Method Summary

Modifier and Type	Method	Description
void	checkIn(CheckInCommand checkInCommand)
FileBundle	checkOut(CheckOutCommand checkOutCommand)	A method providing access to documents and their accompanying files.
int	getDocumentStatus(String sessionId, String documentId, String callback)
default void	revertDocument(String sessionId, String documentId)

Method Details

checkOut

FileBundle checkOut(CheckOutCommand checkOutCommand)
             throws ServerException

A method providing access to documents and their accompanying files. Depending on the command provided, existing document locks may be checked and/or a new lock may be created.

If you simply wish to lock a document, consider calling checkOut with a following command:

               CheckOutCommand.builder()
                 .sessionId(sessionId)
                 .documentId(documentId)
                 .forciblyFetchParentDocumentFiles(false)
                 .itemsToFetch(Collections.emptySet())
                 .existingLockHandlingMethod(CheckOutCommand.ExistingLockHandlingMethod.ONLY_IGNORE_EXISTING_LOCK_IF_SAME_USER_LOCKED_IT)
                 .lockingMethod(CheckOutCommand.LockingMethod.LOCK_EXCLUSIVELY)
                 .build()
 

Parameters:

checkOutCommand - an object describing all aspects of desired actions and outcomes of this operation, controls both locking aspects and actual files returned and their sources

Returns:

a FileBundle object providing access to requested files

Throws:

ServerException - all problems encountered end up with an exception being thrown

checkIn

void checkIn(CheckInCommand checkInCommand)
      throws ServerException

Throws:

ServerException

getDocumentStatus

int getDocumentStatus(String sessionId,
 String documentId,
 String callback)
               throws ServerException

Throws:

ServerException

revertDocument

default void revertDocument(String sessionId,
 String documentId)
                     throws ServerException

Throws:

ServerException