org.exoplatform.wiki.rendering.macro.children

Class ChildrenMacroParameters

java.lang.Object

org.exoplatform.wiki.rendering.macro.children.ChildrenMacroParameters

public class ChildrenMacroParameters
extends Object

Constructor Summary

Constructors

Constructor and Description
ChildrenMacroParameters()

Method Summary

Modifier and Type	Method and Description
String	getChildrenNum()
String	getDepth()
String	getParent()
boolean	isDescendant()
boolean	isExcerpt()
void	setChildrenNum(String childrenNum)
void	setDepth(String depth)
void	setDescendant(boolean descendant)
void	setExcerpt(boolean excerpt)
void	setParent(String parentPage)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildrenMacroParameters

public ChildrenMacroParameters()

Method Detail

isDescendant

public boolean isDescendant()

Returns:

the value allow show descendant or not

setDescendant

public void setDescendant(boolean descendant)

Parameters:

descendant - the value show descendant to set

getParent

public String getParent()

Returns:

parent page of children

setParent

public void setParent(String parentPage)

Parameters:

parentPage - parent of children

getChildrenNum

public String getChildrenNum()

Returns:

the number of children

setChildrenNum

public void setChildrenNum(String childrenNum)
                    throws org.xwiki.rendering.macro.MacroExecutionException

Parameters:

childrenNum - number of children to set

Throws:

org.xwiki.rendering.macro.MacroExecutionException - if parameter is not empty and not a number

getDepth

public String getDepth()

Returns:

the depth of children

setDepth

public void setDepth(String depth)
              throws org.xwiki.rendering.macro.MacroExecutionException

Parameters:

depth - depth of children to set

Throws:

org.xwiki.rendering.macro.MacroExecutionException - if parameter is not empty and not a number

isExcerpt

public boolean isExcerpt()

Returns:

the value allow hide excerpt or not

setExcerpt

public void setExcerpt(boolean excerpt)

Parameters:

excerpt - the value show excerpt to set