oracle.ifs.common

Interface Collection

All Superinterfaces:

IfsEventHandler

All Known Implementing Classes:

CachedCollection, CachedResolverCollection, CachedSelectorCollection, LibraryObjectLookupCacheCollection, TieLibraryObjectLookupCacheCollection, UncachedPreparedSelectorCollection, UncachedSelectorCollection

public interface Collection
extends IfsEventHandler

A Collection is a set of Java objects.

iFS uses Collections to provide an easy-to-use API to access various sets of LIBRARYOBJECTs. LibrarySession and S_LibrarySession provide several methods, getcollectionCollection, to access the Collections they maintain.

Collection implementations may cache the items they contain. For this reason, Collections are more performant than Selectors or S_Selectors.

For performance, applications iterating over the items in a Collection should use getItems() rather than getItems(int).

Version:

2.0

Author:

David Pitfield

(Published)

Method Summary

Modifier and Type	Method and Description
Object	checkItemByUpperCaseName(String name) Gets the specified item in this Collection by the uppercase name, *and returns null if the item is not found.
Object	getItemByUpperCaseName(String name) Gets the specified item in this Collection by the uppercase name.
int	getItemCount() Gets the number of items in this Collection.
Object[]	getItems() Gets an array containing the items in this Collection.
Object	getItems(int index) Gets the specified item in this Collection.
Object	getItems(String name) Gets the specified item in this Collection.
Vector	getItemsVector() Gets a vector containing the items in this Collection.
void	reset() Resets this Collection.

Methods inherited from interface oracle.ifs.common.IfsEventHandler

handleEvent

Method Detail

getItemCount

int getItemCount()
          throws IfsException

Gets the number of items in this Collection.

Returns:

the number of items in this Collection

Throws:

IfsException - (IFS-12211) if the operation fails

(Published)

getItems

Object[] getItems()
           throws IfsException

Gets an array containing the items in this Collection.

Returns:

the items in this Collection

Throws:

IfsException - (IFS-12212) if the operation fails

(Published)

getItems

Object getItems(int index)
         throws IfsException

Gets the specified item in this Collection.

Parameters:

index - the zero-based index of the item

Returns:

the item

Throws:

IfsException - (IFS-12213) if the operation fails

(Published)

getItems

Object getItems(String name)
         throws IfsException

Gets the specified item in this Collection.

Parameters:

name - the name of the item

Returns:

the item

Throws:

IfsException - (IFS-12214) if the operation fails

(Published)

getItemByUpperCaseName

Object getItemByUpperCaseName(String name)
                       throws IfsException

Gets the specified item in this Collection by the uppercase name.

Parameters:

name - the name of the item

Returns:

the item

Throws:

IfsException - (IFS-12214) if the operation fails

(Unpublished)

checkItemByUpperCaseName

Object checkItemByUpperCaseName(String name)
                         throws IfsException

Gets the specified item in this Collection by the uppercase name, *and returns null if the item is not found.

Parameters:

name - the name of the item

Returns:

the item, or null if not found

Throws:

IfsException - if the operation fails

(Unpublished)

getItemsVector

Vector getItemsVector()
               throws IfsException

Gets a vector containing the items in this Collection.

The order of the items in the vector is identical to the order of the items in the array returned by getItems().

Returns:

a vector containing the items in this Collection

Throws:

IfsException - (IFS-12215) if the operation fails

(Published)

reset

void reset()
    throws IfsException

Resets this Collection.

Resetting a Collection causes the items in it to be redetermined.

Throws:

IfsException - (IFS-12216) if the operation fails

(Unpublished)