com.highqsoft.moma.rules.ods

Class GetContextVariable

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.ods.GetContextVariable

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class GetContextVariable
extends AbstractSequencerRule

\page OdsRules \section rules_com_highqsoft_moma_rules_ods_GetContextVariable GetContextVariable \addindex get context Package \b com.highqsoft.moma.rules.ods This rule reads a context variable from the server. This rule is an implementation or sequence Rule. \subsection SetContextProperties Properties \addindex GetContext Properties The GetContextVariable is initialized with the following properties, keywords are case insensitive: \li \b OdsSession (required)\n datatype: String\n no default.\n The reference name of the ods session. \li \b ContextVariable (required)\n datatype: String\n no default.\n The name of the ODS context variable to read. \li \b PropertyNameForResult (required)\n datatype: String\n no default.\n The name of the property to store the retrieved property value. \subsection GetContextExample Example \addindex GetContextVariable Example \code \endcode

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSession
protected java.lang.String	contextVariableName
protected java.lang.String	propertyName

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
GetContextVariable()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Read the ODS context variable and store the value in the defined property
NameValueUnit[][]	getValue() Read the ODS context variable and store the value in the defined property
void	init() The initialize method.
void	setValue(NameValueUnit[][] nvu) Dummy setValue implementation
void	storeODSContextVariableAsProperty(java.lang.String ctxVariableName, java.lang.String prprtyName) Reads an ODS contextvariable and store the value as Property

Methods inherited from class com.highqsoft.xsd.AbstractSequencerRule

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, setArguments, 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, setArguments, setContext, setDescriptor

Field Detail

contextVariableName

protected java.lang.String contextVariableName

propertyName

protected java.lang.String propertyName

aoSession

protected AoSession aoSession

Constructor Detail

GetContextVariable

public GetContextVariable()

Method Detail

init

public void init()
          throws InitializationFailedException

The initialize method.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Dummy setValue implementation

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Read the ODS context variable and store the value in the defined property

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

execute

public void execute()
             throws ExecutableException

Read the ODS context variable and store the value in the defined property

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

storeODSContextVariableAsProperty

public void storeODSContextVariableAsProperty(java.lang.String ctxVariableName,
                                     java.lang.String prprtyName)
                                       throws RuleException

Reads an ODS contextvariable and store the value as Property

Parameters:

ctxVariableName - - Name of the ods context variable

prprtyName - - Name of the property to store the value

Throws:

RuleException