NextHopIPRoute.java

/**
 * This file was auto-generated by mofcomp -j version 1.0.0 on Wed Jan 12
 * 09:21:06 CET 2011.
 */

package org.opennaas.extensions.router.model;

import java.io.*;
import java.lang.Exception;

/**
 * This Class contains accessor and mutator methods for all properties defined in the CIM class NextHopIPRoute as well as methods comparable to the
 * invokeMethods defined for this class. This Class implements the NextHopIPRouteBean Interface. The CIM class NextHopIPRoute is described as follows:
 * 
 * NextHopIPRoute specifies routing in an IP network.
 */
public class NextHopIPRoute extends NextHopRoute implements Serializable {

	/**
	 * This constructor creates a NextHopIPRouteBeanImpl Class which implements the NextHopIPRouteBean Interface, and encapsulates the CIM class
	 * NextHopIPRoute in a Java Bean. The CIM class NextHopIPRoute is described as follows:
	 * 
	 * NextHopIPRoute specifies routing in an IP network.
	 */
	public NextHopIPRoute() {
	};

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property RouteDerivation.
	 */

	public enum RouteDerivation {
		UNKNOWN,
		OTHER,
		CONNECTED,
		USER_DEFINED,
		IGRP,
		EIGRP,
		RIP,
		HELLO,
		EGP,
		BGP,
		ISIS,
		OSPF
	}

	private RouteDerivation	routeDerivation;

	/**
	 * This method returns the NextHopIPRoute.routeDerivation property value. This property is described as follows:
	 * 
	 * An enumerated integer indicating how the route was derived. This is useful for display and query purposes.
	 * 
	 * @return int current routeDerivation property value
	 * @exception Exception
	 */
	public RouteDerivation getRouteDerivation() {

		return this.routeDerivation;
	} // getRouteDerivation

	/**
	 * This method sets the NextHopIPRoute.routeDerivation property value. This property is described as follows:
	 * 
	 * An enumerated integer indicating how the route was derived. This is useful for display and query purposes.
	 * 
	 * @param int new routeDerivation property value
	 * @exception Exception
	 */
	public void setRouteDerivation(RouteDerivation routeDerivation) {

		this.routeDerivation = routeDerivation;
	} // setRouteDerivation

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property otherDerivation.
	 */
	private String	otherDerivation;

	/**
	 * This method returns the NextHopIPRoute.otherDerivation property value. This property is described as follows:
	 * 
	 * A string describing how the route was derived when the RouteDerivation property is 1 ("Other").
	 * 
	 * @return String current otherDerivation property value
	 * @exception Exception
	 */
	public String getOtherDerivation() {

		return this.otherDerivation;
	} // getOtherDerivation

	/**
	 * This method sets the NextHopIPRoute.otherDerivation property value. This property is described as follows:
	 * 
	 * A string describing how the route was derived when the RouteDerivation property is 1 ("Other").
	 * 
	 * @param String
	 *            new otherDerivation property value
	 * @exception Exception
	 */
	public void setOtherDerivation(String otherDerivation) {

		this.otherDerivation = otherDerivation;
	} // setOtherDerivation

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property destinationMask.
	 */
	private String	destinationMask;

	/**
	 * This method returns the NextHopIPRoute.destinationMask property value. This property is described as follows:
	 * 
	 * The mask for the Ipv4 destination address.
	 * 
	 * @return String current destinationMask property value
	 * @exception Exception
	 */
	public String getDestinationMask() {

		return this.destinationMask;
	} // getDestinationMask

	/**
	 * This method sets the NextHopIPRoute.destinationMask property value. This property is described as follows:
	 * 
	 * The mask for the Ipv4 destination address.
	 * 
	 * @param String
	 *            new destinationMask property value
	 * @exception Exception
	 */
	public void setDestinationMask(String destinationMask) {

		this.destinationMask = destinationMask;
	} // setDestinationMask

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property prefixLength.
	 */
	private short	prefixLength;

	/**
	 * This method returns the NextHopIPRoute.prefixLength property value. This property is described as follows:
	 * 
	 * The prefix length for the IPv6 destination address.
	 * 
	 * @return short current prefixLength property value
	 * @exception Exception
	 */
	public short getPrefixLength() {

		return this.prefixLength;
	} // getPrefixLength

	/**
	 * This method sets the NextHopIPRoute.prefixLength property value. This property is described as follows:
	 * 
	 * The prefix length for the IPv6 destination address.
	 * 
	 * @param short new prefixLength property value
	 * @exception Exception
	 */
	public void setPrefixLength(short prefixLength) {

		this.prefixLength = prefixLength;
	} // setPrefixLength

	/**
	 * The following constants are defined for use with the ValueMap/Values qualified property AddressType.
	 */

	public enum AddressType {
		UNKNOWN,
		IPV4,
		IPV6
	}

	private AddressType	addressType;

	/**
	 * This method returns the NextHopIPRoute.addressType property value. This property is described as follows:
	 * 
	 * An enumeration that describes the format of the address properties.
	 * 
	 * @return int current addressType property value
	 * @exception Exception
	 */
	public AddressType getAddressType() {

		return this.addressType;
	} // getAddressType

	/**
	 * This method sets the NextHopIPRoute.addressType property value. This property is described as follows:
	 * 
	 * An enumeration that describes the format of the address properties.
	 * 
	 * @param int new addressType property value
	 * @exception Exception
	 */
	public void setAddressType(AddressType addressType) {

		this.addressType = addressType;
	} // setAddressType

} // Class NextHopIPRoute