sapphire.tagext

Class ControlledPageTagInfo

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.tagext.BaseTagInfo

sapphire.tagext.ControlledPageTagInfo

public class ControlledPageTagInfo
extends BaseTagInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_VARIABLE_NAME

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ControlledPageTagInfo(RequestContext requestContext)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConnectionid()
java.lang.String	getConnectionId() Return the connection ID in use by the current page
java.lang.String	getDecodedProperty(java.lang.String propertyid) Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties.
java.lang.String	getEncodedProperty(java.lang.String propertyid) Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties.
java.util.HashMap	getPageProperties() NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties.
java.lang.String	getPageProperty(java.lang.String propertyid) Return a value from a page property
java.util.HashMap	getProperties() Return a HashMap containing all request, page and session properties.
java.lang.String	getProperty(java.lang.String propertyid) Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties.
java.util.HashMap	getRequestProperties() NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties.
java.lang.String	getRequestProperty(java.lang.String propertyid) Return a value from a request property
java.util.HashMap	getSessionProperties() NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties.
java.lang.String	getSessionProperty(java.lang.String propertyid) Return a value from a session property
boolean	isControlledpage() Return whether the page is controlled page or not.
boolean	isCopyrequestparameters() Internal method.
boolean	isPageProperty(java.lang.String propertyid) Return whether a property is a page property
boolean	isProperty(java.lang.String propertyid) Return a property is either a request, page or session property.
boolean	isRequestProperty(java.lang.String propertyid) Return whether a property is a request property
boolean	isSessionProperty(java.lang.String propertyid) Return whether a property is a session property
void	resetPageProperties() Clear all page properties
void	resetProperties() Clear all request, context, page, and session properties
void	resetRequestProperties() Clear all request properties
void	resetSessionProperties() Clear all session properties
void	setConnectionid(java.lang.String connectionid) Internal method.
void	setControlledpage(boolean controlledpage) Internal method.
void	setCopyrequestparameters(boolean copy) Internal method.
void	setPageProperty(java.lang.String propertyid, java.lang.String propertyvalue) Set a value for a page property.
void	setRequestProperty(java.lang.String propertyid, java.lang.String propertyvalue) Set a value for a request property.
void	setSessionProperty(java.lang.String propertyid, java.lang.String propertyvalue) Internal method.

Methods inherited from class sapphire.tagext.BaseTagInfo

getErrorCodes, getErrorStack, getLastError, setErrorStack

Methods inherited from class java.lang.Object

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

Field Detail

TAG_VARIABLE_NAME

public static final java.lang.String TAG_VARIABLE_NAME

See Also:

Constant Field Values

Constructor Detail

ControlledPageTagInfo

public ControlledPageTagInfo(RequestContext requestContext)

Method Detail

isCopyrequestparameters

public boolean isCopyrequestparameters()

Internal method. Not currently supported.

setCopyrequestparameters

public void setCopyrequestparameters(boolean copy)

Internal method. Not currently supported.

setConnectionid

public void setConnectionid(java.lang.String connectionid)

Internal method. Not currently supported.

getConnectionId

public java.lang.String getConnectionId()

Return the connection ID in use by the current page

Returns:

the connection ID in use by the current page

getConnectionid

public java.lang.String getConnectionid()

setControlledpage

public void setControlledpage(boolean controlledpage)

Internal method. Not currently supported.

isControlledpage

public boolean isControlledpage()

Return whether the page is controlled page or not. i.e. whether the page begins with a tag.

Returns:

true if the page is a controlled page

setRequestProperty

public void setRequestProperty(java.lang.String propertyid,
                               java.lang.String propertyvalue)

Set a value for a request property. This value will persist if the request is subsequently forwarded to another page.

Parameters:

propertyid - the propertyid to set

propertyvalue - the property value

setPageProperty

public void setPageProperty(java.lang.String propertyid,
                            java.lang.String propertyvalue)

Set a value for a page property. This method can be used to override a property that has been retrieved from the database.

Parameters:

propertyid - the page propertyid

propertyvalue - the property value

setSessionProperty

public void setSessionProperty(java.lang.String propertyid,
                               java.lang.String propertyvalue)

Internal method. Not currently supported.

getProperty

public java.lang.String getProperty(java.lang.String propertyid)

Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties.

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

getEncodedProperty

public java.lang.String getEncodedProperty(java.lang.String propertyid)

Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties. The value is then URL encoded.

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

getDecodedProperty

public java.lang.String getDecodedProperty(java.lang.String propertyid)

Returns the first property value found in the Request properties, then the Page Properties and finally the Session properties. The value is then URL decoded.

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

getRequestProperty

public java.lang.String getRequestProperty(java.lang.String propertyid)

Return a value from a request property

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

getPageProperty

public java.lang.String getPageProperty(java.lang.String propertyid)

Return a value from a page property

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

getSessionProperty

public java.lang.String getSessionProperty(java.lang.String propertyid)

Return a value from a session property

Parameters:

propertyid - the propertyid to look for

Returns:

the property value

isProperty

public boolean isProperty(java.lang.String propertyid)

Return a property is either a request, page or session property.

Parameters:

propertyid - the propertyid to look for

Returns:

true if the property is a request, page or session property

isRequestProperty

public boolean isRequestProperty(java.lang.String propertyid)

Return whether a property is a request property

Parameters:

propertyid - the propertyid to look for

Returns:

true if a property is a request property

isPageProperty

public boolean isPageProperty(java.lang.String propertyid)

Return whether a property is a page property

Parameters:

propertyid - the propertyid to look for

Returns:

true if the property is a page property

isSessionProperty

public boolean isSessionProperty(java.lang.String propertyid)

Return whether a property is a session property

Parameters:

propertyid - the propertyid to look for

Returns:

true if the property is a session property

getProperties

public java.util.HashMap getProperties()

Return a HashMap containing all request, page and session properties. Note that in the event of duplicates, request properties take precedence over page properties, which in turn take precedence over session properties.

Returns:

a HashMap of all request, page and session properties.

getRequestProperties

public java.util.HashMap getRequestProperties()

NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties. Note that in the event of duplicates, request properties take precedence over page properties, which in turn take precedence over session properties.

Returns:

a HashMap of all request, page and session properties.

getPageProperties

public java.util.HashMap getPageProperties()

NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties. Note that in the event of duplicates, request properties take precedence over page properties, which in turn take precedence over session properties.

Returns:

a HashMap of all request, page and session properties.

getSessionProperties

public java.util.HashMap getSessionProperties()

NOTE: Legacy method with altered functionality Return a HashMap containing all request, page and session properties. Note that in the event of duplicates, request properties take precedence over page properties, which in turn take precedence over session properties.

Returns:

a HashMap of all request, page and session properties.

resetProperties

public void resetProperties()

Clear all request, context, page, and session properties

resetRequestProperties

public void resetRequestProperties()

Clear all request properties

resetPageProperties

public void resetPageProperties()

Clear all page properties

resetSessionProperties

public void resetSessionProperties()

Clear all session properties