Package org.pentaho.platform.api.repository2.unified

Class RepositoryRequest

java.lang.Object

org.pentaho.platform.api.repository2.unified.RepositoryRequest

public class RepositoryRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryRequest.FILES_TYPE_FILTER

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
RepositoryRequest()	This class encapsulates the parameters received by the "children" and "tree" REST calls.
RepositoryRequest(String path, Boolean showHidden, Integer depth, String legacyFilter)

Method Summary

Modifier and Type	Method	Description
String	getChildNodeFilter()
Integer	getDepth()
Set<String>	getExcludeMemberSet()
Set<String>	getIncludeMemberSet()
String	getPath()
RepositoryRequest.FILES_TYPE_FILTER	getTypes()
boolean	isIncludeAcls()
boolean	isIncludeSystemFolders()
boolean	isShowHidden()
void	setChildNodeFilter(String childNodeFilter)
void	setDepth(Integer depth)
void	setExcludeMemberSet(Set<String> excludeMemberSet)
void	setIncludeAcls(boolean includeAcls)
void	setIncludeMemberSet(Set<String> includeMemberSet)
void	setIncludeSystemFolders(boolean includeSystemFolders)
void	setPath(String path)
void	setShowHidden(boolean showHidden)
void	setTypes(RepositoryRequest.FILES_TYPE_FILTER types)	Sets whether files, folders, or both are returned: ( FILES | FOLDERS | [default] FILES_FOLDERS )

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

RepositoryRequest

public RepositoryRequest()

This class encapsulates the parameters received by the "children" and "tree" REST calls. It provides default values for parameters not specified and breaks down the legacy "filter" parameters into it's component parts.

RepositoryRequest

public RepositoryRequest(String path,
                         Boolean showHidden,
                         Integer depth,
                         String legacyFilter)

Method Detail

getTypes

public RepositoryRequest.FILES_TYPE_FILTER getTypes()

setTypes

public void setTypes(RepositoryRequest.FILES_TYPE_FILTER types)

Sets whether files, folders, or both are returned: ( FILES | FOLDERS | [default] FILES_FOLDERS )

getIncludeMemberSet

public Set<String> getIncludeMemberSet()

setIncludeMemberSet

public void setIncludeMemberSet(Set<String> includeMemberSet)

Parameters:

includeMemberSet - A set of field names to be included in the output.

getExcludeMemberSet

public Set<String> getExcludeMemberSet()

setExcludeMemberSet

public void setExcludeMemberSet(Set<String> excludeMemberSet)

Parameters:

includeMemberSet - A set of field names to be excluded in the output.

isShowHidden

public boolean isShowHidden()

isIncludeSystemFolders

public boolean isIncludeSystemFolders()

setIncludeSystemFolders

public void setIncludeSystemFolders(boolean includeSystemFolders)

setShowHidden

public void setShowHidden(boolean showHidden)

Parameters:

showHidden - Whether to return information about hidden files. Default is false.

getDepth

public Integer getDepth()

setDepth

public void setDepth(Integer depth)

Parameters:

depth - 0 fetches just file at path; positive integer n fetches node at path plus n levels of children; negative integer fetches all children. If n > 0 and setTypes(FILES_TYPE_FILTER) is set to FILES then only the top level children will be processed.

getChildNodeFilter

public String getChildNodeFilter()

setChildNodeFilter

public void setChildNodeFilter(String childNodeFilter)

Parameters:

childNodefilter - filter may be a full name or a partial name with one or more wildcard characters ("*"), or a disjunction (using the "|" character to represent logical OR) of these; filter does not apply to root node.

getPath

public String getPath()

setPath

public void setPath(String path)

Parameters:

path - Path to file

isIncludeAcls

public boolean isIncludeAcls()

setIncludeAcls

public void setIncludeAcls(boolean includeAcls)

Parameters:

includeAcls - Set to true to return ACL permission information with the output. Default is false.