Record (IFS Java Access Provider API documentation)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public final class Record
extends java.lang.Object
implements java.lang.Cloneable
```
The Record is the input/output data format for components built on Extended Server platform. Records have the same serialization format as IFS Buffers, but are a higher level abstraction. Which makes them much easier to use.

The data in a record is stored in the record's attributes. A record attribute can either be of a simple or compound type. Simple record attributes are those who have (or can have) a distinct value, such as a string, date or number. Compound record attributes have a complex value. There are two compund attribute types. Aggregate, which have another record as its value, and array, which have a list of records as its value.

For examples on invoking server operations and working with records, see the Foundation1 Development Guide.

Constructor Summary

Constructors
Constructor and Description

Record()
The default constructor.

Record(java.lang.String recordType)
The Record's recordType will be set to the supplied string.

Constructors
Constructor and Description
`Record()` The default constructor.
`Record(java.lang.String recordType)` The Record's recordType will be set to the supplied string.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RecordAttribute`	`add(java.lang.String nameOf)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.math.BigDecimal value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.math.BigDecimal value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, boolean value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, boolean value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, byte[] value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, byte[] value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, Bytedata value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, Bytedata value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.util.Date value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.util.Date value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, double value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, double value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, long value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, long value, DataType dataType)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.lang.String value)` Add a attribute named `nameOf`.
`RecordAttribute`	`add(java.lang.String nameOf, java.lang.String value, DataType dataType)` Add a attribute named `nameOf`.
`Record`	`addAggregate(java.lang.String name)` Adds an aggregate to the Record's attributes.
`RecordAttribute`	`addAggregate(java.lang.String name, Record rec)` Adds an aggregate to the Record's attributes and sets the the record.
`Record`	`addAggregate(java.lang.String name, java.lang.String recordType)` Adds an aggregate to the Record's attributes.
`RecordCollection`	`addArray(java.lang.String name)` Adds an array to the Record's attributes.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`Record`	`createLUStdOpBindVars(LUStdOp op)` Creates a standard set of bind variables used when invoking PL/SQL operations with `invokePLSQL()`.
`boolean`	`equals(java.lang.Object obj)` Returns True if the supplied Record equals this Record.
`void`	`excludeQueryResult()` Excludes this from the query result.
`boolean`	`exists(java.lang.String name)` Returns `true` if the Record has an attribute named `name`.
`RecordAttribute`	`find(java.lang.String name)` Finds a RecordAttribute in the Record named `name` and returns a reference to it.
`java.lang.Object`	`findValue(java.lang.String name)`
`java.lang.Object`	`findValue(java.lang.String name, java.lang.Object defaultValue)` Finds a value in the Record's attributes.
`java.lang.String`	`format(java.lang.String pattern)` Format the attributes of a record into a user-defined string.
`ifs.fnd.buffer.Buffer`	`formatToBuffer()` Formats this record into a IFS `Buffer`.
`java.lang.String`	`formatToBufferString()` Formats this record into a string representation of its buffer.
`RecordAttributeCollection`	`getAttributes()` Returns a reference to the Record's attributes.
`java.lang.String`	`getIdentity()` Returns a unique identifier for this record.
`RecordAttribute`	`getKeyAttribute()` Returns this `Record`'s key attribute.
`java.lang.String`	`getRecordType()` Returns the record type for the record.
`java.lang.String`	`getRecordTypeFull()` Returns the full record type for the record.
`RecordStatus`	`getStatus()` Returns the Record's status.
`java.lang.String`	`getTag()` Gets the Tag attribute.
`void`	`handleLUStdOpBindVars(LUStdOp op, Record bindVars)` Handles bind variables after a call to invokePLSQL (moves objid/objversion attributes from bind variables to the record).
`boolean`	`hasValue(java.lang.String name)` Checks if the Record has an attribute named `name` and checks if that attribute has a value set (not null).
`void`	`includeQueryResult()` Sets all attributes to be included in a query result.
`void`	`includeQueryResult(RecordAttributeStatus includeAs)` Sets all attributes to `includeAs`.
`boolean`	`isDirty()` Returns whether the Record is dirty or not.
`boolean`	`isRemoveAllowed()` Check if the record may be removed.
`java.util.Iterator`	`iterator()` Returns an `Iterator` to the Record's attributes.
`void`	`loadFromBuffer(ifs.fnd.buffer.Buffer buf)` Loads a record from a IFS `Buffer` containing the data.
`void`	`loadFromBufferString(java.lang.String bufferString)` Loads a record from a string containing its buffer.
`void`	`loadFromFile(java.lang.String fileName)` Loads a previously saved Record from file.
`void`	`parseItem(ifs.fnd.buffer.Item itm)` Deprecated. to load a `Record` from a `Buffer`, use `loadFromBuffer`. Parses an Item into the Record
`void`	`remove(java.lang.String name)` Removes an attribute named `name` from the Record, if it exists.
`void`	`saveToFile(java.lang.String fileName)` Saves the Record to a file.
`void`	`setAttributes(RecordAttributeCollection rac)` Sets the Record's attribute collection.
`void`	`setLikeCondition(java.lang.String attrName, java.lang.String value)` Sets a "attribute like value" condition on an attribute in this record.
`void`	`setNew()` Sets the Record's status to NEW.
`void`	`setQueried()` Sets the Record's status to QUERIED.
`void`	`setRecordType(java.lang.String recordType)` Sets the recordType for the Record.
`void`	`setRemoved()` Sets the Record's status to REMOVED.
`void`	`setTag(java.lang.String tag)` Sets the Tag attribute.
`java.lang.String`	`toString()` Returns a string representation of the Record.
`void`	`touch()` Touches the Record, ie makes it look modified if (it already isn't).

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

- Constructor Detail
  - Record
```
public Record()
```
    The default constructor. The Record's recordType will be set to an empty string.
  - Record
```
public Record(java.lang.String recordType)
```
    The Record's recordType will be set to the supplied string.
- Method Detail
  - add
```
public RecordAttribute add(java.lang.String nameOf)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           long value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           long value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           double value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           double value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.math.BigDecimal value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.math.BigDecimal value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           boolean value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           boolean value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           byte[] value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           byte[] value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.util.Date value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.util.Date value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           Bytedata value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           Bytedata value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.lang.String value)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - add
```
public RecordAttribute add(java.lang.String nameOf,
                           java.lang.String value,
                           DataType dataType)
```
    Add a attribute named nameOf.
    
    Returns:
    
    A reference to the RecordAttribute added.
  - addAggregate
```
public Record addAggregate(java.lang.String name)
```
    Adds an aggregate to the Record's attributes.
    
    Returns:
    
    A reference to the Record in the aggregate added.
  - addAggregate
```
public Record addAggregate(java.lang.String name,
                           java.lang.String recordType)
```
    Adds an aggregate to the Record's attributes.
    
    Returns:
    
    A reference to the Record in the aggregate added.
  - addAggregate
```
public RecordAttribute addAggregate(java.lang.String name,
                                    Record rec)
```
    Adds an aggregate to the Record's attributes and sets the the record.
    
    Returns:
    
    the RecordAttribute created (which have the Record as its value).
  - addArray
```
public RecordCollection addArray(java.lang.String name)
```
    Adds an array to the Record's attributes.
    
    Returns:
    
    A reference to the array added.
  - setLikeCondition
```
public void setLikeCondition(java.lang.String attrName,
                             java.lang.String value)
```
    Sets a "attribute like value" condition on an attribute in this record.
    
    Parameters:
    
    attrName - name of an attribute in this record
    
    value - the value to compare the attribute to. Use wildcards '%' and '_'.
  - 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
  - createLUStdOpBindVars
```
public Record createLUStdOpBindVars(LUStdOp op)
```
    Creates a standard set of bind variables used when invoking PL/SQL operations with invokePLSQL().
    
    Parameters:
    
    op - the type of operation to be called (different sets of standard bind variables).
    
    Returns:
    
    a new Record with a set of standard bind variables for the type of operation to be called.
  - handleLUStdOpBindVars
```
public void handleLUStdOpBindVars(LUStdOp op,
                                  Record bindVars)
```
    Handles bind variables after a call to invokePLSQL (moves objid/objversion attributes from bind variables to the record).
    
    Parameters:
    
    op - the type of operation to be called (different sets of standard bind variables).
    
    bindVars - the bind variables used for the call.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns True if the supplied Record equals this Record.
    
    Overrides:
    
    equals in class java.lang.Object
  - excludeQueryResult
```
public void excludeQueryResult()
```
    Excludes this from the query result.
  - exists
```
public boolean exists(java.lang.String name)
```
    Returns true if the Record has an attribute named name.
  - find
```
public RecordAttribute find(java.lang.String name)
```
    Finds a RecordAttribute in the Record named name and returns a reference to it. If it's not found, null is returned.
  - findValue
```
public java.lang.Object findValue(java.lang.String name,
                                  java.lang.Object defaultValue)
```
    Finds a value in the Record's attributes.
    
    Parameters:
    
    name - the name of the attribute to find the value for.
    
    defaultValue - a default value to return if the attribute is not found.
    
    Returns:
    
    A reference to the value for the attribute found.
  - findValue
```
public java.lang.Object findValue(java.lang.String name)
```
    Returns:
    
    null if the attribute is not found.
  - hasValue
```
public boolean hasValue(java.lang.String name)
```
    Checks if the Record has an attribute named name and checks if that attribute has a value set (not null).
  - remove
```
public void remove(java.lang.String name)
```
    Removes an attribute named name from the Record, if it exists.
  - setAttributes
```
public void setAttributes(RecordAttributeCollection rac)
```
    Sets the Record's attribute collection.
  - getAttributes
```
public RecordAttributeCollection getAttributes()
```
    Returns a reference to the Record's attributes.
  - includeQueryResult
```
public void includeQueryResult()
```
    Sets all attributes to be included in a query result.
  - includeQueryResult
```
public void includeQueryResult(RecordAttributeStatus includeAs)
```
    Sets all attributes to includeAs.
  - loadFromFile
```
public void loadFromFile(java.lang.String fileName)
                  throws APException,
                         java.io.IOException
```
    Loads a previously saved Record from file.
    
    Throws:
    
    APException
    
    java.io.IOException
  - saveToFile
```
public void saveToFile(java.lang.String fileName)
                throws APException,
                       java.io.IOException
```
    Saves the Record to a file.
    
    Throws:
    
    APException
    
    java.io.IOException
  - parseItem
```
public void parseItem(ifs.fnd.buffer.Item itm)
               throws APException
```
    Deprecated. to load a Record from a Buffer, use loadFromBuffer. Parses an Item into the Record
    
    Throws:
    
    APException
    
    See Also:
    
    loadFromBuffer(ifs.fnd.buffer.Buffer), loadFromBufferString(java.lang.String), loadFromFile(java.lang.String)
  - getIdentity
```
public java.lang.String getIdentity()
```
    Returns a unique identifier for this record. If this record has been de- serialized, the identifier may not be unique.
  - getKeyAttribute
```
public RecordAttribute getKeyAttribute()
```
    Returns this Record's key attribute. That is the first RecordAttribute set as a key. If there is no key attribute in this Record, null is returned.
  - getRecordType
```
public java.lang.String getRecordType()
```
    Returns the record type for the record. A package name (if exists) is not returned.
  - getRecordTypeFull
```
public java.lang.String getRecordTypeFull()
```
    Returns the full record type for the record. That includes any package name.
  - setRecordType
```
public void setRecordType(java.lang.String recordType)
```
    Sets the recordType for the Record.
    
    Parameters:
    
    recordType - A string containing the recordType to be set.
  - getStatus
```
public RecordStatus getStatus()
```
    Returns the Record's status.
  - setNew
```
public void setNew()
```
    Sets the Record's status to NEW.
  - setQueried
```
public void setQueried()
```
    Sets the Record's status to QUERIED.
  - setRemoved
```
public void setRemoved()
```
    Sets the Record's status to REMOVED.
  - 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 Record.
    
    Overrides:
    
    toString in class java.lang.Object
  - touch
```
public void touch()
```
    Touches the Record, ie makes it look modified if (it already isn't).
  - isDirty
```
public boolean isDirty()
```
    Returns whether the Record is dirty or not. A record is dirty when its status is something else than Queried.
  - iterator
```
public java.util.Iterator iterator()
```
    Returns an Iterator to the Record's attributes.
  - format
```
public java.lang.String format(java.lang.String pattern)
```
    Format the attributes of a record into a user-defined string. Example:
    rec.format(":ID (:NAME)");
    may give the result "jdoe (Jane Doe)" if there are RecordAttributes named ID & NAME.
    
    See Also:
    
    PreparedString
  - formatToBuffer
```
public ifs.fnd.buffer.Buffer formatToBuffer()
                                     throws APException
```
    Formats this record into a IFS Buffer.
    
    Throws:
    
    APException
  - formatToBufferString
```
public java.lang.String formatToBufferString()
                                      throws APException
```
    Formats this record into a string representation of its buffer.
    
    Throws:
    
    APException
  - loadFromBuffer
```
public void loadFromBuffer(ifs.fnd.buffer.Buffer buf)
                    throws APException
```
    Loads a record from a IFS Buffer containing the data.
    
    Parameters:
    
    buf - the Buffer with data.
    
    Throws:
    
    APException
  - loadFromBufferString
```
public void loadFromBufferString(java.lang.String bufferString)
                          throws APException
```
    Loads a record from a string containing its buffer.
    
    Throws:
    
    APException
  - isRemoveAllowed
```
public boolean isRemoveAllowed()
```
    Check if the record may be removed.
    
    Returns:
    
    true if the record may be removed.

Class Record

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Record

Record

Method Detail

add

add

add

add

add

add

add

add

add

add

add

add

add

add

add

add

add

addAggregate

addAggregate

addAggregate

addArray

setLikeCondition

clone

createLUStdOpBindVars

handleLUStdOpBindVars

equals

excludeQueryResult

exists

find

findValue

findValue

hasValue

remove

setAttributes

getAttributes

includeQueryResult

includeQueryResult

loadFromFile

saveToFile

parseItem

getIdentity

getKeyAttribute

getRecordType

getRecordTypeFull

setRecordType

getStatus

setNew

setQueried

setRemoved

getTag

setTag

toString

touch

isDirty

iterator

format

formatToBuffer

formatToBufferString

loadFromBuffer

loadFromBufferString

isRemoveAllowed