RecordAttribute (IFS Java Access Provider API documentation)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public final class RecordAttribute
extends java.lang.Object
implements java.lang.Cloneable
```
The RecordAttribute represents the smallest part a Record is made up of. It can either hold a simple or a compound value.

Constructor Summary

Constructors
Constructor and Description
`RecordAttribute()` Default constructor.
`RecordAttribute(java.lang.String nameOf)` This constructor sets the name.
`RecordAttribute(java.lang.String nameOf, java.math.BigDecimal value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, boolean value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, byte[] value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, Bytedata value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, java.util.Date value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, double value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, long value)` This constructor sets the name and value.
`RecordAttribute(java.lang.String nameOf, java.lang.String value)` This constructor sets the name and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearDirty()` Clears the attribute's dirty flag.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`void`	`excludeQueryResult()` Excludes this attribute from a query result.
`ifs.fnd.buffer.Item`	`formatToItem()` Formats the RecordAttribute to an ifs.fnd.buffer.Item object.
`Record`	`getAggregate()` Returns the attribute's value if it's set and it's an aggregate.
`RecordCollection`	`getArray()` Returns the attribute's value if it's an array.
`java.math.BigDecimal`	`getBigDecimal()` Returns the attribute's value as a BigDecimal.
`Bytedata`	`getBinary()` Returns the attribute's value as Bytedata.
`BindVariableDirection`	`getBindVariableDirection()` Returns the bind varible direction set.
`boolean`	`getBoolean()` Returns the attribute's value as a boolean.
`DataType`	`getDataType()` Returns the RecordAttribute's data type.
`java.util.Date`	`getDate()` Returns the attribute's value as a Date.
`java.lang.String`	`getDomain()` Returns the domain for this attribute.
`double`	`getDouble()` Returns the attribute's value as a double.
`java.lang.String`	`getIdentity()` Returns the attribute's identity.
`long`	`getLong()` Returns the attribute's value as a long.
`java.lang.String`	`getNameOf()` Returns the name of the RecordAttribute.
`java.lang.Object`	`getQueryValue()` Returns the value for this attribute if its status is QueryInclude, otherwise `null` is returned.
`Record`	`getReferent()` If the attribute is a reference, the referenced Record is returned by this method.
`RecordAttributeStatus`	`getStatus()` Returns the status for this RecordAttribute.
`java.lang.String`	`getString()` Returns the attribute's value as a String.
`java.lang.Object`	`getTag()` Gets the Tag attribute.
`java.lang.Object`	`getValue()` Returns a reference to the value stored in the RecordAttribute.
`boolean`	`hasValue()` Returns `true` if the attribute has a value set.
`void`	`includeQueryResult()` Includes this attribute in a query result.
`void`	`includeQueryResult(RecordAttributeStatus includeAs)` Sets includetype for this attribute.
`boolean`	`isCompound()` Returns true if the attribute is compund (Array, Aggregate, Reference or Query Condition).
`boolean`	`isDirty()` Returns `true` is this attribute is dirty.
`boolean`	`isKey()` Returns `true` if the the attribute is a key.
`boolean`	`isMandatory()` Check if the attribute is mandatory (must have a value).
`boolean`	`isQueryCondition()` Returns `true` if the attribute is a query condition.
`boolean`	`isReference()` Returns `true` if the attribute is a reference.
`boolean`	`isSimple()` Returns true if the attribute contains a simple value.
`boolean`	`isUpdateAllowed()` Check if the attribute is updateable.
`void`	`makeDirty()` Sets the attribute's dirty flag.
`void`	`parseItem(ifs.fnd.buffer.Item attributeItem)` Parses a simple item into a RecordAttribute.
`void`	`setBindVariableDirection(BindVariableDirection dir)` Sets the bind variable direction.
`void`	`setDataType(DataType dataType)` Sets the data RecordAttribute's data type.
`void`	`setDomain(java.lang.String domain)` Sets the domain for this attribute.
`void`	`setIdentitiy(java.lang.String identity)` Sets the attributes identitiy, i.e.
`void`	`setIsKey(boolean yes)` Sets wheter the attribute is a key.
`void`	`setIsReference(boolean yes)` Sets wheter the attribute is a reference.
`void`	`setNameOf(java.lang.String nameOf)` Sets the name of the RecordAttribute.
`void`	`setQueryValue(java.lang.Object value)` Sets the value & and the status to QueryInclude.
`void`	`setReferent(Record referent)` Sets the attribute's referent record (if the attribute is a reference).
`void`	`setStatus(RecordAttributeStatus status)` Sets the attribute's status.
`void`	`setTag(java.lang.Object tag)` Sets the Tag attribute.
`void`	`setValue(java.math.BigDecimal value)`
`void`	`setValue(boolean value)`
`void`	`setValue(java.util.Date value)`
`void`	`setValue(double value)`
`void`	`setValue(long value)` Sets the value, dirty to true & status to None.
`void`	`setValue(java.lang.String value)`
`void`	`setValueNoDirty(java.math.BigDecimal value)`
`void`	`setValueNoDirty(boolean value)`
`void`	`setValueNoDirty(java.util.Date value)`
`void`	`setValueNoDirty(double value)`
`void`	`setValueNoDirty(long value)` Sets the value & status to None.
`void`	`setValueNoDirty(java.lang.String value)`
`java.lang.String`	`toString()` Returns a String representation of this object.

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

