Package 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
- Enclosing class:
- BWSystem
@Choice(minOccurs=0,value={@ChoiceGroup("resellerId"),@ChoiceGroup("serviceProvider"),@ChoiceGroup("user"),@ChoiceGroup("linePort"),@ChoiceGroup({"svcProviderId","group"})}) public static class BWSystem.SystemGetRegistrationContactListRequest extends Request<BWSystem.SystemGetRegistrationContactListResponse>
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 reseller level, the resellerId must be specified. ResellerId is not valid at service provider, group or user level. 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 SystemGetRegistrationContactListResponse21sp1 or ErrorResponse. The RegistrationEndpointType21sp1 is sent in response The Endpoint Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The value Mobility in Endpoint Type column is only applicable in AS data mode. The following elements are only used in AS data mode: resellerId
- Author:
- AlpacaGenerator
-
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 Description protected AccessDeviceLevel
deviceLevel
protected @Size(min=1,max=40) java.lang.String
deviceName
protected @Size(min=1,max=40) java.lang.String
deviceType
protected RegistrationEndpointType21sp1
endpointType
protected java.lang.Boolean
expired
protected @Valid Group
group
protected @Size(min=1,max=161) java.lang.String
linePort
protected @Size(min=1,max=30) java.lang.String
resellerId
protected @Valid SearchCriteriaRegistrationURI[]
searchCriteriaRegistrationURI
protected @Valid SearchCriteriaSIPContact[]
searchCriteriaSIPContact
protected @Valid ServiceProvider
serviceProvider
protected @Size(min=1,max=30) java.lang.String
svcProviderId
protected @Valid BroadWorksUser
user
-
Constructor Summary
Constructors Constructor Description SystemGetRegistrationContactListRequest()
SystemGetRegistrationContactListRequest(BroadWorksServer broadWorksServer)
-
Method Summary
Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate
-
Field Details
-
resellerId
@Size(min=1, max=30) protected @Size(min=1,max=30) java.lang.String resellerId -
serviceProvider
-
svcProviderId
@Size(min=1, max=30) protected @Size(min=1,max=30) java.lang.String svcProviderId -
group
-
user
-
linePort
-
deviceLevel
-
deviceName
@Size(min=1, max=40) protected @Size(min=1,max=40) java.lang.String deviceName -
deviceType
@Size(min=1, max=40) protected @Size(min=1,max=40) java.lang.String deviceType -
searchCriteriaRegistrationURI
-
searchCriteriaSIPContact
-
endpointType
-
expired
protected java.lang.Boolean expired
-
-
Constructor Details
-
SystemGetRegistrationContactListRequest
public SystemGetRegistrationContactListRequest() -
SystemGetRegistrationContactListRequest
-
-
Method Details
-
setResellerId
-
getResellerId
public java.lang.String getResellerId() -
setServiceProvider
public BWSystem.SystemGetRegistrationContactListRequest setServiceProvider(ServiceProvider serviceProvider) -
getServiceProvider
-
setSvcProviderId
public BWSystem.SystemGetRegistrationContactListRequest setSvcProviderId(java.lang.String svcProviderId) -
getSvcProviderId
public java.lang.String getSvcProviderId() -
setGroup
-
getGroup
-
setUser
-
getBroadWorksUser
-
setLinePort
-
getLinePort
public java.lang.String getLinePort() -
setDeviceLevel
public BWSystem.SystemGetRegistrationContactListRequest setDeviceLevel(AccessDeviceLevel deviceLevel) -
getDeviceLevel
-
setDeviceName
-
getDeviceName
public java.lang.String getDeviceName() -
setDeviceType
-
getDeviceType
public java.lang.String getDeviceType() -
setSearchCriteriaRegistrationURI
public BWSystem.SystemGetRegistrationContactListRequest setSearchCriteriaRegistrationURI(SearchCriteriaRegistrationURI... searchCriteriaRegistrationURI) -
getSearchCriteriaRegistrationURI
-
setSearchCriteriaSIPContact
public BWSystem.SystemGetRegistrationContactListRequest setSearchCriteriaSIPContact(SearchCriteriaSIPContact... searchCriteriaSIPContact) -
getSearchCriteriaSIPContact
-
setEndpointType
public BWSystem.SystemGetRegistrationContactListRequest setEndpointType(RegistrationEndpointType21sp1 endpointType) -
getEndpointType
-
setExpired
-
getExpired
public java.lang.Boolean getExpired() -
formRequest
public void formRequest()Forms the XML Document for this Request Object. Called by the Request upon fire().- Overrides:
formRequest
in classRequest<BWSystem.SystemGetRegistrationContactListResponse>
-