com.oroad.stxx.transform.document
Interface BuilderRules

All Known Implementing Classes:

BuilderRulesImpl

public interface BuilderRules

Defines the class that tells what information can be added to the XML document.

Author:

Don Brown

Field Summary

static int	ATTRIBUTES_TYPE Request attributes type
static int	ERRORS_TYPE ActionErrors type
static int	FORM_TYPE ActionForm type
static int	MESSAGES_TYPE ActionMessages type
static int	PARAMETERS_TYPE Request parameters type
static int	RESOURCES_TYPE Application resources type

Method Summary

boolean	allowItem(int type, java.lang.String item, javax.servlet.http.HttpServletRequest req) Tells whether the item should be included
boolean	allowType(int type, javax.servlet.http.HttpServletRequest req) Tells whether the specified type of information should be included
void	init(StxxProperties props) Initializes the rules

Field Detail

ERRORS_TYPE

public static final int ERRORS_TYPE

ActionErrors type

See Also:

Constant Field Values

RESOURCES_TYPE

public static final int RESOURCES_TYPE

Application resources type

See Also:

Constant Field Values

PARAMETERS_TYPE

public static final int PARAMETERS_TYPE

Request parameters type

See Also:

Constant Field Values

ATTRIBUTES_TYPE

public static final int ATTRIBUTES_TYPE

Request attributes type

See Also:

Constant Field Values

FORM_TYPE

public static final int FORM_TYPE

ActionForm type

See Also:

Constant Field Values

MESSAGES_TYPE

public static final int MESSAGES_TYPE

ActionMessages type

See Also:

Constant Field Values

Method Detail

init

public void init(StxxProperties props)

Initializes the rules

Parameters:

props - The properties

allowType

public boolean allowType(int type,
                         javax.servlet.http.HttpServletRequest req)

Tells whether the specified type of information should be included

Parameters:

type - The type of information

req - The http request

Returns:

True if allowed

allowItem

public boolean allowItem(int type,
                         java.lang.String item,
                         javax.servlet.http.HttpServletRequest req)

Tells whether the item should be included

Parameters:

type - The type of information

item - The name of the item

req - The http request

Returns:

True if allowed