com.laserfiche.repository.api.clients.params

Class ParametersForMoveOrRenameEntry

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForMoveOrRenameEntry

public class ParametersForMoveOrRenameEntry
extends Object

The encapsulated parameters for moveOrRenameEntry.

Constructor Summary

Constructors

Constructor and Description
ParametersForMoveOrRenameEntry()

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 requested entry ID.
String	getRepoId() The requested repository ID.
PatchEntryRequest	getRequestBody()
Boolean	isAutoRename() An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder.
ParametersForMoveOrRenameEntry	setAutoRename(Boolean autoRename) Sets the value of the autoRename parameter and returns the current object, to enable chaining further setters.
ParametersForMoveOrRenameEntry	setCulture(String culture) Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
ParametersForMoveOrRenameEntry	setEntryId(Integer entryId) Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.
ParametersForMoveOrRenameEntry	setRepoId(String repoId) Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
ParametersForMoveOrRenameEntry	setRequestBody(PatchEntryRequest requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersForMoveOrRenameEntry

public ParametersForMoveOrRenameEntry()

Method Detail

setRepoId

public ParametersForMoveOrRenameEntry 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:

ParametersForMoveOrRenameEntry The return value

getRepoId

public String getRepoId()

The requested repository ID.

Returns:

String The return value

setEntryId

public ParametersForMoveOrRenameEntry setEntryId(Integer entryId)

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

Parameters:

entryId - The requested entry ID.

Returns:

ParametersForMoveOrRenameEntry The return value

getEntryId

public Integer getEntryId()

The requested entry ID.

Returns:

Integer The return value

setRequestBody

public ParametersForMoveOrRenameEntry setRequestBody(PatchEntryRequest requestBody)

getRequestBody

public PatchEntryRequest getRequestBody()

setAutoRename

public ParametersForMoveOrRenameEntry 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 entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false.

Returns:

ParametersForMoveOrRenameEntry The return value

isAutoRename

public Boolean isAutoRename()

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

Returns:

Boolean The return value

setCulture

public ParametersForMoveOrRenameEntry 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:

ParametersForMoveOrRenameEntry 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