com.laserfiche.repository.api.clients.params

Class ParametersForCreateOrCopyEntry

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForCreateOrCopyEntry

public class ParametersForCreateOrCopyEntry
extends Object

The encapsulated parameters for createOrCopyEntry.

Constructor Summary

Constructors

Constructor and Description
ParametersForCreateOrCopyEntry()

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.
PostEntryChildrenRequest	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.
ParametersForCreateOrCopyEntry	setAutoRename(Boolean autoRename) Sets the value of the autoRename parameter and returns the current object, to enable chaining further setters.
ParametersForCreateOrCopyEntry	setCulture(String culture) Sets the value of the culture parameter and returns the current object, to enable chaining further setters.
ParametersForCreateOrCopyEntry	setEntryId(Integer entryId) Sets the value of the entryId parameter and returns the current object, to enable chaining further setters.
ParametersForCreateOrCopyEntry	setRepoId(String repoId) Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.
ParametersForCreateOrCopyEntry	setRequestBody(PostEntryChildrenRequest requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersForCreateOrCopyEntry

public ParametersForCreateOrCopyEntry()

Method Detail

setRepoId

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

ParametersForCreateOrCopyEntry The return value

getRepoId

public String getRepoId()

The requested repository ID.

Returns:

String The return value

setEntryId

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

ParametersForCreateOrCopyEntry The return value

getEntryId

public Integer getEntryId()

The folder ID that the entry will be created in.

Returns:

Integer The return value

setRequestBody

public ParametersForCreateOrCopyEntry setRequestBody(PostEntryChildrenRequest requestBody)

getRequestBody

public PostEntryChildrenRequest getRequestBody()

setAutoRename

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

ParametersForCreateOrCopyEntry 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 ParametersForCreateOrCopyEntry 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:

ParametersForCreateOrCopyEntry 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