FTVAL (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- COM.FutureTense.Interfaces.FTVAL

All Implemented Interfaces:: Serializable

public class FTVAL
extends Object
implements Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int BLOB

static int DATE

static int DOUBLE

static int I4

static int LONG

static int LPSTR

static int UNKNOWN

Fields
Modifier and Type	Field and Description
`static int`	`BLOB`
`static int`	`DATE`
`static int`	`DOUBLE`
`static int`	`I4`
`static int`	`LONG`
`static int`	`LPSTR`
`static int`	`UNKNOWN`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`FTVAL()`
`protected`	`FTVAL(byte[] data)`
`protected`	`FTVAL(int value)`
`protected`	`FTVAL(Integer value)`
`protected`	`FTVAL(int type, Object data)`
`protected`	`FTVAL(long value)`
`protected`	`FTVAL(Long value)`
`protected`	`FTVAL(Object data)`
`protected`	`FTVAL(Path oFile)`
`protected`	`FTVAL(String sValue)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`byte[]`	`getBlob()` Method to get the value as a byte array if the value is a blob
`String`	`getFile()` Method to get a file representation of the object
`int`	`GetInt()` Return the integer value from this object
`Object`	`GetObj()` Return the data from this object
`int`	`GetSize()` Deprecated. returns 0 for indirect files
`InputStream`	`getStream()` Method to get an input stream for the data
`String`	`getString()` Method to get the value as a string if the value is not a blob
`int`	`GetType()` Deprecated. the type should be private
`boolean`	`isEmpty()` Method to determine if a value is empty
`long`	`length()` Method to determine the length of a value
`void`	`readObject(ObjectInputStream oObjectInputStream)` Method to read a serialized object from an input stream
`void`	`readObject(ObjectInputStream oObjectInputStream, boolean fileNameOnly)` Method to read a serialized object from an input stream
`String`	`toString()` Method to convert a value to a string
`String`	`toString(String sEncoding)` Method to convert a value to a string
`void`	`writeObject(ObjectOutputStream oObjectOutputStream)` Method to write a serialized object to an output stream
`void`	`writeObject(ObjectOutputStream oObjectOutputStream, boolean fileNameOnly)` Method to write a serialized object to an output stream

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

- Field Detail
  - I4
```
public static final int I4
```
    See Also:
    
    Constant Field Values
  - LONG
```
public static final int LONG
```
    See Also:
    
    Constant Field Values
  - DOUBLE
```
public static final int DOUBLE
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final int UNKNOWN
```
    See Also:
    
    Constant Field Values
  - LPSTR
```
public static final int LPSTR
```
    See Also:
    
    Constant Field Values
  - BLOB
```
public static final int BLOB
```
    See Also:
    
    Constant Field Values
  - DATE
```
public static final int DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FTVAL
```
public FTVAL()
```
  - FTVAL
```
protected FTVAL(String sValue)
```
  - FTVAL
```
protected FTVAL(Path oFile)
```
  - FTVAL
```
protected FTVAL(int type,
                Object data)
```
  - FTVAL
```
protected FTVAL(Long value)
```
  - FTVAL
```
protected FTVAL(Integer value)
```
  - FTVAL
```
protected FTVAL(int value)
```
  - FTVAL
```
protected FTVAL(long value)
```
  - FTVAL
```
protected FTVAL(byte[] data)
```
  - FTVAL
```
protected FTVAL(Object data)
```
- Method Detail
  - GetObj
```
public final Object GetObj()
```
    Return the data from this object
    
    Returns:
    
    Object value
  - GetInt
```
public final int GetInt()
```
    Return the integer value from this object
    
    Returns:
    
    int value
  - GetSize
```
public final int GetSize()
```
    Deprecated. returns 0 for indirect files
    
    Return the integer size
    
    Returns:
    
    int size, may be zero if not proper data type
  - GetType
```
public final int GetType()
```
    Deprecated. the type should be private
    
    Return the integer type
    
    Returns:
    
    int type of value
  - getBlob
```
public final byte[] getBlob()
```
    Method to get the value as a byte array if the value is a blob
    
    Returns:
    
    value as a byte array or null
  - getFile
```
public final String getFile()
                     throws Exception
```
    Method to get a file representation of the object
    
    Returns:
    
    file name for the value or null
    
    Throws:
    
    Exception - on error
    
    Since:
    
    5.0
  - getStream
```
public final InputStream getStream()
                            throws Exception
```
    Method to get an input stream for the data
    
    Returns:
    
    input stream for the data or null on error
    
    Throws:
    
    Exception - on error
    
    Since:
    
    5.0
  - getString
```
public final String getString()
```
    Method to get the value as a string if the value is not a blob
    
    Returns:
    
    value as a string or null
    
    Since:
    
    5.0
  - isEmpty
```
public final boolean isEmpty()
```
    Method to determine if a value is empty
    
    Returns:
    
    true if empty else false
    
    Since:
    
    5.0
  - length
```
public final long length()
```
    Method to determine the length of a value
    
    Returns:
    
    length of the value or zero
    
    Since:
    
    5.0
  - toString
```
public final String toString()
```
    Method to convert a value to a string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    value converted to a String or null
    
    Since:
    
    4.0
  - toString
```
public final String toString(String sEncoding)
```
    Method to convert a value to a string
    
    Parameters:
    
    sEncoding - encoding to be used in conversion
    
    Returns:
    
    value converted to a String or null
    
    Since:
    
    4.0
  - readObject
```
public void readObject(ObjectInputStream oObjectInputStream)
                throws IOException,
                       ClassNotFoundException
```
    Method to read a serialized object from an input stream
    
    Parameters:
    
    oObjectInputStream - object input stream
    
    Throws:
    
    IOException - on error
    
    ClassNotFoundException - on error
    
    Since:
    
    5.0
  - readObject
```
public void readObject(ObjectInputStream oObjectInputStream,
                       boolean fileNameOnly)
                throws IOException,
                       ClassNotFoundException
```
    Method to read a serialized object from an input stream
    
    Parameters:
    
    oObjectInputStream - object input stream
    
    fileNameOnly - a boolean value.
    
    Throws:
    
    IOException - on error
    
    ClassNotFoundException - on error
    
    Since:
    
    5.0
  - writeObject
```
public void writeObject(ObjectOutputStream oObjectOutputStream)
                 throws IOException
```
    Method to write a serialized object to an output stream
    
    Parameters:
    
    oObjectOutputStream - object output stream
    
    Throws:
    
    IOException - on error
    
    Since:
    
    5.0
  - writeObject
```
public void writeObject(ObjectOutputStream oObjectOutputStream,
                        boolean fileNameOnly)
                 throws IOException
```
    Method to write a serialized object to an output stream
    
    Parameters:
    
    oObjectOutputStream - object output stream
    
    fileNameOnly - a boolean value.
    
    Throws:
    
    IOException - on error
    
    Since:
    
    5.0

Class FTVAL

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

I4

LONG

DOUBLE

UNKNOWN

LPSTR

BLOB

DATE

Constructor Detail

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

FTVAL

Method Detail

GetObj

GetInt

GetSize

GetType

getBlob

getFile

getStream

getString

isEmpty

length

toString

toString

readObject

readObject

writeObject

writeObject