com.laserfiche.repository.api.clients.params

Class ParametersForGetEntryByPath

java.lang.Object

com.laserfiche.repository.api.clients.params.ParametersForGetEntryByPath

public class ParametersForGetEntryByPath
extends Object

The encapsulated parameters for getEntryByPath.

Constructor Summary

Constructors

Constructor and Description
ParametersForGetEntryByPath()

Method Summary

Modifier and Type	Method and Description
String	getFullPath() The requested entry path.
String	getRepoId() The requested repository ID.
Boolean	isFallbackToClosestAncestor() An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found.
ParametersForGetEntryByPath	setFallbackToClosestAncestor(Boolean fallbackToClosestAncestor) Sets the value of the fallbackToClosestAncestor parameter and returns the current object, to enable chaining further setters.
ParametersForGetEntryByPath	setFullPath(String fullPath) Sets the value of the fullPath parameter and returns the current object, to enable chaining further setters.
ParametersForGetEntryByPath	setRepoId(String repoId) Sets the value of the repoId parameter and returns the current object, to enable chaining further setters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersForGetEntryByPath

public ParametersForGetEntryByPath()

Method Detail

setRepoId

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

ParametersForGetEntryByPath The return value

getRepoId

public String getRepoId()

The requested repository ID.

Returns:

String The return value

setFullPath

public ParametersForGetEntryByPath setFullPath(String fullPath)

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

Parameters:

fullPath - The requested entry path.

Returns:

ParametersForGetEntryByPath The return value

getFullPath

public String getFullPath()

The requested entry path.

Returns:

String The return value

setFallbackToClosestAncestor

public ParametersForGetEntryByPath setFallbackToClosestAncestor(Boolean fallbackToClosestAncestor)

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

Parameters:

fallbackToClosestAncestor - An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.

Returns:

ParametersForGetEntryByPath The return value

isFallbackToClosestAncestor

public Boolean isFallbackToClosestAncestor()

An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false.

Returns:

Boolean The return value