com.cisco.provisioning.cpe.extensions.configuration
Interface OptionDesc

public interface OptionDesc

The OptionDesc class defines an immutable object that represents a specific DOCSIS option that is supported by CSRC. The OptionDesc instances are retrieved from the OptionManager singleton. The OptionDesc class provides a number of accessor methods that return the attributes of a supported DOCSIS option. To create option values that are part of a DOCSIS configuration file use the OptionManager to create OptionValue instances.

See Also:

OptionValue

Method Summary

String	getDescription() Get the description of the option.
int	getLengthByteCount() Returns the number of length bytes used by the TLV encoding.
int	getMajorOptionNum() Get the major option number value.
int	getOptionNum() Get the option number value.
String	getOptionNumString() Get the fully qualified option number.
String	getOUI() Get the oui of the option.
String	getUnits() Get the units of the option.
boolean	isCompound() Determine whether this option has sub-options.
boolean	isFragmentable() Returns whether the TLV can be fragmented.
boolean	isMultiValue() Determine whether this option is a a multivalue option.
boolean	isTopLevel() Determine whether this option is a top level option.

Method Detail

getOptionNumString

String getOptionNumString()

Get the fully qualified option number.

Returns:

String option number

getMajorOptionNum

int getMajorOptionNum()

Get the major option number value.

Returns:

integer major option number

getOptionNum

int getOptionNum()

Get the option number value.

Returns:

integer option number

getDescription

String getDescription()

Get the description of the option.

Returns:

String option description, or null if no description

getUnits

String getUnits()

Get the units of the option.

Returns:

String units value, or null if no units value

isTopLevel

boolean isTopLevel()

Determine whether this option is a top level option.

Returns:

true if top level, otherwise false

isMultiValue

boolean isMultiValue()

Determine whether this option is a a multivalue option.

Returns:

true if multivalue, otherwise false

isCompound

boolean isCompound()

Determine whether this option has sub-options.

Returns:

true if has sub-options, otherwise false

getLengthByteCount

int getLengthByteCount()

Returns the number of length bytes used by the TLV encoding. For DOCSIS 1.0 and DOCSIS 1.1 this value is always 1.

isFragmentable

boolean isFragmentable()

Returns whether the TLV can be fragmented. Fragmented TLV's have values that exceed the maximum length permitted by the number of length bytes They are fragmented into multiple TLV's within the TLV instance.

Returns:

true if TLV is fragmented, otherwise false.

getOUI

String getOUI()

Get the oui of the option.

Returns:

String oui value, or null if oui is specified