Package com.gentics.contentnode.rest.resource.parameter

Class FileListParameterBean

java.lang.Object

com.gentics.contentnode.rest.resource.parameter.FileListParameterBean

public class FileListParameterBean
extends Object

Parameter bean for getting files/images of folder

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	broken	true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both
boolean	folder	True to add the folder information to the returned objects
Boolean	inherited	true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files
String	niceUrl	optional regular expression to get files with a nice URL.
Integer	nodeId	node id for this folder - for use with multichannelling
Boolean	online	true to only return online files, false to only get offline files, null to get both online and offline files
Boolean	used	true if only used files that are referenced somewhere shall be fetched, false for unused files.
List<Integer>	usedIn	optional list of channel IDs for extending the "used" filter to multiple channels.

Constructor Summary

Constructors

Constructor	Description
FileListParameterBean()

Method Summary

Modifier and Type	Method	Description
FileListParameterBean	setBroken(Boolean broken)
FileListParameterBean	setFolder(boolean folder)
FileListParameterBean	setInherited(Boolean inherited)
FileListParameterBean	setNiceUrl(String niceUrl)
FileListParameterBean	setNodeId(Integer nodeId)
FileListParameterBean	setOnline(Boolean online)
FileListParameterBean	setUsed(Boolean used)
FileListParameterBean	setUsedIn(List<Integer> usedIn)

Methods inherited from class java.lang.Object

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

Field Details

nodeId

@QueryParam("nodeId")
public Integer nodeId

node id for this folder - for use with multichannelling

inherited

@QueryParam("inherited")
public Boolean inherited

true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files

online

@QueryParam("online")
public Boolean online

true to only return online files, false to only get offline files, null to get both online and offline files

broken

@QueryParam("broken")
public Boolean broken

true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both

used

@QueryParam("used")
public Boolean used

true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified, this filter will only check in the current channel

usedIn

@QueryParam("usedIn")
public List<Integer> usedIn

optional list of channel IDs for extending the "used" filter to multiple channels.

folder

@QueryParam("folder")
@DefaultValue("false")
public boolean folder

True to add the folder information to the returned objects

niceUrl

@QueryParam("niceurl")
public String niceUrl

optional regular expression to get files with a nice URL.

Constructor Details

FileListParameterBean

public FileListParameterBean()

Method Details

setNodeId

public FileListParameterBean setNodeId(Integer nodeId)

setInherited

public FileListParameterBean setInherited(Boolean inherited)

setOnline

public FileListParameterBean setOnline(Boolean online)

setBroken

public FileListParameterBean setBroken(Boolean broken)

setUsed

public FileListParameterBean setUsed(Boolean used)

setUsedIn

public FileListParameterBean setUsedIn(List<Integer> usedIn)

setFolder

public FileListParameterBean setFolder(boolean folder)

setNiceUrl

public FileListParameterBean setNiceUrl(String niceUrl)