- Constructor Detail
  - RecordAttribute
```
public RecordAttribute()
```
    Default constructor.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf)
```
    This constructor sets the name.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       java.lang.String value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       long value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       double value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       java.math.BigDecimal value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       boolean value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       byte[] value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       java.util.Date value)
```
    This constructor sets the name and value.
  - RecordAttribute
```
public RecordAttribute(java.lang.String nameOf,
                       Bytedata value)
```
    This constructor sets the name and value.
- Method Detail
  - 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
  - excludeQueryResult
```
public void excludeQueryResult()
```
    Excludes this attribute from a query result.
  - includeQueryResult
```
public void includeQueryResult()
```
    Includes this attribute in a query result.
  - includeQueryResult
```
public void includeQueryResult(RecordAttributeStatus includeAs)
```
    Sets includetype for this attribute.
  - isCompound
```
public boolean isCompound()
```
    Returns true if the attribute is compund (Array, Aggregate, Reference or Query Condition).
  - isKey
```
public boolean isKey()
```
    Returns true if the the attribute is a key.
  - isReference
```
public boolean isReference()
```
    Returns true if the attribute is a reference.
  - isQueryCondition
```
public boolean isQueryCondition()
```
    Returns true if the attribute is a query condition.
  - isSimple
```
public boolean isSimple()
```
    Returns true if the attribute contains a simple value. (Boolean, Date, Double, Long or String).
  - isMandatory
```
public boolean isMandatory()
```
    Check if the attribute is mandatory (must have a value).
    
    Returns:
    
    true if the attribute is mandatory.
  - isUpdateAllowed
```
public boolean isUpdateAllowed()
```
    Check if the attribute is updateable.
    
    Returns:
    
    true if the attribute is updateable.
  - getDataType
```
public DataType getDataType()
```
    Returns the RecordAttribute's data type.
  - setBindVariableDirection
```
public void setBindVariableDirection(BindVariableDirection dir)
```
    Sets the bind variable direction. Used when invoking PLSQL calls (with invokePLSQL()).
  - setDataType
```
public void setDataType(DataType dataType)
```
    Sets the data RecordAttribute's data type.
  - getDomain
```
public java.lang.String getDomain()
```
    Returns the domain for this attribute. There is only a domain available if the attribute is a key or reference.
  - formatToItem
