Result (Voltmx App Services API)

java.lang.Object
- com.hcl.voltmx.middleware.dataobject.AbstractRecord
- - com.hcl.voltmx.middleware.dataobject.Result

All Implemented Interfaces:

Serializable
```
public class Result
extends AbstractRecord
implements Serializable
```
Result is an abstraction of result of a back-end service call. Result is a collection of Params, Datasets and Records.

See Also:

Param, Dataset, Record, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Result()

Constructors
Constructor and Description
`Result()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addErrMsgParam(String errmsg)` Adds a param with name "errmsg" of type "string" with given value.
`void`	`addHttpStatusCodeParam(int httpStatusCode)` Adds a param with name "httpStatusCode" of type "int" with given value.
`void`	`addHttpStatusCodeParam(String httpStatusCode)` Adds a param with name "httpStatusCode" of type "int" with given value.
`void`	`addOpstatusParam(int opstatus)` Adds a param with name "opstatus" of type "int" with given value.
`void`	`addOpstatusParam(String opstatus)` Adds a param with name "opstatus" of type "int" with given value.
`Dataset`	`findDataset(String id)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getDatasetById(String)`
`Param`	`findParam(String name)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getParamByName(String)`
`Result`	`getCopy()` FOR INTERNAL USE ONLY.
`ArrayList<Dataset>`	`getDataSets()` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getAllDatasets()`
`String`	`getErrMsgParamValue()` Gets errmsg param value.
`String`	`getHttpStatusCodeParamValue()` Gets httpStatusCode param value.
`String`	`getOpstatusParamValue()` Gets opstatus param value.
`ArrayList<Param>`	`getParamList()` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getAllParams()`
`ArrayList<Record>`	`getRecords()` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getAllRecords()`
`void`	`removeParam(Param param)` Removes the given Param from the Param list of the Result.
`void`	`setDataSet(Dataset dataset)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addDataset(Dataset)`
`void`	`setDataSets(ArrayList<Dataset> datasets)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addAllDatasets(java.util.Collection)`
`void`	`setParam(Param param)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addParam(Param)`
`void`	`setParamList(ArrayList<Param> params)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addAllParams(java.util.Collection)`
`void`	`setRecord(Record record)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addRecord(Record)`
`void`	`setRecords(ArrayList<Record> records)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addAllRecords(java.util.Collection)`
`String`	`toString()`

Methods inherited from class com.hcl.voltmx.middleware.dataobject.AbstractRecord
addAllDatasets, addAllParams, addAllRecords, addDataset, addIntParam, addIntParam, addParam, addParam, addParam, addRecord, addStringParam, clearDatasets, clearParams, clearRecords, getAllDatasets, getAllParams, getAllRecords, getDatasetById, getIdOfAllDatasets, getIdOfAllRecords, getNameOfAllParams, getParamByName, getParamValueByName, getRecordById, hasParamByName, removeDatasetById, removeParamByName, removeRecordById

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Result
```
public Result()
```
- Method Detail
  - addOpstatusParam
```
public void addOpstatusParam(int opstatus)
```
    Adds a param with name "opstatus" of type "int" with given value.
    
    Parameters:
    
    opstatus - The value of the param
    
    Since:
    
    Foundry V8 SP4 (8.4) release.
    
    See Also:
    
    Param.OPSTATUS, Param.INT_CONST
  - addOpstatusParam
```
public void addOpstatusParam(String opstatus)
```
    Adds a param with name "opstatus" of type "int" with given value.
    
    Parameters:
    
    opstatus - The value of the param
    
    Since:
    
    Foundry V8 SP4 (8.4) release.
    
    See Also:
    
    Param.OPSTATUS, Param.INT_CONST
  - addHttpStatusCodeParam
```
public void addHttpStatusCodeParam(int httpStatusCode)
```
    Adds a param with name "httpStatusCode" of type "int" with given value.
    
    Parameters:
    
    httpStatusCode - The value of the param
    
    Since:
    
    Foundry V8 SP4 (8.4) release.
    
    See Also:
    
    Param.HTTP_STATUS_CODE, Param.INT_CONST
  - addHttpStatusCodeParam
```
public void addHttpStatusCodeParam(String httpStatusCode)
```
    Adds a param with name "httpStatusCode" of type "int" with given value.
    
    Parameters:
    
    httpStatusCode - The value of the param
    
    Since:
    
    Foundry V8 SP4 (8.4) release.
    
    See Also:
    
    Param.HTTP_STATUS_CODE, Param.INT_CONST
  - addErrMsgParam
```
public void addErrMsgParam(String errmsg)
```
    Adds a param with name "errmsg" of type "string" with given value.
    
    Parameters:
    
    errmsg - The value of the param
    
    Since:
    
    Foundry V8 SP4 (8.4) release.
    
    See Also:
    
    Param.ERR_MSG, Param.STRING_CONST
  - getOpstatusParamValue
```
public String getOpstatusParamValue()
```
    Gets opstatus param value.
    
    Returns:
    
    The value of the opstatus Param if found, otherwise null.
    
    Since:
    
    Foundry V9 (9.0) release.
    
    See Also:
    
    Param.OPSTATUS, AbstractRecord.getParamValueByName(String)
  - getHttpStatusCodeParamValue
```
public String getHttpStatusCodeParamValue()
```
    Gets httpStatusCode param value.
    
    Returns:
    
    The value of the httpStatusCode Param if found, otherwise null.
    
    Since:
    
    Foundry V9 (9.0) release.
    
    See Also:
    
    Param.HTTP_STATUS_CODE, AbstractRecord.getParamValueByName(String)
  - getErrMsgParamValue
```
public String getErrMsgParamValue()
```
    Gets errmsg param value.
    
    Returns:
    
    The value of the errmsg Param if found, otherwise null.
    
    Since:
    
    Foundry V9 (9.0) release.
    
    See Also:
    
    Param.ERR_MSG, AbstractRecord.getParamValueByName(String)
  - getParamList
```
@Deprecated
public ArrayList<Param> getParamList()
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getAllParams()
    
    Gets the Param list of the Result.
    
    Returns:
    
    The Param list
    
    See Also:
    
    Param
  - setParamList
