Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.generated.AccessDevice

co.ecg.alpaca.toolkit.generated.GroupAccessDevice

All Implemented Interfaces:

Serializable

public class GroupAccessDevice
extends AccessDevice

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroupAccessDevice.GroupAccessDeviceAddRequest	Request to add a group access device.
static class	GroupAccessDevice.GroupAccessDeviceAvailablePortGetListRequest	Request to get the list of available ports in a device.
static class	GroupAccessDevice.GroupAccessDeviceAvailablePortGetListResponse	Response to GroupAccessDeviceAvailablePortGetListRequest.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagAddOrModifyListRequest	Request to add or modify a list of static configuration tag for a group access device.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagAddRequest	Request to add a static configuration tag for a group access device.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagDeleteListRequest	Request to delete static configuration tags for a group access device.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagGetListRequest	Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagGetListResponse	Response to GroupAccessDeviceCustomTagGetListRequest.
static class	GroupAccessDevice.GroupAccessDeviceCustomTagModifyRequest	Request to modify a static configuration tag for a group access device.
static class	GroupAccessDevice.GroupAccessDeviceDeleteRequest	Request to delete a specified group access device.
static class	GroupAccessDevice.GroupAccessDeviceDeviceActivationGetRequest	Requests the activation information for a device configured at the Group level.
static class	GroupAccessDevice.GroupAccessDeviceDeviceActivationGetResponse	Response to GroupAccessDeviceDeviceActivationGetRequest.
static class	GroupAccessDevice.GroupAccessDeviceDeviceActivationModifyRequest	Activates or deactivates a device configured at the Group level.
static class	GroupAccessDevice.GroupAccessDeviceFileGetListRequest	Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
static class	GroupAccessDevice.GroupAccessDeviceFileGetListResponse	Response to GroupAccessDeviceFileGetListRequest14sp8.
static class	GroupAccessDevice.GroupAccessDeviceFileGetRequest	Request to get a group device profile file.
static class	GroupAccessDevice.GroupAccessDeviceFileGetResponse	Response to GroupAccessDeviceFileGetRequest20.
static class	GroupAccessDevice.GroupAccessDeviceFileModifyRequest	Request to modify a specified group access device file.
static class	GroupAccessDevice.GroupAccessDeviceGenerateActivationCodeRequest	Requests a new activation code for a device configured at the Group level.
static class	GroupAccessDevice.GroupAccessDeviceGetAvailableCustomTagListRequest	Get the list of all available custom tags managed by the Device Management System, on a per-device profile basis.
static class	GroupAccessDevice.GroupAccessDeviceGetAvailableCustomTagListResponse	Response to GroupAccessDeviceGetAvailableCustomTagListRequest.
static class	GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListRequest	Requests the list of available access devices for assignment to a user within a group.
static class	GroupAccessDevice.GroupAccessDeviceGetAvailableDetailListResponse	Response to GroupAccessDeviceGetAvailableDetailListRequest19.
static class	GroupAccessDevice.GroupAccessDeviceGetEnhancedConfigurationTypeListRequest	Requests the list of configurable device types of devices that have already been added to the group.
static class	GroupAccessDevice.GroupAccessDeviceGetEnhancedConfigurationTypeListResponse	Response to GroupAccessDeviceGetEnhancedConfigurationTypeListRequest.
static class	GroupAccessDevice.GroupAccessDeviceGetEnhancedConfigurationTypeRequest	Requests the details of a specified configurable device type for a group.
static class	GroupAccessDevice.GroupAccessDeviceGetEnhancedConfigurationTypeResponse	Response to GroupAccessDeviceGetEnhancedConfigurationTypeRequest14.
static class	GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest	Requests the list of linked leaf devices for the group level tree device passed in the request.
static class	GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListResponse	Response to GroupAccessDeviceGetLinkedLeafDeviceListRequest22.
static class	GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest	Requests the tree device linked with the group level leaf device passed in the request.
static class	GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceResponse	Response to GroupAccessDeviceGetLinkedTreeDeviceRequest.
static class	GroupAccessDevice.GroupAccessDeviceGetListRequest	Requests the list of access devices in a group.
static class	GroupAccessDevice.GroupAccessDeviceGetListResponse	Response to GroupAccessDeviceGetListRequest.
static class	GroupAccessDevice.GroupAccessDeviceGetNativeTagsWithLogicListRequest	Get the list of all native tags with logic managed by the Device Management System, on a per-device profile basis.
static class	GroupAccessDevice.GroupAccessDeviceGetNativeTagsWithLogicListResponse	Response to GroupAccessDeviceGetNativeTagsWithLogicListRequest.
static class	GroupAccessDevice.GroupAccessDeviceGetPagedSortedListRequest	Requests the list of access devices in a group.
static class	GroupAccessDevice.GroupAccessDeviceGetPagedSortedListResponse	Response to GroupAccessDeviceGetPagedSortedListRequest22.
static class	GroupAccessDevice.GroupAccessDeviceGetRequest	Requests the configuration of a specified group access device.
static class	GroupAccessDevice.GroupAccessDeviceGetResponse	Response to GroupAccessDeviceGetRequest24V3.
static class	GroupAccessDevice.GroupAccessDeviceGetTrunkGroupListRequest	Request to get the list of trunk group names associated with the Access Device.
static class	GroupAccessDevice.GroupAccessDeviceGetTrunkGroupListResponse	Response to GroupAccessDeviceGetTrunkGroupListRequest24.
static class	GroupAccessDevice.GroupAccessDeviceGetUserListRequest	Requests the configuration of a specified group access device.
static class	GroupAccessDevice.GroupAccessDeviceGetUserListResponse	Response to GroupAccessDeviceGetUserListRequest21sp1.
static class	GroupAccessDevice.GroupAccessDeviceLinkDeviceListRequest	Request to link one or more leaf devices to a group level tree device.
static class	GroupAccessDevice.GroupAccessDeviceModifyRequest	Request to modify a specified group access device.
static class	GroupAccessDevice.GroupAccessDeviceModifyUserRequest	Request to modify attributes for line/ports assigned on the group device profile.
static class	GroupAccessDevice.GroupAccessDeviceResetRequest	Reset a specific group SIP device that supports the reset operation.
static class	GroupAccessDevice.GroupAccessDeviceTagSetGetRequest	Request to get the custom configuration tag set defined at the access device.
static class	GroupAccessDevice.GroupAccessDeviceTagSetGetResponse	Response to GroupAccessDeviceTagSetGetRequest.
static class	GroupAccessDevice.GroupAccessDeviceTagSetModifyRequest	Request to modify a static configuration tag set.
static class	GroupAccessDevice.GroupAccessDeviceUnlinkDeviceListRequest	Request to unlink one or more leaf access devices from a tree device.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	authBearerSubject
protected String	configurationFileName
protected AccessDeviceEnhancedConfigurationMode	configurationMode
protected String	description
protected String	deviceCode
protected String	deviceExternalId
protected Integer	deviceIndex
protected String	deviceIPEI
protected String	deviceType
protected String	groupId
protected String	macAddress
protected String	netAddress
protected Integer	numberOfAssignedPorts
protected UnboundedPositiveInt	numberOfPorts
protected String	outboundProxyServerNetAddress
protected String	physicalLocation
protected Integer	port
protected String	protocol
protected String	serialNumber
protected String	serviceProviderId
protected AccessDeviceStatus	status
protected String	stunServerNetAddress
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword
protected Boolean	useDeviceCode
protected String	userName
protected String	version

