sapphire.tagext

Class ActionTagInfo

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.tagext.BaseTagInfo

sapphire.tagext.ActionTagInfo

public class ActionTagInfo
extends BaseTagInfo

Field Summary

Fields

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

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ActionTagInfo(ActionBlock actionblock) Default Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionClass(int actionindex) Returns the actionid for the given index of an acion in the block
java.lang.String	getActionClass(java.lang.String name) Returns the actionid for the given action block name
int	getActionCount() Returns the number of actions defined in the block.
java.lang.String	getActionid(int actionindex) Returns the actionid for the given index of an acion in the block
java.lang.String	getActionid(java.lang.String name) Returns the actionid for the given action block name
java.lang.String	getActionName(int actionindex) Returns the name of an action for the given index
java.util.HashMap	getActionProperties(int actionindex) Gets the property values for the given Action in the Block.
java.util.HashMap	getActionProperties(java.lang.String name) Gets the property values for the given Action in the Block.
java.lang.String	getActionProperty(int actionindex, java.lang.String propertyid) Gets a property value for the given Action in the Block.
java.lang.String	getActionProperty(java.lang.String name, java.lang.String propertyid) Gets a property value for the given Action in the Block.
java.util.HashMap	getBlockProperties() Gets the properties for the block.
java.lang.String	getBlockProperty(java.lang.String propertyid) Gets a block property.
ErrorHandler	getErrorHandler() Gets the error handler for the block.
java.lang.String	getVersionid(int actionindex) Returns the versionid for the given index of an acion in the block
java.lang.String	getVersionid(java.lang.String name) Returns the versionid for the given action block name
boolean	hasErrors()
boolean	hasInfoErrors()
void	setErrorHandler(ErrorHandler errorHandler) Sets the errorHandlerr for the block.

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_VAR_NAME

public static final java.lang.String TAG_VAR_NAME

See Also:

Constant Field Values

Constructor Detail

ActionTagInfo

public ActionTagInfo(ActionBlock actionblock)

Default Constructor

Method Detail

getActionCount

public int getActionCount()

Returns the number of actions defined in the block.

Returns:

The number of actions.

getActionName

public java.lang.String getActionName(int actionindex)

Returns the name of an action for the given index

Parameters:

actionindex - The index of the action within the block.

Returns:

The action name, an empty String if the index is invalid.

getActionid

public java.lang.String getActionid(int actionindex)

Returns the actionid for the given index of an acion in the block

Parameters:

actionindex - The index of the action within the block.

Returns:

The actionid, an empty String if the index is invalid.

getActionid

public java.lang.String getActionid(java.lang.String name)

Returns the actionid for the given action block name

Parameters:

name - The name of the action in the block.

Returns:

The actionid, an empty String if the name is invalid.

getActionClass

public java.lang.String getActionClass(int actionindex)
                                throws ActionException

Returns the actionid for the given index of an acion in the block

Parameters:

actionindex - The index of the action within the block.

Returns:

The actionid, an empty String if the index is invalid.

Throws:

ActionException

getActionClass

public java.lang.String getActionClass(java.lang.String name)
                                throws ActionException

Returns the actionid for the given action block name

Parameters:

name - The name of the action in the block.

Returns:

The actionid, an empty String if the name is invalid.

Throws:

ActionException

getVersionid

public java.lang.String getVersionid(int actionindex)

Returns the versionid for the given index of an acion in the block

Parameters:

actionindex - The index of the action within the block.

Returns:

The versionid, an empty String if the index is invalid.

getVersionid

public java.lang.String getVersionid(java.lang.String name)
                              throws ActionException

Returns the versionid for the given action block name

Parameters:

name - The name of the action in the block.

Returns:

The versionid, an empty String if the name is invalid.

Throws:

ActionException

getActionProperties

public java.util.HashMap getActionProperties(java.lang.String name)

Gets the property values for the given Action in the Block.

Parameters:

name - Unique identifier used to identify the action inside the block.

Returns:

the properties for the action, an empty HashMap if the action does not exist.

getActionProperties

public java.util.HashMap getActionProperties(int actionindex)

Gets the property values for the given Action in the Block.

Parameters:

actionindex - The index of the action within the block.

Returns:

the properties for the action, an empty HashMap if the action does not exist.

getActionProperty

public java.lang.String getActionProperty(java.lang.String name,
                                          java.lang.String propertyid)

Gets a property value for the given Action in the Block.

Parameters:

name - Unique identifier used to identify the action inside the block.

propertyid - The name of the property.

Returns:

the propertie value for the action, empty string if problems.

getActionProperty

public java.lang.String getActionProperty(int actionindex,
                                          java.lang.String propertyid)

Gets a property value for the given Action in the Block.

Parameters:

actionindex - The index of the action within the block.

propertyid - The name of the property.

Returns:

the propertie value for the action, empty string if problems.

getBlockProperties

public java.util.HashMap getBlockProperties()

Gets the properties for the block.

Returns:

The properties of the block.

getBlockProperty

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

Gets a block property.

Parameters:

propertyid - The property identifier.

Returns:

The value of the property or an empty string.

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Sets the errorHandlerr for the block.

Parameters:

errorHandler - The errorHandlerr.

getErrorHandler

public ErrorHandler getErrorHandler()

Gets the error handler for the block.

Returns:

The errorHandler of the block.

hasErrors

public boolean hasErrors()

hasInfoErrors

public boolean hasInfoErrors()