com.highqsoft.xsd

Class StatusRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.xsd.StatusRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class StatusRule
extends AbstractSequencerRule

This is the status rule. The rule is a sequence rule. The getValue argument is treated as an NameValueUnit[1][2] Array. The first element is the status and the second optional element is the message. The status can be passed as byte, long, short or string value.

Argument Keyword	Datatype	Default	Description
Status	String	OK	The mandatory status word to be set. This word should be defined by the com.highqsoft.xsd.Status enumeration.
Message	String	none	The status message to be used.
Reference	String	none	The optional name of the reference to be used as status message. The Property arguments has a higher priority.
Property	String	none	The optional name of the property to be used as status message. The Message arguments has a higher priority.

Since:

$Date: 2017/04/06 13:30:31 $

Version:

$Revision: 1.5 $

Author:

Andreas Hofmann

See Also:

AbstractRule

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	message
protected java.lang.String	property
protected java.lang.String	reference
protected java.lang.String	status
protected Status	statusValue

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
StatusRule() Create an literal rule.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() The execute method.
void	init() Initialize the work.
void	setArguments(java.util.Properties args) Set the arguments.
void	setValue(NameValueUnit[][] nvuArr) Set the named value to rule.

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

getValue, terminate

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setContext, setDescriptor

Field Detail

status

protected java.lang.String status

statusValue

protected Status statusValue

message

protected java.lang.String message

reference

protected java.lang.String reference

property

protected java.lang.String property

Constructor Detail

StatusRule

public StatusRule()

Create an literal rule.

Method Detail

init

public void init()
          throws InitializationFailedException

Initialize the work.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

setArguments

public void setArguments(java.util.Properties args)
                  throws InvalidArgumentException

Set the arguments.

Specified by:

setArguments in interface ImplementationIF

Overrides:

setArguments in class AbstractImplementation

Parameters:

args - the property map

Throws:

InvalidArgumentException - if the arguments are not valid.

execute

public void execute()
             throws ExecutableException

The execute method. It is useful for when used as implementation only.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

setValue

public void setValue(NameValueUnit[][] nvuArr)

Set the named value to rule.

Parameters:

nvu - The name value of the rule.