co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemGetRegistrationContactListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemGetRegistrationContactListResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemGetRegistrationContactListRequest

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

@GwtIncompatible
public static class BWSystem.SystemGetRegistrationContactListRequest
extends Request<BWSystem.SystemGetRegistrationContactListResponse>

AlpacaLibrary Auto-Generated Java File Get the list of registration contacts. This request handles all levels of administration privileges. The content of the response will only contain items within the scope of the requester's login id. At the system level any of the choice parameters may be specified to filter the registrations listed. At the service provider level the serviceProviderId must be specified for the service provider and group options. When using the userId or linePort options the specified value must be valid for that service provider login. At the group level the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort options the specified value must be valid for that group login. The serviceProviderId option is not valid at the group level. At the user level when using the userId or linePort options the specified value must be valid for that user login. The serviceProviderId and groupId options are not valid at the user level. The response is either SystemGetRegistrationContactListResponse or ErrorResponse.

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessDeviceLevel	deviceLevel
protected String	deviceName
protected String	deviceType
protected RegistrationEndpointType	endpointType
protected Boolean	expired
protected Group	group
protected String	linePort
protected SearchCriteriaRegistrationURI[]	searchCriteriaRegistrationURI
protected SearchCriteriaSIPContact[]	searchCriteriaSIPContact
protected ServiceProvider	serviceProvider
protected String	svcProviderId
protected User	user

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor and Description
SystemGetRegistrationContactListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AccessDeviceLevel	getDeviceLevel()
String	getDeviceName()
String	getDeviceType()
RegistrationEndpointType	getEndpointType()
Boolean	getExpired()
Group	getGroup()
String	getLinePort()
SearchCriteriaRegistrationURI[]	getSearchCriteriaRegistrationURI()
SearchCriteriaSIPContact[]	getSearchCriteriaSIPContact()
ServiceProvider	getServiceProvider()
String	getSvcProviderId()
User	getUser()
BWSystem.SystemGetRegistrationContactListRequest	setDeviceLevel(AccessDeviceLevel deviceLevel)
BWSystem.SystemGetRegistrationContactListRequest	setDeviceName(String deviceName)
BWSystem.SystemGetRegistrationContactListRequest	setDeviceType(String deviceType)
BWSystem.SystemGetRegistrationContactListRequest	setEndpointType(RegistrationEndpointType endpointType)
BWSystem.SystemGetRegistrationContactListRequest	setExpired(Boolean expired)
BWSystem.SystemGetRegistrationContactListRequest	setGroup(Group group)
BWSystem.SystemGetRegistrationContactListRequest	setLinePort(String linePort)
BWSystem.SystemGetRegistrationContactListRequest	setSearchCriteriaRegistrationURI(SearchCriteriaRegistrationURI... searchCriteriaRegistrationURI)
BWSystem.SystemGetRegistrationContactListRequest	setSearchCriteriaSIPContact(SearchCriteriaSIPContact... searchCriteriaSIPContact)
BWSystem.SystemGetRegistrationContactListRequest	setServiceProvider(ServiceProvider serviceProvider)
BWSystem.SystemGetRegistrationContactListRequest	setSvcProviderId(String svcProviderId)
BWSystem.SystemGetRegistrationContactListRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serviceProvider

protected transient ServiceProvider serviceProvider

svcProviderId

@Size(min=1,
      max=30)
protected String svcProviderId

group

protected transient Group group

user

protected transient User user

linePort

@Pattern(regexp="[a-zA-Z0-9._!~*\'()+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}")
 @Size(min=1,
      max=161)
protected String linePort

deviceLevel

protected AccessDeviceLevel deviceLevel

deviceName

@Size(min=1,
      max=40)
protected String deviceName

deviceType

@Size(min=1,
      max=40)
protected String deviceType

searchCriteriaRegistrationURI

protected SearchCriteriaRegistrationURI[] searchCriteriaRegistrationURI

searchCriteriaSIPContact

protected SearchCriteriaSIPContact[] searchCriteriaSIPContact

endpointType

protected RegistrationEndpointType endpointType

expired

protected Boolean expired

Constructor Detail

SystemGetRegistrationContactListRequest

public SystemGetRegistrationContactListRequest(BroadWorksServer broadWorksServer)

Method Detail

setServiceProvider

public BWSystem.SystemGetRegistrationContactListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setSvcProviderId

public BWSystem.SystemGetRegistrationContactListRequest setSvcProviderId(String svcProviderId)

getSvcProviderId

public String getSvcProviderId()

setGroup

public BWSystem.SystemGetRegistrationContactListRequest setGroup(Group group)

getGroup

public Group getGroup()

setUser

public BWSystem.SystemGetRegistrationContactListRequest setUser(User user)

getUser

public User getUser()

setLinePort

public BWSystem.SystemGetRegistrationContactListRequest setLinePort(String linePort)

getLinePort

public String getLinePort()

setDeviceLevel

public BWSystem.SystemGetRegistrationContactListRequest setDeviceLevel(AccessDeviceLevel deviceLevel)

getDeviceLevel

public AccessDeviceLevel getDeviceLevel()

setDeviceName

public BWSystem.SystemGetRegistrationContactListRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setDeviceType

public BWSystem.SystemGetRegistrationContactListRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setSearchCriteriaRegistrationURI

public BWSystem.SystemGetRegistrationContactListRequest setSearchCriteriaRegistrationURI(SearchCriteriaRegistrationURI... searchCriteriaRegistrationURI)

getSearchCriteriaRegistrationURI

public SearchCriteriaRegistrationURI[] getSearchCriteriaRegistrationURI()

setSearchCriteriaSIPContact

public BWSystem.SystemGetRegistrationContactListRequest setSearchCriteriaSIPContact(SearchCriteriaSIPContact... searchCriteriaSIPContact)

getSearchCriteriaSIPContact

public SearchCriteriaSIPContact[] getSearchCriteriaSIPContact()

setEndpointType

public BWSystem.SystemGetRegistrationContactListRequest setEndpointType(RegistrationEndpointType endpointType)

getEndpointType

public RegistrationEndpointType getEndpointType()

setExpired

public BWSystem.SystemGetRegistrationContactListRequest setExpired(Boolean expired)

getExpired

public Boolean getExpired()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<BWSystem.SystemGetRegistrationContactListResponse>