```
public ifs.fnd.buffer.Item formatToItem()
                                 throws APException
```
    Formats the RecordAttribute to an ifs.fnd.buffer.Item object.
    
    Throws:
    
    APException
  - getIdentity
```
public java.lang.String getIdentity()
```
    Returns the attribute's identity. The identity consists of: value^domain. Only keys and references have identities.
    
    Throws:
    
    java.lang.IllegalStateException - if identitiy is accessed for other attributes than keys or references.
  - setIdentitiy
```
public void setIdentitiy(java.lang.String identity)
```
    Sets the attributes identitiy, i.e. value & domain. May only be used for key or references.
    
    See Also:
    
    getIdentity()
  - parseItem
```
public void parseItem(ifs.fnd.buffer.Item attributeItem)
               throws APException
```
    Parses a simple item into a RecordAttribute.
    
    Throws:
    
    APException
  - getNameOf
```
public java.lang.String getNameOf()
```
    Returns the name of the RecordAttribute.
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Sets the domain for this attribute.
  - setIsKey
```
public void setIsKey(boolean yes)
```
    Sets wheter the attribute is a key.
    
    Parameters:
    
    yes - if true, the attribute is a key.
  - setIsReference
```
public void setIsReference(boolean yes)
```
    Sets wheter the attribute is a reference.
    
    Parameters:
    
    yes - if true, the attribute is a key.
  - setNameOf
```
public void setNameOf(java.lang.String nameOf)
```
    Sets the name of the RecordAttribute.
  - getAggregate
```
public Record getAggregate()
```
    Returns the attribute's value if it's set and it's an aggregate.
    
    Throws:
    
    java.lang.IllegalStateException - if the value is not an aggregate.
  - getArray
```
public RecordCollection getArray()
```
    Returns the attribute's value if it's an array.
    
    Throws:
    
    java.lang.IllegalStateException - if the value is not an array.
  - getBinary
```
public Bytedata getBinary()
```
    Returns the attribute's value as Bytedata.
    
    Throws:
    
    java.lang.IllegalStateException - if the value is not binary data.
  - getBindVariableDirection
```
public BindVariableDirection getBindVariableDirection()
```
    Returns the bind varible direction set. Used when invoking PLSQL calls ( with invokePLSQL()).
  - getBoolean
```
public boolean getBoolean()
```
    Returns the attribute's value as a boolean. Only simple values if type Boolean can be returned by this method.
    
    Throws:
    
    java.lang.IllegalStateException - if the value is not a Boolean.
  - getDate
```
public java.util.Date getDate()
```
    Returns the attribute's value as a Date. Only simple values of type Date and Long can be returned by this method. If the value is of type Long then new Date(getLong()) is returned.
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be converted into a Date.
  - getDouble