```
@Deprecated
public void setParamList(ArrayList<Param> params)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addAllParams(java.util.Collection)
    
    Sets the Param list of the Result.
    
    Parameters:
    
    params - The Param list
    
    See Also:
    
    Param
  - setParam
```
@Deprecated
public void setParam(Param param)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addParam(Param)
    
    Adds the Param to the Param list of the Result.
    
    Parameters:
    
    param - The Param to add
    
    See Also:
    
    Param
  - getDataSets
```
@Deprecated
public ArrayList<Dataset> getDataSets()
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getAllDatasets()
    
    Gets the list of Datasets in the Result.
    
    Returns:
    
    The list of Datasets
    
    See Also:
    
    Dataset
  - setDataSets
```
@Deprecated
public void setDataSets(ArrayList<Dataset> datasets)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addAllDatasets(java.util.Collection)
    
    Sets the Dataset list of the Result.
    
    Parameters:
    
    datasets - The Dataset list
    
    See Also:
    
    Dataset
  - setDataSet
```
@Deprecated
public void setDataSet(Dataset dataset)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addDataset(Dataset)
    
    Adds the Dataset to the Datasets list in the Result.
    
    Parameters:
    
    dataset - The Dataset to add
    
    See Also:
    
    Dataset
  - removeParam
```
public void removeParam(Param param)
```
    Removes the given Param from the Param list of the Result. This method shouldn't be used while iterating over the Params of the Result, as removing while iterating may throw ConcurrentModificationException.
    
    Parameters:
    
    param - The Param to remove
    
    See Also:
    
    Param
  - findParam
```
@Deprecated
public Param findParam(String name)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getParamByName(String)
    
    Finds a Param with the given name in the Result.
    
    Parameters:
    
    name - The name of the Param to find
    
    Returns:
    
    The Param with the given name. If no Param found with this name, then null.
    
    See Also:
    
    Param
  - findDataset
```
@Deprecated
public Dataset findDataset(String id)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getDatasetById(String)
    
    Finds a Dataset with the given id in the Result.
    
    Parameters:
    
    id - The id of the Dataset to find
    
    Returns:
    
    The Dataset with the given id. If no Dataset found with this id, then null.
    
    See Also:
    
    Dataset
  - getRecords
```
@Deprecated
public ArrayList<Record> getRecords()
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getAllRecords()
    
    Gets the Record list of the Result.
    
    Returns:
    
    The Record list
    
    See Also:
    
    Record
  - setRecords
```
@Deprecated
public void setRecords(ArrayList<Record> records)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addAllRecords(java.util.Collection)
    
    Sets the Record list of the Result.
    
    Parameters:
    
    records - The Record list
    
    See Also:
    
    Record
  - setRecord
```
@Deprecated
public void setRecord(Record record)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addRecord(Record)
    
    Adds an Record to the Result.
    
    Parameters:
    
    record - The Record to add
    
    See Also:
    
    Record
  - getCopy
```
public Result getCopy()
```
    FOR INTERNAL USE ONLY.
    Creates a copy (clone) of the Result.
    
    Returns:
    
    A copy of the Result
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Result

Constructor Summary

Method Summary

Methods inherited from class com.hcl.voltmx.middleware.dataobject.AbstractRecord

Methods inherited from class java.lang.Object

Constructor Detail

Result

Method Detail

addOpstatusParam

addOpstatusParam

addHttpStatusCodeParam

addHttpStatusCodeParam

addErrMsgParam

getOpstatusParamValue

getHttpStatusCodeParamValue

getErrMsgParamValue

getParamList

setParamList

setParam

getDataSets

setDataSets

setDataSet

removeParam

findParam

findDataset

getRecords

setRecords

setRecord

getCopy

toString