com.cisco.provisioning.cpe.extensions.services
Interface IPDevice

All Superinterfaces:

GenericObject

public interface IPDevice
extends GenericObject

Logical layer class representing IP Device.

Method Summary

Iterator<IPDevice>	getAllDevicesBehindRelayAgent() Returns all IPDevices.
Iterator<Node>	getAllNodes() Returns all Nodes.
boolean	getBehindRequiredDevice() Returns the BehindRequiredDevice Flag for this object.
Map<String,Object>	getDetectedProperties() Returns the Detected Properties for this object.
Object	getDetectedProperty(String key) Searches for the property with the specified key in the Detected Properties properties map.
DeviceType	getDeviceType() Returns a reference to the related DeviceType object.
Map<DiscoveredDataType,List<? extends DiscoveredData>>	getDiscoveredData() Returns the Discovered Data for this object.
String	getDomainName() Returns the domain name portion of the FQDN.
Short	getDomainNameOffset() Returns the Domain Name Offset for this object.
com.cisco.bac.type.Duid	getDuid() Returns the DUID for this object.
com.cisco.bac.type.Fqdn	getFqdn() Returns the FQDN for this object.
String	getHostName() Returns the hostname portion of the FQDN.
boolean	getInRequiredProvGroup() Returns the InRequiredProvGroup Flag for this object.
com.cisco.bac.type.MacAddress	getMacAddress() Returns the MAC Address for this object.
OwnerID	getOwnerID() Returns a reference to the related OwnerID object.
ProvGroup	getProvGroup() Returns a reference to the related ProvGroup object.
boolean	getRegistered() Returns the Registered Flag for this object.
ClassOfService	getRegisteredClassOfService() Returns a reference to the related ClassOfService object.
DHCPCriteria	getRegisteredDHCPCriteria() Returns a reference to the related DHCPCriteria object.
IPDevice	getRelayAgent() Returns a reference to the related IPDevice object.
ClassOfService	getSelectedClassOfService() Returns a reference to the related ClassOfService object.
DHCPCriteria	getSelectedDHCPCriteria() Returns a reference to the related DHCPCriteria object.
Map<String,Object>	getSelectedProperties() Returns the Selected Properties for this object.
Object	getSelectedProperty(String key) Searches for the property with the specified key in the Selected Properties properties map.
ServiceLevelAccess	getServiceLevelAccess() Returns the Service Level Access for this object.
String	getServiceLevelExplanation() Returns the Service Level Explanation for this object.
ServiceLevelReason	getServiceLevelReason() Returns the Service Level Reason for this object.

Methods inherited from interface com.cisco.provisioning.cpe.extensions.services.GenericObject

equals, getDescription, getOriginal, getProperties, getProperty, getSyncRevNumber, hashCode, isDestroyed, isNew, toString

Method Detail

getMacAddress

com.cisco.bac.type.MacAddress getMacAddress()

Returns the MAC Address for this object.

getDuid

com.cisco.bac.type.Duid getDuid()

Returns the DUID for this object.

getFqdn

com.cisco.bac.type.Fqdn getFqdn()

Returns the FQDN for this object.

getRegistered

boolean getRegistered()

Returns the Registered Flag for this object.

getBehindRequiredDevice

boolean getBehindRequiredDevice()

Returns the BehindRequiredDevice Flag for this object.

getInRequiredProvGroup

boolean getInRequiredProvGroup()

Returns the InRequiredProvGroup Flag for this object.

getDiscoveredData

Map<DiscoveredDataType,List<? extends DiscoveredData>> getDiscoveredData()

Returns the Discovered Data for this object.

getDomainNameOffset

Short getDomainNameOffset()

Returns the Domain Name Offset for this object.

getServiceLevelAccess

ServiceLevelAccess getServiceLevelAccess()

Returns the Service Level Access for this object.

getServiceLevelReason

ServiceLevelReason getServiceLevelReason()

Returns the Service Level Reason for this object.

getServiceLevelExplanation

String getServiceLevelExplanation()

Returns the Service Level Explanation for this object.

getDetectedProperties

Map<String,Object> getDetectedProperties()

Returns the Detected Properties for this object.

getDetectedProperty

Object getDetectedProperty(String key)

Searches for the property with the specified key in the Detected Properties properties map. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in the properties map with specified key value.

getSelectedProperties

Map<String,Object> getSelectedProperties()

Returns the Selected Properties for this object.

getSelectedProperty

Object getSelectedProperty(String key)

Searches for the property with the specified key in the Selected Properties properties map. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in the properties map with specified key value.

getSelectedClassOfService

ClassOfService getSelectedClassOfService()

Returns a reference to the related ClassOfService object.

Returns:

the ClassOfService reference or null if does not exist

getProvGroup

ProvGroup getProvGroup()

Returns a reference to the related ProvGroup object.

Returns:

the ProvGroup reference or null if does not exist

getOwnerID

OwnerID getOwnerID()

Returns a reference to the related OwnerID object.

Returns:

the OwnerID reference or null if does not exist

getAllDevicesBehindRelayAgent

Iterator<IPDevice> getAllDevicesBehindRelayAgent()

Returns all IPDevices.

Returns:

an iterator of IPDevice objects

getDeviceType

DeviceType getDeviceType()

Returns a reference to the related DeviceType object.

Returns:

the DeviceType reference or null if does not exist

getRelayAgent

IPDevice getRelayAgent()

Returns a reference to the related IPDevice object.

Returns:

the IPDevice reference or null if does not exist

getRegisteredDHCPCriteria

DHCPCriteria getRegisteredDHCPCriteria()

Returns a reference to the related DHCPCriteria object.

Returns:

the DHCPCriteria reference or null if does not exist

getAllNodes

Iterator<Node> getAllNodes()

Returns all Nodes.

Returns:

an iterator of Node objects

getRegisteredClassOfService

ClassOfService getRegisteredClassOfService()

Returns a reference to the related ClassOfService object.

Returns:

the ClassOfService reference or null if does not exist

getSelectedDHCPCriteria

DHCPCriteria getSelectedDHCPCriteria()

Returns a reference to the related DHCPCriteria object.

Returns:

the DHCPCriteria reference or null if does not exist

getHostName

String getHostName()

Returns the hostname portion of the FQDN. If hostname was not set explicitly, the code returns everything in the FQDN upto the first dot.

getDomainName

String getDomainName()

Returns the domain name portion of the FQDN. If domains name was not set explicitly, the code returns everything in the FQDN after the first dot.