IList (Oracle WebCenter Sites Java API Reference)

All Known Implementing Classes:

COM.FutureTense.Util.IListWrapper, IterableIListWrapper
```
public interface IList
```
This interface defines the IList object that is used throughout Content Server for database queries and other representations of tabular data. Individuals may choose to implement this for custom application purposes. Also, in order to create a custom list object that is accessible through the ICS object or the XML scripting language, you have to implement this interface.

Version:

$Revision: 16 $

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`first` Command indicating that `IList.moveToRow(int, int)` should move to the first row.
`static int`	`gotorow` Command indicating that `IList.moveToRow(int, int)` should move to the specified row.
`static int`	`last` Command indicating that `IList.moveToRow(int, int)` should move to the last row.
`static int`	`next` Command indicating that `IList.moveToRow(int, int)` should move to the next row.
`static int`	`prev` Command indicating that `IList.moveToRow(int, int)` should move to the previous row.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`atEnd()` Return whether this list is at the last row (at the end) of the rows of data.
`IList`	`clone(String newname)` Normally used internally by CS server to shallow copy a list object; return null from a user defined list object if support isn't implemented or desired.
`int`	`currentRow()` Returns the number of the current row of this list.
`void`	`flush()` Flushes a list object, clearing the resultset from the cache and notifies the rest of the cluster member (if any).
`String`	`getColumnName(int i)` Retrieves the name of the column at an offset, counting from 0 (zero).
`byte[]`	`getFileData(String columname)` Returns the data contained in a referenced data file.
`String`	`getFileString(String columname)` Returns the string data contained in a referenced data file.
`String`	`getIndirectColumnName(int index)` Supplies the upload column by index.
`String`	`getName()` Retrieves the name of this list.
`Object`	`getObject(String colname)` Get an object from the specified column for the current row.
`String`	`getValue(String columname)` Retrieves the value of a named column for the current row.
`boolean`	`hasData()` Checks if the list contains any data.
`boolean`	`moveTo(int i)` Moves the list to a given row number.
`boolean`	`moveToRow(int how, int v)` Move to a new row given a specific command
`int`	`numColumns()` Retrieves the number of columns in the list, excluding indirect columns.
`int`	`numIndirectColumns()` Return a count of columns which are meant to be indirect data pointers; normally only used by internal CS ilist objects so the default implementation for a user-defined ilist should return 0
`int`	`numRows()` Returns the number of rows in a list.
`void`	`rename(String newname)` Allow the renaming of a list
`boolean`	`stringInList(String item)` Internal CS function; 1 column lists may choose to implement whether a given value is in any row.

- Field Detail
  - next
```
static final int next
```
    Command indicating that IList.moveToRow(int, int) should move to the next row.
    
    See Also:
    
    Constant Field Values
  - prev
```
static final int prev
```
    Command indicating that IList.moveToRow(int, int) should move to the previous row.
    
    See Also:
    
    Constant Field Values
  - first
```
static final int first
```
    Command indicating that IList.moveToRow(int, int) should move to the first row.
    
    See Also:
    
    Constant Field Values
  - last
```
static final int last
```
    Command indicating that IList.moveToRow(int, int) should move to the last row.
    
    See Also:
    
    Constant Field Values
  - gotorow
```
static final int gotorow
```
    Command indicating that IList.moveToRow(int, int) should move to the specified row.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Retrieves the name of this list. The name corresponds to the name the list is registered with in the ContentServer context.
    
    Returns:
    
    Returns the name of the list.
  - hasData
```
boolean hasData()
```
    Checks if the list contains any data.
    
    Returns:
    
    Returns true if the list contains data, false if it is empty.
  - numColumns
```
int numColumns()
```
    Retrieves the number of columns in the list, excluding indirect columns.
    
    Returns:
    
    Returns the number of columns.
  - currentRow
```
int currentRow()
```
    Returns the number of the current row of this list. Rows begin numbering from one.
    
    Returns:
    
    Returns the current row number or -1 if there is no current row. This can be caused by an internal error or empty list.
  - getValue
```
String getValue(String columname)
         throws NoSuchFieldException
```
    Retrieves the value of a named column for the current row.
    
    Parameters:
    
    columname - The name of the column to get the results for.
    
    Returns:
    
    Returns the value of the column. May be null or empty, depending on the data type.
    
    Throws:
    
    NoSuchFieldException - on error
  - getObject
