Modifier and Type | Field and Description |
---|---|
static String |
PRODUCT_FILTER_ALL
Constant representing a list of all products.
|
static String |
PRODUCT_FILTER_INSTALLED
Constant representing a list of all installed products.
|
static String |
PRODUCT_FILTER_INSTALLED_OR_SUPPORTED
Constant representing a list of all installed products and all supported products.
|
static String |
PRODUCT_FILTER_LIST
Constant representing a list filtered by user-specified criteria.
|
static String |
PRODUCT_FILTER_SUPPORTED
Constant representing a list of all supported products.
|
static String |
PRODUCT_OPTION_ALL
Constant representing a list of all product options.
|
static String |
PRODUCT_OPTION_BASE
Constant representing the base product option.
|
Constructor and Description |
---|
ProductList()
Constructs a ProductList.
|
ProductList(AS400 system)
Constructs a ProductList for the specified system.
|
Modifier and Type | Method and Description |
---|---|
void |
addProductToRetrieve(String productID,
String productOption,
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(String filter)
Sets the product filter used to filter the list.
|
void |
setProductOption(String option)
Sets the product option used to filter the list.
|
void |
setSystem(AS400 system)
Sets the system.
|
public static final String PRODUCT_FILTER_ALL
public static final String PRODUCT_FILTER_INSTALLED
public static final String PRODUCT_FILTER_INSTALLED_OR_SUPPORTED
public static final String PRODUCT_FILTER_LIST
public static final String PRODUCT_FILTER_SUPPORTED
public static final String PRODUCT_OPTION_ALL
public static final String PRODUCT_OPTION_BASE
public ProductList()
getProducts()
.public ProductList(AS400 system)
system
- The system from which to retrieve the list of products.public void addProductToRetrieve(String productID, String productOption, String releaseLevel)
productID
- The product ID, for example: "5722SS1" or "5769JC1". The length must be 7 characters.productOption
- The product option. Valid values are:
PRODUCT_OPTION_BASE
PRODUCT_OPTION_ALL
releaseLevel
- The product release level, for example "V5R1M0" or "V4R5M0". The length must be 6 characters.clearProductsToRetrieve()
public void clearProductsToRetrieve()
PRODUCT_FILTER_ALL
.public Product[] getProducts() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException
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.AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException
public void setProductFilter(String filter)
filter
- The product filter.public void setProductOption(String option)
option
- The product option.public void setSystem(AS400 system)
system
- The system.