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

public interface ServiceLevel

An object that represents the service level a device will receive.

Method Summary

ServiceLevelAccess	getAccess() Return an enumeration code representing the type of access that was granted to the device.
ClassOfService	getClassOfService() Return the selected class of service to use for configuration generation.
DHCPCriteria	getDHCPCriteria() Return the selected DHCP criteria to use for configuration generation.
String	getExplanation() Return the explanation for selecting the access granted to the device.
Map<String,Object>	getProperties() Return a map of properties to use for configuration generation.
ServiceLevelReason	getReason() Return an enumeration code describing the reason for selecting the access granted to the device.
boolean	isBehindRequiredDevice() Return true if the device is behind the relay agent it is required to be behind, or if no required relay agent was specified
boolean	isInRequiredProvGroup() Return true if the device is in the provisioning group it is required to be in, or if no required provisioning group was specified
void	setAccess(ServiceLevelAccess access) Set the enumeration code that represents the type of access that was granted to the device.
void	setBehindRequiredDevice(boolean isBehindRequiredDevice) Set the flag indicating if the device is behind its required relay agent.
void	setClassOfService(ClassOfService classOfService) Set the selected class of service to use for configuration generation.
void	setDHCPCriteria(DHCPCriteria dhcpCriteria) Set the selected DHCP criteria to use for configuration generation.
void	setExplanation(String explanation) Set explanation for selecting the access granted to the device.
void	setInRequiredProvGroup(boolean isInRequiredProvGroup) Set the flag indicating if the device is in its required provisioning group.
void	setProperties(Map<String,Object> properties) Set a map of properties to use for configuration generation.
void	setReason(ServiceLevelReason reason) Set the reason for selecting the access granted to the device.

Method Detail

getAccess

ServiceLevelAccess getAccess()

Return an enumeration code representing the type of access that was granted to the device.

Returns:

the type of access that was granted to the device.

getClassOfService

ClassOfService getClassOfService()

Return the selected class of service to use for configuration generation.

Returns:

the selected class of service.

getDHCPCriteria

DHCPCriteria getDHCPCriteria()

Return the selected DHCP criteria to use for configuration generation.

Returns:

the selected DHCP criteria.

getExplanation

String getExplanation()

Return the explanation for selecting the access granted to the device.

Returns:

the explanation for selecting the access granted to the device.

getProperties

Map<String,Object> getProperties()

Return a map of properties to use for configuration generation.

Returns:

the selected properties.

getReason

ServiceLevelReason getReason()

Return an enumeration code describing the reason for selecting the access granted to the device.

Returns:

the reason for selecting the access granted to the device.

isBehindRequiredDevice

boolean isBehindRequiredDevice()

Return true if the device is behind the relay agent it is required to be behind, or if no required relay agent was specified

Returns:

true if the device meets the requirement.

See Also:

IPDeviceKeys.MUST_BE_BEHIND_DEVICE

isInRequiredProvGroup

boolean isInRequiredProvGroup()

Return true if the device is in the provisioning group it is required to be in, or if no required provisioning group was specified

Returns:

true if the device meets the requirement.

See Also:

IPDeviceKeys.MUST_BE_IN_PROV_GROUP

setAccess

void setAccess(ServiceLevelAccess access)

Set the enumeration code that represents the type of access that was granted to the device.

Parameters:

access - the type of access that was granted to the device.

setBehindRequiredDevice

void setBehindRequiredDevice(boolean isBehindRequiredDevice)

Set the flag indicating if the device is behind its required relay agent.

Parameters:

isBehindRequiredDevice - true to indicate the device is behind its required relay agent, or no required relay agent has been specified, false to indicate the device is not behind its required relay agent.

See Also:

IPDeviceKeys.MUST_BE_BEHIND_DEVICE

setClassOfService

void setClassOfService(ClassOfService classOfService)

Set the selected class of service to use for configuration generation.

Parameters:

classOfService - the selected class of service.

setDHCPCriteria

void setDHCPCriteria(DHCPCriteria dhcpCriteria)

Set the selected DHCP criteria to use for configuration generation.

Parameters:

dhcpCriteria - the selected DHCP criteria.

setExplanation

void setExplanation(String explanation)

Set explanation for selecting the access granted to the device.

Parameters:

explanation - a string explaining the reason for selecting the access granted to the device

setInRequiredProvGroup

void setInRequiredProvGroup(boolean isInRequiredProvGroup)

Set the flag indicating if the device is in its required provisioning group.

Parameters:

isInRequiredProvGroup - true to indicate the device is in its required provisioning group, or no required group has been specified, false to indicate the device is not in its required provisioning group.

See Also:

IPDeviceKeys.MUST_BE_IN_PROV_GROUP

setProperties

void setProperties(Map<String,Object> properties)

Set a map of properties to use for configuration generation.

Parameters:

properties - the selected properties.

setReason

void setReason(ServiceLevelReason reason)

Set the reason for selecting the access granted to the device.

Parameters:

reason - the reason for selecting the access granted to the device.