```
Object getObject(String colname)
          throws NoSuchFieldException
```
    Get an object from the specified column for the current row. The type of data stored in the list is implementation-specific. For example, if the list represents a database query, the object returned will be null unless the column represents a byte array. Other lists may return particular types
    
    Parameters:
    
    colname - The name of the column to get the results for.
    
    Returns:
    
    Returns an Object
    
    Throws:
    
    NoSuchFieldException - on error
  - getFileData
```
byte[] getFileData(String columname)
            throws IllegalArgumentException,
                   NoSuchFieldException
```
    Returns the data contained in a referenced data file. This call reads data from the associated file upon each invocation.
    
    Parameters:
    
    columname - The name of the column.
    
    Returns:
    
    Returns the byte[] value, which can be "null".
    
    Throws:
    
    IllegalArgumentException - if the column is not an indirect column
    
    NoSuchFieldException - if the field is invalid
  - getFileString
```
String getFileString(String columname)
              throws NoSuchFieldException
```
    Returns the string data contained in a referenced data file.
    
    Parameters:
    
    columname - The name of the column.
    
    Returns:
    
    Returns the string value, which can be "null".
    
    Throws:
    
    NoSuchFieldException - if the column is not an indirect data type
  - flush
```
void flush()
```
    Flushes a list object, clearing the resultset from the cache and notifies the rest of the cluster member (if any).
  - getColumnName
```
String getColumnName(int i)
              throws ArrayIndexOutOfBoundsException
```
    Retrieves the name of the column at an offset, counting from 0 (zero).
    
    Parameters:
    
    i - The offset column number.
    
    Returns:
    
    Returns the column name.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - on accessing out of array index
  - numRows
```
int numRows()
```
    Returns the number of rows in a list. USE WITH CARE. If the list represents uncached data in a database, a large delay and high memory useage might be encountered as the list must be scanned ON THE DATABASE SIDE to determine the count.
    
    Returns:
    
    Returns the number of rows in the list.
  - moveTo
```
boolean moveTo(int i)
```
    Moves the list to a given row number.
    
    Parameters:
    
    i - The row number, numbered from one.
    
    Returns:
    
    Returns true on success, false on failure.
  - atEnd
```
boolean atEnd()
```
    Return whether this list is at the last row (at the end) of the rows of data.
    
    Returns:
    
    boolean true if already navigated to first or last row
  - moveToRow
```
boolean moveToRow(int how,
                  int v)
```
    Move to a new row given a specific command
    
    Parameters:
    
    how - command
    
    v - value of the new row if how is IList.gotorow
    
    Returns:
    
    boolean if navigation succeeded
  - numIndirectColumns
```
int numIndirectColumns()
```
    Return a count of columns which are meant to be indirect data pointers; normally only used by internal CS ilist objects so the default implementation for a user-defined ilist should return 0
    
    Returns:
    
    Return a count of columns which are meant to be indirect data pointers
  - getIndirectColumnName
```
String getIndirectColumnName(int index)
```
    Supplies the upload column by index. This is normally used only by the internal IPS, which generates list objects for URL columns, that is upload datasource columns. Normally a user defined ilist should return null
    
    Parameters:
    
    index - an Integer
    
    Returns:
    
    Return a string
  - clone
```
IList clone(String newname)
```
    Normally used internally by CS server to shallow copy a list object; return null from a user defined list object if support isn't implemented or desired. A user-defined implementation may decide to provide a deep copy.
    
    Parameters:
    
    newname - new name
    
    Returns:
    
    a IList
  - rename
```
void rename(String newname)
```
    Allow the renaming of a list
    
    Parameters:
    
    newname - new name
    
    See Also:
    
    IList.getName()
  - stringInList
```
boolean stringInList(String item)
```
    Internal CS function; 1 column lists may choose to implement whether a given value is in any row. Only works on StringList and FileList IPS (not DB queries) objects or enhanced 3rd party IList objects.
    
    Parameters:
    
    item - an Item
    
    Returns:
    
    boolean value based on condition

Interface IList

Field Summary

Method Summary

Field Detail

next

prev

first

last

gotorow

Method Detail

getName

hasData

numColumns

currentRow

getValue

getObject

getFileData

getFileString

flush

getColumnName

numRows

moveTo

atEnd

moveToRow

numIndirectColumns

getIndirectColumnName

clone

rename

stringInList