RecordCollection (IFS Java Access Provider API documentation)

java.lang.Object
- ifs.fnd.ap.RecordCollection

All Implemented Interfaces:: java.lang.Cloneable

public final class RecordCollection
extends java.lang.Object
implements java.lang.Cloneable

A collection of Records.

Constructor Summary

Constructors
Constructor and Description

RecordCollection()

Constructors
Constructor and Description
`RecordCollection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Record`	`add()` Adds a new empty Record to the collection.
`void`	`add(Record rec)` Adds a given Record to the collection.
`void`	`add(RecordCollection rc)` Adds a `RecordCollection`to the collection.
`Record`	`add(java.lang.String recordType)` Adds a new Record with the given recordType to the collection.
`void`	`clear()` Removes all Records from this `RecordCollection`.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(java.lang.Object obj)` Returns true if obj is equal to this object in every aspect.
`ifs.fnd.buffer.Buffer`	`formatToBuffer()` Formats this object to a Buffer.
`Record`	`get(int index)` Gets the Record at the given index.
`java.lang.String`	`getTag()` Gets the Tag attribute.
`boolean`	`isDirty()` Returns `true` if this RecordCollection is dirty.
`java.util.Iterator`	`iterator()` Returns an iterator for this collection.
`void`	`parseBuffer(ifs.fnd.buffer.Buffer buf)` Parses a Buffer into this RecordCollection.
`RecordIterator`	`recordIterator()` Returns a `RecordIterator` for iterating over this collection.
`void`	`remove(int index)` Removes a Record from this object.
`void`	`setTag(java.lang.String tag)` Sets the Tag attribute.
`int`	`size()` Returns the number of Records in the collection.
`java.lang.String`	`toString()` Returns a string representation of the collection.

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

- Constructor Detail
  - RecordCollection
```
public RecordCollection()
```
- Method Detail
  - add
```
public Record add()
```
    Adds a new empty Record to the collection.
    
    Returns:
    
    A reference to the new Record added.
  - add
```
public Record add(java.lang.String recordType)
```
    Adds a new Record with the given recordType to the collection.
    
    Returns:
    
    A reference to the Record created (and added).
  - add
```
public void add(Record rec)
```
    Adds a given Record to the collection.
  - add
```
public void add(RecordCollection rc)
```
    Adds a RecordCollectionto the collection.
  - clear
```
public void clear()
```
    Removes all Records from this RecordCollection.
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a copy of this object. A copy in this case means that the following expressions would evaulate to true (providing x is of this class):
    - x.clone() != x
    - x.clone().getClass() == x.getClass()
    - x.clone().equals(x)
    Overrides:
    
    clone in class java.lang.Object
    
    See Also:
    
    Object
  - size
```
public int size()
```
    Returns the number of Records in the collection.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if obj is equal to this object in every aspect.
    
    Overrides:
    
    equals in class java.lang.Object
  - formatToBuffer
```
public ifs.fnd.buffer.Buffer formatToBuffer()
                                     throws APException
```
    Formats this object to a Buffer.
    
    Throws:
    
    APException
    
    See Also:
    
    Buffer
  - get
```
public Record get(int index)
```
    Gets the Record at the given index.
  - iterator
```
public java.util.Iterator iterator()
```
    Returns an iterator for this collection. More specifically, a RecordIterator is returned.
    
    See Also:
    
    RecordIterator
  - remove
```
public void remove(int index)
```
    Removes a Record from this object.
    
    Parameters:
    
    index - the index of the Record to remove.
  - recordIterator
```
public RecordIterator recordIterator()
```
    Returns a RecordIterator for iterating over this collection.
    
    See Also:
    
    RecordIterator
  - parseBuffer
```
public void parseBuffer(ifs.fnd.buffer.Buffer buf)
                 throws APException
```
    Parses a Buffer into this RecordCollection.
    
    Throws:
    
    APException
    
    See Also:
    
    Buffer
  - getTag
```
public java.lang.String getTag()
```
    Gets the Tag attribute. The tag is not used by Record internally and may be used to store any additional data.
  - setTag
```
public void setTag(java.lang.String tag)
```
    Sets the Tag attribute. The tag is not used by Record internally and may be used to store any additional data.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the collection.
    
    Overrides:
    
    toString in class java.lang.Object
  - isDirty
```
public boolean isDirty()
```
    Returns true if this RecordCollection is dirty.

Class RecordCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordCollection

Method Detail

add

add

add

add

clear

clone

size

equals

formatToBuffer

get

iterator

remove

recordIterator

parseBuffer

getTag

setTag

toString

isDirty