Record (Voltmx App Services API)

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

All Implemented Interfaces:

Serializable, Comparable<Record>
```
public class Record
extends AbstractRecord
implements Comparable<Record>
```
Record is an item in the Datatset. Record in turn could have Records or Datasets. Record can also contain Params.

See Also:

Dataset, Param, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`index` Deprecated. As of Foundry 7.3.2, replaced by `getIndex()` and `setIndex(int)`
`int`	`order` Deprecated. As of Foundry 7.3.2, replaced by `getOrder()` and `setOrder(int)`

Constructor Summary

Constructors
Constructor and Description

Record()

Constructors
Constructor and Description
`Record()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Record o)` Deprecated. As of Foundry 7.3.2, this method is redundant as order is not used anymore.
`ArrayList<Dataset>`	`getDatasets()` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.getAllDatasets()`
`String`	`getId()` Gets the id of the Record.
`int`	`getIndex()` Gets the index of the Record in its parent.
`int`	`getOrder()` Gets the order of the Record in its parent.
`Param`	`getParam(String name)` Gets the Param with given param name from the Record.
`ArrayList<Param>`	`getParams()` 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()`
`boolean`	`removeParam(Param param)` Removes the given Param from the Param list of this Record object.
`boolean`	`removeParamsByName(String name)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.removeParamByName(String)`
`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`	`setId(String id)` Sets the id of the Record.
`void`	`setID(String newId)` Deprecated. As of Foundry 7.3.2, replaced by `setId(String)`
`void`	`setIndex(int index)` Sets the index of the Record in its parent.
`void`	`setOrder(int order)` Sets the order of the Record in its parent.
`void`	`setParam(Param param)` Deprecated. As of Foundry 7.3.2, replaced by `AbstractRecord.addParam(Param)`
`void`	`setParams(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

- Field Detail
  - index
```
@Deprecated
public int index
```
    Deprecated. As of Foundry 7.3.2, replaced by getIndex() and setIndex(int)
    
    The index of the Record in its parent.
  - order
```
@Deprecated
public int order
```
    Deprecated. As of Foundry 7.3.2, replaced by getOrder() and setOrder(int)
    
    The order of the Record in its parent.
- Constructor Detail
  - Record
```
public Record()
```
- Method Detail
  - getId
```
public String getId()
```
    Gets the id of the Record.
    
    Returns:
    
    The id of the Record
  - setId
```
public void setId(String id)
```
    Sets the id of the Record.
    
    Parameters:
    
    id - The id to set
  - setID
```
@Deprecated
public void setID(String newId)
```
    Deprecated. As of Foundry 7.3.2, replaced by setId(String)
    
    Sets the id of the Record.
    
    Parameters:
    
    newId - The id to set
  - getIndex
```
public int getIndex()
```
    Gets the index of the Record in its parent.
    
    Returns:
    
    The index of the Record
  - setIndex
```
public void setIndex(int index)
```
    Sets the index of the Record in its parent.
    
    Parameters:
    
    index - The index to set
  - getOrder
```
public int getOrder()
```
    Gets the order of the Record in its parent.
    
    Returns:
    
    The order of the Record
  - setOrder
```
public void setOrder(int order)
```
    Sets the order of the Record in its parent.
    
    Parameters:
    
    order - The order to set
  - getParams
```
@Deprecated
public ArrayList<Param> getParams()
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getAllParams()
    
    Gets the Param list of the Record.
    
    Returns:
    
    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 Record.
    
    Parameters:
    
    param - The Param to add
    
    See Also:
    
    Param
  - setParams
```
@Deprecated
public void setParams(ArrayList<Param> params)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addAllParams(java.util.Collection)
    
    Sets the Param list of the Record.
    
    Parameters:
    
    params - The Param list
    
    See Also:
    
    Param
  - removeParamsByName
```
@Deprecated
public boolean removeParamsByName(String name)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.removeParamByName(String)
    
    Removes the given Param from the Param list of the Record. This method shouldn't be used while iterating over the Params of the Record, as removing while iterating may throw ConcurrentModificationException.
    
    Parameters:
    
    name - The name of the Param to remove
    
    Returns:
    
    boolean True if removed, false otherwise
    
    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 Record.
    
    Returns:
    
    The list of Datasets
    
    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 Record.
    
    Parameters:
    
    dataset - The Dataset to add
    
    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 Record.
    
    Parameters:
    
    datasets - The Dataset list
    
    See Also:
    
    Dataset
  - getRecords
```
@Deprecated
public ArrayList<Record> getRecords()
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.getAllRecords()
    
    Gets the inner Record list of the Record.
    
    Returns:
    
    The inner Record list
  - setRecord
```
@Deprecated
public void setRecord(Record record)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addRecord(Record)
    
    Adds an inner Record to the Record.
    
    Parameters:
    
    record - The inner Record to add
  - setRecords
```
@Deprecated
public void setRecords(ArrayList<Record> records)
```
    Deprecated. As of Foundry 7.3.2, replaced by AbstractRecord.addAllRecords(java.util.Collection)
    
    Sets the inner Record list of the Record.
    
    Parameters:
    
    records - The inner Record list
  - getParam
```
public Param getParam(String name)
```
    Gets the Param with given param name from the Record.
    
    Parameters:
    
    name - The name of the Param to get
    
    Returns:
    
    The Param with the given name. If no Param with this name is found, then null.
    
    See Also:
    
    Param
  - removeParam
```
public boolean removeParam(Param param)
```
    Removes the given Param from the Param list of this Record object. This method shouldn't be used while iterating over the Params of the Record, as removing while iterating may throw ConcurrentModificationException.
    
    Parameters:
    
    param - The Param to remove
    
    Returns:
    
    boolean True if removed, false otherwise
    
    See Also:
    
    Param
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
@Deprecated
public int compareTo(Record o)
```
    Deprecated. As of Foundry 7.3.2, this method is redundant as order is not used anymore.
    
    Compares two Records based on their order in the parent collection.
    
    Specified by:
    
    compareTo in interface Comparable<Record>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)

Class Record

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

index

order

Constructor Detail

Record

Method Detail

getId

setId

setID

getIndex

setIndex

getOrder

setOrder

getParams

setParam

setParams

removeParamsByName

getDatasets

setDataset

setDatasets

getRecords

setRecord

setRecords

getParam

removeParam

toString

compareTo