```
public double getDouble()
```
    Returns the attribute's value as a double. Only simple values of type Double and Long can be returned by this method. If the value is of type Long then it's value is typecasted into a double.
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be converted into a double.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal()
```
    Returns the attribute's value as a BigDecimal. Only simple values of type BigDecimal, Double and Long can be returned by this method.
    
    Throws:
    
    java.lang.IllegalStateException - if the value cannot be converted into a BigDecimal.
  - getLong
```
public long getLong()
```
    Returns the attribute's value as a long. Only simple values of type Long, Date and Double can be returned by this method. If the value is of type Date then getDate().getTime() is returned. If the value is of type Double then it's value typecasted into a long.
    
    Throws:
    
    IllegalStateExcpetion - if the value cannot be converted into a long.
  - getReferent
```
public Record getReferent()
```
    If the attribute is a reference, the referenced Record is returned by this method. If there is no referenced record set, null is returned.
  - setReferent
```
public void setReferent(Record referent)
```
    Sets the attribute's referent record (if the attribute is a reference).
  - getString
```
public java.lang.String getString()
```
    Returns the attribute's value as a String. The value must be a simple value. Date, Time & Timestamp values are shown in default time zone. If you want it formatted some other way, you must extract the date with getDate() and format it with a java.text.DateFormat object.
    
    Throws:
    
    java.lang.IllegalStateException - if the value is not simple.
  - getValue
```
public java.lang.Object getValue()
```
    Returns a reference to the value stored in the RecordAttribute. All values are returned as Objects. For non-compund values (use isSimple() to find out) the object returned is Long, Double, Boolean, Bytedata, Date or String. For compound values the returning classes are Record (for aggregates), RecordCollection (for arrays).
  - getQueryValue
```
public java.lang.Object getQueryValue()
```
    Returns the value for this attribute if its status is QueryInclude, otherwise null is returned.
  - hasValue
```
public boolean hasValue()
```
    Returns true if the attribute has a value set.
  - setValue
```
public void setValue(long value)
```
    Sets the value, dirty to true & status to None.
  - setValueNoDirty
```
public void setValueNoDirty(long value)
```
    Sets the value & status to None.
  - setValue
```
public void setValue(double value)
```
  - setValueNoDirty
```
public void setValueNoDirty(double value)
```
  - setValue
```
public void setValue(java.math.BigDecimal value)
```
  - setValueNoDirty
```
public void setValueNoDirty(java.math.BigDecimal value)
```
  - setValue
```
public void setValue(boolean value)
```
  - setValueNoDirty
```
public void setValueNoDirty(boolean value)
```
  - setValue
```
public void setValue(java.util.Date value)
```
  - setValueNoDirty
```
public void setValueNoDirty(java.util.Date value)
```
  - setValue
```
public void setValue(java.lang.String value)
```
  - setValueNoDirty
```
public void setValueNoDirty(java.lang.String value)
```
  - setQueryValue
```
public void setQueryValue(java.lang.Object value)
```
    Sets the value & and the status to QueryInclude.
  - getStatus
```
public RecordAttributeStatus getStatus()
```
    Returns the status for this RecordAttribute.
    
    See Also:
    
    RecordAttributeStatus
  - setStatus
```
public void setStatus(RecordAttributeStatus status)
```
    Sets the attribute's status.
    
    See Also:
    
    RecordAttributeStatus
  - getTag
```
public java.lang.Object getTag()
```
    Gets the Tag attribute. The tag is not used by the Access Provider internally and may be used to store any additional data.
  - setTag
```
public void setTag(java.lang.Object tag)
```
    Sets the Tag attribute. The tag is not used by the Access Provider internally and may be used to store any additional data.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this object.
    
    Overrides:
    
    toString in class java.lang.Object
  - isDirty
```
public boolean isDirty()
```
    Returns true is this attribute is dirty. That is, if it has been tampererd with since it was fetched from a server.
  - makeDirty
```
public void makeDirty()
```
    Sets the attribute's dirty flag.
  - clearDirty
```
public void clearDirty()
```
    Clears the attribute's dirty flag.

Class RecordAttribute

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

RecordAttribute

Method Detail

clone

excludeQueryResult

includeQueryResult

includeQueryResult

isCompound

isKey

isReference

isQueryCondition

isSimple

isMandatory

isUpdateAllowed

getDataType

setBindVariableDirection

setDataType

getDomain

formatToItem

getIdentity

setIdentitiy

parseItem

getNameOf

setDomain

setIsKey

setIsReference

setNameOf

getAggregate

getArray

getBinary

getBindVariableDirection

getBoolean

getDate

getDouble

getBigDecimal

getLong

getReferent

setReferent

getString

getValue

getQueryValue

hasValue

setValue

setValueNoDirty

setValue

setValueNoDirty

setValue

setValueNoDirty

setValue

setValueNoDirty

setValue

setValueNoDirty

setValue

setValueNoDirty

setQueryValue

getStatus

setStatus

getTag

setTag

toString

isDirty

makeDirty

clearDirty