Package com.priint.pubserverapi.document

Record Class CheckOutCommand

java.lang.Object

java.lang.Record

com.priint.pubserverapi.document.CheckOutCommand

public record CheckOutCommand(String sessionId, DocumentPointer documentPointer, boolean forciblyFetchParentDocumentFiles, Set<ObtainableItem> itemsToFetch, CheckOutCommand.ExistingLockHandlingMethod existingLockHandlingMethod, CheckOutCommand.LockingMethod lockingMethod)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CheckOutCommand.AcquireLock
static class	CheckOutCommand.CheckOutCommandBuilder
static final record	CheckOutCommand.DoNotLock
static interface	CheckOutCommand.ExistingLockHandlingMethod
static final record	CheckOutCommand.FailIfDocumentIsLocked
static final record	CheckOutCommand.IgnoreExistingLocks
static interface	CheckOutCommand.LockingMethod
static final record	CheckOutCommand.OnlyIgnoreExistingLockIfSameUserLockedIt

Constructor Summary

Constructors

Constructor	Description
CheckOutCommand(String sessionId, DocumentPointer documentPointer, boolean forciblyFetchParentDocumentFiles, Set<ObtainableItem> itemsToFetch, CheckOutCommand.ExistingLockHandlingMethod existingLockHandlingMethod, CheckOutCommand.LockingMethod lockingMethod)	Creates an instance of a CheckOutCommand record class.

Method Summary

Modifier and Type	Method	Description
static CheckOutCommand.CheckOutCommandBuilder	builder()
DocumentPointer	documentPointer()	Returns the value of the documentPointer record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CheckOutCommand.ExistingLockHandlingMethod	existingLockHandlingMethod()	Returns the value of the existingLockHandlingMethod record component.
boolean	forciblyFetchParentDocumentFiles()	Returns the value of the forciblyFetchParentDocumentFiles record component.
final int	hashCode()	Returns a hash code value for this object.
Set<ObtainableItem>	itemsToFetch()	Returns the value of the itemsToFetch record component.
CheckOutCommand.LockingMethod	lockingMethod()	Returns the value of the lockingMethod record component.
String	sessionId()	Returns the value of the sessionId record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CheckOutCommand

public CheckOutCommand(String sessionId,
 DocumentPointer documentPointer,
 boolean forciblyFetchParentDocumentFiles,
 Set<ObtainableItem> itemsToFetch,
 CheckOutCommand.ExistingLockHandlingMethod existingLockHandlingMethod,
 CheckOutCommand.LockingMethod lockingMethod)

Creates an instance of a CheckOutCommand record class.

Parameters:

sessionId - the value for the sessionId record component

documentPointer - the value for the documentPointer record component

forciblyFetchParentDocumentFiles - the value for the forciblyFetchParentDocumentFiles record component

itemsToFetch - the value for the itemsToFetch record component

existingLockHandlingMethod - the value for the existingLockHandlingMethod record component

lockingMethod - the value for the lockingMethod record component

Method Details

builder

public static CheckOutCommand.CheckOutCommandBuilder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sessionId

public String sessionId()

Returns the value of the sessionId record component.

Returns:

the value of the sessionId record component

documentPointer

public DocumentPointer documentPointer()

Returns the value of the documentPointer record component.

Returns:

the value of the documentPointer record component

forciblyFetchParentDocumentFiles

public boolean forciblyFetchParentDocumentFiles()

Returns the value of the forciblyFetchParentDocumentFiles record component.

Returns:

the value of the forciblyFetchParentDocumentFiles record component

itemsToFetch

public Set<ObtainableItem> itemsToFetch()

Returns the value of the itemsToFetch record component.

Returns:

the value of the itemsToFetch record component

existingLockHandlingMethod

public CheckOutCommand.ExistingLockHandlingMethod existingLockHandlingMethod()

Returns the value of the existingLockHandlingMethod record component.

Returns:

the value of the existingLockHandlingMethod record component

lockingMethod

public CheckOutCommand.LockingMethod lockingMethod()

Returns the value of the lockingMethod record component.

Returns:

the value of the lockingMethod record component