Fields inherited from class co.ecg.alpaca.toolkit.generated.AccessDevice

deviceLevel, deviceName

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

broadWorksServer, populated

Constructor Summary

Constructors

Constructor	Description
GroupAccessDevice()	Serializable Constructor
GroupAccessDevice(Group group, String deviceName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAuthBearerSubject()
String	getClassName()
String	getConfigurationFileName()
AccessDeviceEnhancedConfigurationMode	getConfigurationMode()
String	getDescription()
String	getDeviceCode()
String	getDeviceExternalId()
Integer	getDeviceIndex()
String	getDeviceIPEI()
String	getDeviceType()
Group	getGroup()	Returns a handle on the User's Group
String	getGroupId()
String	getMacAddress()
String	getNetAddress()
Integer	getNumberOfAssignedPorts()
UnboundedPositiveInt	getNumberOfPorts()
String	getOutboundProxyServerNetAddress()
String	getPhysicalLocation()
static GroupAccessDevice	getPopulatedGroupAccessDevice(Group group, String deviceName)	Retrieves a populated GroupAccessDevice
Integer	getPort()
String	getProtocol()
String	getSerialNumber()
ServiceProvider	getServiceProvider()	Returns a handle on the User's Service Provider
String	getServiceProviderId()
AccessDeviceStatus	getStatus()
String	getStunServerNetAddress()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
Boolean	getUseDeviceCode()
String	getUserName()
String	getVersion()
int	hashCode()
Response	populate()	Method to populate the Fields of the Object via the Associated BroadWorks request
Response	populate(GroupAccessDevice.GroupAccessDeviceGetResponse resp)	Method to populate the Fields of the Object via the Associated BroadWorks request
GroupAccessDevice	setAuthBearerSubject(String authBearerSubject)
GroupAccessDevice	setConfigurationFileName(String configurationFileName)
GroupAccessDevice	setConfigurationMode(AccessDeviceEnhancedConfigurationMode configurationMode)
GroupAccessDevice	setDescription(String description)
GroupAccessDevice	setDeviceCode(String deviceCode)
GroupAccessDevice	setDeviceExternalId(String deviceExternalId)
GroupAccessDevice	setDeviceIndex(Integer deviceIndex)
GroupAccessDevice	setDeviceIPEI(String deviceIPEI)
GroupAccessDevice	setDeviceType(String deviceType)
GroupAccessDevice	setGroup(Group group)
GroupAccessDevice	setGroupId(String groupId)
GroupAccessDevice	setMacAddress(String macAddress)
GroupAccessDevice	setNetAddress(String netAddress)
GroupAccessDevice	setNumberOfAssignedPorts(Integer numberOfAssignedPorts)
GroupAccessDevice	setNumberOfPorts(UnboundedPositiveInt numberOfPorts)
GroupAccessDevice	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
GroupAccessDevice	setPhysicalLocation(String physicalLocation)
GroupAccessDevice	setPort(Integer port)
GroupAccessDevice	setProtocol(String protocol)
GroupAccessDevice	setSerialNumber(String serialNumber)
GroupAccessDevice	setServiceProvider(ServiceProvider serviceProvider)
GroupAccessDevice	setServiceProviderId(String serviceProviderId)
GroupAccessDevice	setStatus(AccessDeviceStatus status)
GroupAccessDevice	setStunServerNetAddress(String stunServerNetAddress)
GroupAccessDevice	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
GroupAccessDevice	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)
GroupAccessDevice	setUseDeviceCode(Boolean useDeviceCode)
GroupAccessDevice	setUserName(String userName)
GroupAccessDevice	setVersion(String version)
String	toString()

