com.novell.nxpe
Interface NxpeParameterList

public interface NxpeParameterList

Defines methods for retieving configuration and instance parematers as defined in the policy type specification.

Since:

NXPE1.0

Author:

Paladin Team

Method Summary

NxpeGroupedParameter	getGroupedParameter(int iEnumerativeValue, int iGroupEnumerativeValue, int iChoiceEnumerativeValue) Deprecated. Retrieves the NxpeGroupedParamter object idenified by the enumerative values.
NxpeParameter	getParameter(int iEnumerativeValue) Retrieves the parameter referenced by the enumerative value.
java.util.Iterator<NxpeParameter>	iterator() Retrieves the first NxpeParameter object in the parameter list when the parameter is not in a group.
java.util.Iterator<NxpeGroupedParameter>	iterator(int iGroupEnumerativeValue) Deprecated. Retrieves the first NxpeGroupedParameter object for the grouped parameter specified by the group enumerative value.
java.util.Iterator<NxpeGroupedParameter>	iterator(int iGroupEnumerativeValue, int iChoiceEnumerativeValue) Deprecated. Returns first NxpeGroupedParameter object for a grouped parameter that is specified by the group enumerative value and the choice enumerative value.

Method Detail

getParameter

NxpeParameter getParameter(int iEnumerativeValue)
                           throws NxpeException

Retrieves the parameter referenced by the enumerative value.

Parameters:

iEnumerativeValue - The enumerative value of the parameter to return.

Returns:

An NxpeParameter object with the parameter.

Throws:

NxpeException

getGroupedParameter

NxpeGroupedParameter getGroupedParameter(int iEnumerativeValue,
                                         int iGroupEnumerativeValue,
                                         int iChoiceEnumerativeValue)
                                         throws NxpeException

Deprecated.

Retrieves the NxpeGroupedParamter object idenified by the enumerative values.

Parameters:

iEnumerativeValue - The enumerative value of the parameter to return.

iGroupEnumerativeValue - The enumerative value of the paramter group to which the parameter belongs.

iChoiceEnumerativeValue - The enumerative value of the parameter group choice to which the parameter belongs.

Returns:

A NxpeGroupedParamater object.

Throws:

NxpeException

iterator

java.util.Iterator<NxpeParameter> iterator()
                                           throws NxpeException

Retrieves the first NxpeParameter object in the parameter list when the parameter is not in a group.

Returns:

A pointer to an NxpeParameter object.

Throws:

NxpeException

iterator

java.util.Iterator<NxpeGroupedParameter> iterator(int iGroupEnumerativeValue)
                                                  throws NxpeException

Deprecated.

Retrieves the first NxpeGroupedParameter object for the grouped parameter specified by the group enumerative value.

Parameters:

iGroupEnumerativeValue - The enumerative value of the parameter group.

Returns:

A pointer to a NxpeGroupedParameter object.

Throws:

NxpeException

iterator

java.util.Iterator<NxpeGroupedParameter> iterator(int iGroupEnumerativeValue,
                                                  int iChoiceEnumerativeValue)
                                                  throws NxpeException

Deprecated.

Returns first NxpeGroupedParameter object for a grouped parameter that is specified by the group enumerative value and the choice enumerative value.

Parameters:

iGroupEnumerativeValue - The parameter group enumerative value.

iChoiceEnumerativeValue - The parameter group choice enumerative value.

Returns:

A pointer to a NxpeGroupedParamter object.

Throws:

NxpeException