com.laserfiche.repository.api.clients.params

Class ParametersForCopyEntryAsync

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForCopyEntryAsync

public class ParametersForCopyEntryAsync
extends Object

The encapsulated parameters for copyEntryAsync.

Constructor Summary

Constructors

Constructor and Description
ParametersForCopyEntryAsync()

Method Summary

Modifier and Type	Method and Description
String	getCulture() An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.
Integer	getEntryId() The folder ID that the entry will be created in.
String	getRepoId() The requested repository ID.
CopyAsyncRequest	getRequestBody()
Boolean	isAutoRename() An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder.
ParametersForCopyEntryAsync	setAutoRename(Boolean autoRename) Sets the value of the autoRename parameter and returns the current object, to enable chaining further setters.
ParametersForCopyEntryAsync	setCulture(String culture) Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
ParametersForCopyEntryAsync	setEntryId(Integer entryId) Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.
ParametersForCopyEntryAsync	setRepoId(String repoId) Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
ParametersForCopyEntryAsync	setRequestBody(CopyAsyncRequest requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersForCopyEntryAsync

public ParametersForCopyEntryAsync()

Method Detail

setRepoId

public ParametersForCopyEntryAsync setRepoId(String repoId)

Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.

Parameters:

repoId - The requested repository ID.

Returns:

ParametersForCopyEntryAsync The return value

getRepoId

public String getRepoId()

The requested repository ID.

Returns:

String The return value

setEntryId

public ParametersForCopyEntryAsync setEntryId(Integer entryId)

Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.

Parameters:

entryId - The folder ID that the entry will be created in.

Returns:

ParametersForCopyEntryAsync The return value

getEntryId

public Integer getEntryId()

The folder ID that the entry will be created in.

Returns:

Integer The return value

setRequestBody

public ParametersForCopyEntryAsync setRequestBody(CopyAsyncRequest requestBody)

getRequestBody

public CopyAsyncRequest getRequestBody()

setAutoRename

public ParametersForCopyEntryAsync setAutoRename(Boolean autoRename)

Sets the value of the autoRename parameter and returns the current object, to enable chaining further setters.

Parameters:

autoRename - An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false.

Returns:

ParametersForCopyEntryAsync The return value

isAutoRename

public Boolean isAutoRename()

An optional query parameter used to indicate if the new entry should be automatically
renamed if an entry already exists with the given name in the folder. The default value is false.

Returns:

Boolean The return value

setCulture

public ParametersForCopyEntryAsync setCulture(String culture)

Sets the value of the culture parameter and returns the current object, to enable chaining further setters.

Parameters:

culture - An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag.

Returns:

ParametersForCopyEntryAsync The return value

getCulture

public String getCulture()

An optional query parameter used to indicate the locale that should be used.
The value should be a standard language tag.

Returns:

String The return value