Package com.priint.pubserverapi.document

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.
default DocumentLockServiceLocal	getDocumentLockServiceLocal()	Deprecated.
default FileBundle	lockDocumentWithoutFetchingFiles(DocumentPointer documentPointer, Lock.Holder lockHolder, String lockingSessionId)
default void	unlockDocumentWithoutSavingFiles(DocumentPointer documentPointer, Lock.Holder lockHolder, String sessionId)

Method Details

checkOut

FileBundle checkOut(CheckOutCommand checkOutCommand)
             throws DocumentLockedException,
DocumentCheckServiceException

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.

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:

DocumentLockedException - if document was locked and policies specified in a command did not permit that

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

checkIn

void checkIn(CheckInCommand checkInCommand)
      throws DocumentCheckServiceException

Throws:

DocumentCheckServiceException

lockDocumentWithoutFetchingFiles

default FileBundle lockDocumentWithoutFetchingFiles(DocumentPointer documentPointer,
 Lock.Holder lockHolder,
 String lockingSessionId)
                                             throws DocumentLockedException,
DocumentCheckServiceException

Throws:

DocumentLockedException

DocumentCheckServiceException

unlockDocumentWithoutSavingFiles

default void unlockDocumentWithoutSavingFiles(DocumentPointer documentPointer,
 Lock.Holder lockHolder,
 String sessionId)
                                       throws DocumentCheckServiceException

Throws:

DocumentCheckServiceException

getDocumentLockServiceLocal

@Deprecated
default DocumentLockServiceLocal getDocumentLockServiceLocal()

Deprecated.

Please don't use this