Methods inherited from class co.ecg.alpaca.toolkit.generated.AccessDevice

formRequest, getArrayFromNode, getArrayFromNode, getDeviceLevel, getDeviceName, getFromNode, setDeviceLevel, setDeviceName

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

deviceType

protected String deviceType

protocol

protected String protocol

netAddress

protected String netAddress

port

protected Integer port

outboundProxyServerNetAddress

protected String outboundProxyServerNetAddress

stunServerNetAddress

protected String stunServerNetAddress

macAddress

protected String macAddress

serialNumber

protected String serialNumber

description

protected String description

numberOfPorts

protected UnboundedPositiveInt numberOfPorts

numberOfAssignedPorts

protected Integer numberOfAssignedPorts

status

protected AccessDeviceStatus status

configurationMode

protected AccessDeviceEnhancedConfigurationMode configurationMode

configurationFileName

protected String configurationFileName

physicalLocation

protected String physicalLocation

transportProtocol

protected ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

userName

protected String userName

version

protected String version

serviceProviderId

protected String serviceProviderId

groupId

protected String groupId

deviceExternalId

protected String deviceExternalId

deviceCode

protected String deviceCode

deviceIPEI

protected String deviceIPEI

deviceIndex

protected Integer deviceIndex

useDeviceCode

protected Boolean useDeviceCode

authBearerSubject

protected String authBearerSubject

Constructor Details

GroupAccessDevice

public GroupAccessDevice()

Serializable Constructor

GroupAccessDevice

public GroupAccessDevice(Group group,
 String deviceName)

Parameters:

group -

deviceName -

