Interface IStepParams
-
- All Superinterfaces:
com4j.Com4jObject
public interface IStepParams extends com4j.Com4jObject
Deprecated. Use ParameterValue and ParameterValueFactory. A collection of test parameters.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addParam(String paramName, String paramType)
Adds a new parameter to the object.String
baseValue(Object vParam, com4j.Holder<Boolean> hasBaseValue)
For HP use.void
clearParam(Object vParam)
Clears the parameter value by setting it to null.int
count()
The number of parameters for the object.void
deleteParam(String paramName)
Deletes the specified parameter.boolean
paramExist(String paramName)
Checks if a parameter of this name exists.String
paramName(int nPosition)
The name of the parameter in the specified position in the StepParams collection (zero-based).String
paramType(Object vParam)
For HP use.void
paramType(Object vParam, String pVal)
For HP use.String
paramValue(Object vParam)
The value of the specified parameter.void
paramValue(Object vParam, String pVal)
The value of the specified parameter.void
refresh()
Refreshes the data from the database, discarding changes.void
save()
Uploads the parameter definitions to the database.int
type(Object vParam)
Gets the parameter type: predefined, null, or regular.
-
-
-
Method Detail
-
count
int count()
The number of parameters for the object.
Getter method for the COM property "Count"
- Returns:
- Returns a value of type int
-
paramValue
String paramValue(Object vParam)
The value of the specified parameter.
Getter method for the COM property "ParamValue"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type java.lang.String
-
paramValue
void paramValue(Object vParam, String pVal)
The value of the specified parameter.
Setter method for the COM property "ParamValue"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.pVal
- Mandatory java.lang.String parameter.
-
clearParam
void clearParam(Object vParam)
Clears the parameter value by setting it to null.
- Parameters:
vParam
- Mandatory java.lang.Object parameter.
-
paramType
String paramType(Object vParam)
For HP use. Gets Parameter Type - such as defined by user.
Getter method for the COM property "ParamType"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type java.lang.String
-
paramType
void paramType(Object vParam, String pVal)
For HP use. Gets Parameter Type - such as defined by user.
Setter method for the COM property "ParamType"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.pVal
- Mandatory java.lang.String parameter.
-
paramExist
boolean paramExist(String paramName)
Checks if a parameter of this name exists.
Getter method for the COM property "ParamExist"
- Parameters:
paramName
- Mandatory java.lang.String parameter.- Returns:
- Returns a value of type boolean
-
baseValue
String baseValue(Object vParam, com4j.Holder<Boolean> hasBaseValue)
For HP use. Gets a more basic value of the parameter - some default.
Getter method for the COM property "BaseValue"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.hasBaseValue
- Mandatory Holderparameter. - Returns:
- Returns a value of type java.lang.String
-
paramName
String paramName(int nPosition)
The name of the parameter in the specified position in the StepParams collection (zero-based).
Getter method for the COM property "ParamName"
- Parameters:
nPosition
- Mandatory int parameter.- Returns:
- Returns a value of type java.lang.String
-
type
int type(Object vParam)
Gets the parameter type: predefined, null, or regular.
Getter method for the COM property "Type"
- Parameters:
vParam
- Mandatory java.lang.Object parameter.- Returns:
- Returns a value of type int
-
save
void save()
Uploads the parameter definitions to the database.
-
refresh
void refresh()
Refreshes the data from the database, discarding changes.
-
addParam
void addParam(String paramName, String paramType)
Adds a new parameter to the object.
- Parameters:
paramName
- Mandatory java.lang.String parameter.paramType
- Mandatory java.lang.String parameter.
-
deleteParam
void deleteParam(String paramName)
Deletes the specified parameter.
- Parameters:
paramName
- Mandatory java.lang.String parameter.
-
-