com.ibm.as400.access
Class ProductList

java.lang.Object
  |
  +--com.ibm.as400.access.ProductList

public class ProductList

extends java.lang.Object

Represents a list of OS/400 licensed products.

See Also:

Product

Field Summary

static java.lang.String	PRODUCT_FILTER_ALL Constant representing a list of all products.
static java.lang.String	PRODUCT_FILTER_INSTALLED Constant representing a list of all installed products.
static java.lang.String	PRODUCT_FILTER_INSTALLED_OR_SUPPORTED Constant representing a list of all installed products and all supported products.
static java.lang.String	PRODUCT_FILTER_LIST Constant representing a list filtered by user-specified criteria.
static java.lang.String	PRODUCT_FILTER_SUPPORTED Constant representing a list of all supported products.
static java.lang.String	PRODUCT_OPTION_ALL Constant representing a list of all product options.
static java.lang.String	PRODUCT_OPTION_BASE Constant representing the base product option.

Constructor Summary

ProductList()
Constructs a ProductList.

ProductList(AS400 system)
Constructs a ProductList for the specified system.

Method Summary

void	addProductToRetrieve(java.lang.String productID, java.lang.String productOption, java.lang.String releaseLevel) Adds a product to the list of products to retrieve when the product filter is set to PRODUCT_FILTER_LIST.
void	clearProductsToRetrieve() Clears the list of products to retrieve and sets the product filter to PRODUCT_FILTER_ALL.
Product[]	getProducts() Retrieves the list of products from the system.
void	setProductFilter(java.lang.String filter) Sets the product filter used to filter the list.
void	setProductOption(java.lang.String option) Sets the product option used to filter the list.
void	setSystem(AS400 system) Sets the system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRODUCT_FILTER_ALL

public static final java.lang.String PRODUCT_FILTER_ALL

Constant representing a list of all products.

See Also:

Constant Field Values

PRODUCT_FILTER_INSTALLED

public static final java.lang.String PRODUCT_FILTER_INSTALLED

Constant representing a list of all installed products.

See Also:

Constant Field Values

PRODUCT_FILTER_INSTALLED_OR_SUPPORTED

public static final java.lang.String PRODUCT_FILTER_INSTALLED_OR_SUPPORTED

Constant representing a list of all installed products and all supported products.

See Also:

Constant Field Values

PRODUCT_FILTER_LIST

public static final java.lang.String PRODUCT_FILTER_LIST

Constant representing a list filtered by user-specified criteria.

See Also:

Constant Field Values

PRODUCT_FILTER_SUPPORTED

public static final java.lang.String PRODUCT_FILTER_SUPPORTED

Constant representing a list of all supported products.

See Also:

Constant Field Values

PRODUCT_OPTION_ALL

public static final java.lang.String PRODUCT_OPTION_ALL

Constant representing a list of all product options.

See Also:

Constant Field Values

PRODUCT_OPTION_BASE

public static final java.lang.String PRODUCT_OPTION_BASE

Constant representing the base product option.

See Also:

Constant Field Values

Constructor Detail

ProductList

public ProductList()

Constructs a ProductList. The system must be set before calling getProducts().

ProductList

public ProductList(AS400 system)

Constructs a ProductList for the specified system. The default product filter is PRODUCT_FILTER_ALL. The default product option is PRODUCT_OPTION_ALL.

Parameters:

system - The system from which to retrieve the list of products.

Method Detail

addProductToRetrieve

public void addProductToRetrieve(java.lang.String productID,
                                 java.lang.String productOption,
                                 java.lang.String releaseLevel)

Adds a product to the list of products to retrieve when the product filter is set to PRODUCT_FILTER_LIST. If the product filter is not set to PRODUCT_FILTER_LIST, then the products added via this method are ignored when the list of products is retrieved from the system.

Parameters:

productID - The product ID, for example: "5722SS1" or "5769JC1". The length must be 7 characters.

productOption - The product option. Valid values are:

• Any valid product option, e.g. "30".
• PRODUCT_OPTION_BASE
• PRODUCT_OPTION_ALL

releaseLevel - The product release level, for example "V5R1M0" or "V4R5M0". The length must be 6 characters.

See Also:

clearProductsToRetrieve()

clearProductsToRetrieve

public void clearProductsToRetrieve()

Clears the list of products to retrieve and sets the product filter to PRODUCT_FILTER_ALL.

See Also:

addProductToRetrieve(java.lang.String, java.lang.String, java.lang.String)

getProducts

public Product[] getProducts()
                      throws AS400Exception,
                             AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException

Retrieves the list of products from the system. Use setProductFilter() and setProductOption() to change the types of products that are returned. Use addProductToRetrieve() to add a specific product to retrieve and specify PRODUCT_FILTER_LIST for the product filter.

Returns:

The array of Product objects.

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

setProductFilter

public void setProductFilter(java.lang.String filter)

Sets the product filter used to filter the list. Valid values are:

• PRODUCT_FILTER_INSTALLED
• PRODUCT_FILTER_SUPPORTED
• PRODUCT_FILTER_INSTALLED_OR_SUPPORTED
• PRODUCT_FILTER_ALL
• PRODUCT_FILTER_LIST

Parameters:

filter - The product filter.

setProductOption

public void setProductOption(java.lang.String option)

Sets the product option used to filter the list. Valid values are:

• PRODUCT_OPTION_ALL
• PRODUCT_OPTION_BASE

setSystem

public void setSystem(AS400 system)

Sets the system.

Parameters:

system - The system.