Package com.aspectran.core.context.rule

Class IncludeActionRule

java.lang.Object

com.aspectran.core.context.rule.IncludeActionRule

public class IncludeActionRule
extends java.lang.Object

The Class IncludeActionRule.

Created: 2008. 06. 05 PM 9:25:40

Constructor Summary

Constructors

Constructor	Description
IncludeActionRule()

Method Summary

Modifier and Type	Method	Description
void	addAttributeItemRule(ItemRule attributeItemRule)	Adds the attribute item rule.
void	addParameterItemRule(ItemRule parameterItemRule)	Adds the parameter item rule.
java.lang.String	getActionId()	Gets the action id.
ItemRuleMap	getAttributeItemRuleMap()	Gets the attribute item rule map.
java.lang.Boolean	getHidden()	Returns whether to hide result of the action.
MethodType	getMethodType()
ItemRuleMap	getParameterItemRuleMap()	Gets the parameter item rule map.
java.lang.String	getTransletName()	Gets the translet name.
java.lang.Boolean	isHidden()	Returns whether to hide result of the action.
ItemRule	newAttributeItemRule(java.lang.String attributeName)	Adds a new attribute rule with the specified name and returns it.
static IncludeActionRule	newInstance(java.lang.String id, java.lang.String transletName, java.lang.String method, java.lang.Boolean hidden)	Returns a new instance of IncludeActionRule.
ItemRule	newParameterItemRule(java.lang.String parameterName)	Adds a new parameter rule with the specified name and returns it.
void	setActionId(java.lang.String actionId)	Sets the id.
void	setAttributeItemRuleMap(ItemRuleMap attributeItemRuleMap)	Sets the attribute item rule map.
void	setHidden(java.lang.Boolean hidden)	Sets whether to hide result of the action.
void	setMethodType(MethodType methodType)
void	setParameterItemRuleMap(ItemRuleMap parameterItemRuleMap)	Sets the attribute item rule map.
void	setTransletName(java.lang.String transletName)	Sets the translet name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeActionRule

public IncludeActionRule()

Method Detail

getActionId

public java.lang.String getActionId()

Gets the action id.

Returns:

the action id

setActionId

public void setActionId(java.lang.String actionId)

Sets the id.

Parameters:

actionId - the new id

getTransletName

public java.lang.String getTransletName()

Gets the translet name.

Returns:

the translet name

setTransletName

public void setTransletName(java.lang.String transletName)

Sets the translet name.

Parameters:

transletName - the new translet name

getMethodType

public MethodType getMethodType()

setMethodType

public void setMethodType(MethodType methodType)

getParameterItemRuleMap

public ItemRuleMap getParameterItemRuleMap()

Gets the parameter item rule map.

Returns:

the parameter item rule map

setParameterItemRuleMap

public void setParameterItemRuleMap(ItemRuleMap parameterItemRuleMap)

Sets the attribute item rule map.

Parameters:

parameterItemRuleMap - the new attribute item rule map

newParameterItemRule

public ItemRule newParameterItemRule(java.lang.String parameterName)

Adds a new parameter rule with the specified name and returns it.

Parameters:

parameterName - the parameter name

Returns:

the parameter item rule

addParameterItemRule

public void addParameterItemRule(ItemRule parameterItemRule)

Adds the parameter item rule.

Parameters:

parameterItemRule - the parameter item rule

getAttributeItemRuleMap

public ItemRuleMap getAttributeItemRuleMap()

Gets the attribute item rule map.

Returns:

the attribute item rule map

setAttributeItemRuleMap

public void setAttributeItemRuleMap(ItemRuleMap attributeItemRuleMap)

Sets the attribute item rule map.

Parameters:

attributeItemRuleMap - the new attribute item rule map

newAttributeItemRule

public ItemRule newAttributeItemRule(java.lang.String attributeName)

Adds a new attribute rule with the specified name and returns it.

Parameters:

attributeName - the attribute name

Returns:

the attribute item rule

addAttributeItemRule

public void addAttributeItemRule(ItemRule attributeItemRule)

Adds the attribute item rule.

Parameters:

attributeItemRule - the attribute item rule

getHidden

public java.lang.Boolean getHidden()

Returns whether to hide result of the action.

Returns:

true, if this action is hidden

isHidden

public java.lang.Boolean isHidden()

Returns whether to hide result of the action.

Returns:

true, if this action is hidden

setHidden

public void setHidden(java.lang.Boolean hidden)

Sets whether to hide result of the action.

Parameters:

hidden - whether to hide result of the action

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newInstance

public static IncludeActionRule newInstance(java.lang.String id,
                                            java.lang.String transletName,
                                            java.lang.String method,
                                            java.lang.Boolean hidden)
                                     throws IllegalRuleException

Returns a new instance of IncludeActionRule.

Parameters:

id - the action id

transletName - the translet name

method - the request method type

hidden - whether to hide result of the action

Returns:

the include action rule

Throws:

IllegalRuleException - if an illegal rule is found