Method Details

setGroup

public GroupAccessDevice setGroup(Group group)

getGroup

public Group getGroup()

Returns a handle on the User's Group

setServiceProvider

public GroupAccessDevice setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

Returns a handle on the User's Service Provider

getPopulatedGroupAccessDevice

public static GroupAccessDevice getPopulatedGroupAccessDevice(Group group,
 String deviceName)
                                                       throws BroadWorksObjectException

Retrieves a populated GroupAccessDevice

Parameters:

group -

deviceName -

Throws:

BroadWorksObjectException

getClassName

public String getClassName()

Overrides:

getClassName in class AccessDevice

setDeviceType

public GroupAccessDevice setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setProtocol

public GroupAccessDevice setProtocol(String protocol)

getProtocol

public String getProtocol()

setNetAddress

public GroupAccessDevice setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public GroupAccessDevice setPort(Integer port)

getPort

public Integer getPort()

setOutboundProxyServerNetAddress

public GroupAccessDevice setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public String getOutboundProxyServerNetAddress()

setStunServerNetAddress

public GroupAccessDevice setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public String getStunServerNetAddress()

setMacAddress

public GroupAccessDevice setMacAddress(String macAddress)

getMacAddress

public String getMacAddress()

setSerialNumber

public GroupAccessDevice setSerialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

setDescription

public GroupAccessDevice setDescription(String description)

getDescription

public String getDescription()

setNumberOfPorts

public GroupAccessDevice setNumberOfPorts(UnboundedPositiveInt numberOfPorts)

getNumberOfPorts

public UnboundedPositiveInt getNumberOfPorts()

setNumberOfAssignedPorts

public GroupAccessDevice setNumberOfAssignedPorts(Integer numberOfAssignedPorts)

getNumberOfAssignedPorts

public Integer getNumberOfAssignedPorts()

setStatus

public GroupAccessDevice setStatus(AccessDeviceStatus status)

getStatus

public AccessDeviceStatus getStatus()

setConfigurationMode

public GroupAccessDevice setConfigurationMode(AccessDeviceEnhancedConfigurationMode configurationMode)

getConfigurationMode

public AccessDeviceEnhancedConfigurationMode getConfigurationMode()

setConfigurationFileName

public GroupAccessDevice setConfigurationFileName(String configurationFileName)

getConfigurationFileName

public String getConfigurationFileName()

setPhysicalLocation

public GroupAccessDevice setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public String getPhysicalLocation()

setTransportProtocol

public GroupAccessDevice setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public GroupAccessDevice setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

setUserName

public GroupAccessDevice setUserName(String userName)

getUserName

public String getUserName()

setVersion

public GroupAccessDevice setVersion(String version)

getVersion

public String getVersion()

setServiceProviderId

public GroupAccessDevice setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public GroupAccessDevice setGroupId(String groupId)

getGroupId

public String getGroupId()

setDeviceExternalId

public GroupAccessDevice setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setDeviceCode

public GroupAccessDevice setDeviceCode(String deviceCode)

getDeviceCode

public String getDeviceCode()

setDeviceIPEI

public GroupAccessDevice setDeviceIPEI(String deviceIPEI)

getDeviceIPEI

public String getDeviceIPEI()

setDeviceIndex

public GroupAccessDevice setDeviceIndex(Integer deviceIndex)

getDeviceIndex

public Integer getDeviceIndex()

setUseDeviceCode

public GroupAccessDevice setUseDeviceCode(Boolean useDeviceCode)

getUseDeviceCode

public Boolean getUseDeviceCode()

setAuthBearerSubject

public GroupAccessDevice setAuthBearerSubject(String authBearerSubject)

getAuthBearerSubject

public String getAuthBearerSubject()

populate

public Response populate()

Method to populate the Fields of the Object via the Associated BroadWorks request

Overrides:

populate in class AccessDevice

populate

public Response populate(GroupAccessDevice.GroupAccessDeviceGetResponse resp)

Method to populate the Fields of the Object via the Associated BroadWorks request

Parameters:

resp - The response object to perform population

equals

public boolean equals(Object obj)

Overrides:

equals in class AccessDevice

hashCode

public int hashCode()

Overrides:

hashCode in class AccessDevice

toString

public String toString()

Overrides:

toString in class AccessDevice