Package co.ecg.alpaca.toolkit.generated

Class GroupPaging.GroupGroupPagingAddInstanceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.GroupPaging.GroupGroupPagingAddInstanceRequest

Enclosing class:

GroupPaging

public static class GroupPaging.GroupGroupPagingAddInstanceRequest
extends Request<DefaultResponse>

Add a Group Paging instance to a group. The domain is required in the serviceUserId. The response is either SuccessResponse or ErrorResponse. The following element is only used in AS data mode and ignored in XS data mode: networkClassOfService

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 @NotNull Integer	confirmationToneTimeoutSeconds
protected @NotNull Boolean	deliverOriginatorCLIDInstead
protected @NotNull @Size(min=1,max=30) String	groupId
protected @Size(min=1,max=40) String	networkClassOfService
protected @Size(min=1,max=30) String	originatorCLIDPrefix
protected @NotNull @Valid ServiceInstanceAddProfile	serviceInstanceProfile
protected @NotNull @Size(min=1,max=30) String	serviceProviderId
protected @NotNull @Size(min=1,max=161) String	serviceUserId

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

log

Constructor Summary

Constructors

Constructor	Description
GroupGroupPagingAddInstanceRequest()
GroupGroupPagingAddInstanceRequest(BroadWorksServer broadWorksServer, String serviceProviderId, String groupId, String serviceUserId, ServiceInstanceAddProfile serviceInstanceProfile, Integer confirmationToneTimeoutSeconds, Boolean deliverOriginatorCLIDInstead)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getConfirmationToneTimeoutSeconds()
Boolean	getDeliverOriginatorCLIDInstead()
static GroupPaging.GroupGroupPagingAddInstanceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getGroupId()
String	getNetworkClassOfService()
String	getOriginatorCLIDPrefix()
ServiceInstanceAddProfile	getServiceInstanceProfile()
String	getServiceProviderId()
String	getServiceUserId()
GroupPaging.GroupGroupPagingAddInstanceRequest	setConfirmationToneTimeoutSeconds(Integer confirmationToneTimeoutSeconds)
GroupPaging.GroupGroupPagingAddInstanceRequest	setDeliverOriginatorCLIDInstead(Boolean deliverOriginatorCLIDInstead)
GroupPaging.GroupGroupPagingAddInstanceRequest	setGroupId(String groupId)
GroupPaging.GroupGroupPagingAddInstanceRequest	setNetworkClassOfService(String networkClassOfService)
GroupPaging.GroupGroupPagingAddInstanceRequest	setOriginatorCLIDPrefix(String originatorCLIDPrefix)
GroupPaging.GroupGroupPagingAddInstanceRequest	setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)
GroupPaging.GroupGroupPagingAddInstanceRequest	setServiceProviderId(String serviceProviderId)
GroupPaging.GroupGroupPagingAddInstanceRequest	setServiceUserId(String serviceUserId)

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, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

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

Field Details

serviceProviderId

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

groupId

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

serviceUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String serviceUserId

serviceInstanceProfile

@NotNull
@Valid
protected @NotNull @Valid ServiceInstanceAddProfile serviceInstanceProfile

confirmationToneTimeoutSeconds

@NotNull
protected @NotNull Integer confirmationToneTimeoutSeconds

deliverOriginatorCLIDInstead

@NotNull
protected @NotNull Boolean deliverOriginatorCLIDInstead

originatorCLIDPrefix

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

networkClassOfService

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

Constructor Details

GroupGroupPagingAddInstanceRequest

public GroupGroupPagingAddInstanceRequest()

GroupGroupPagingAddInstanceRequest

public GroupGroupPagingAddInstanceRequest(BroadWorksServer broadWorksServer,
 String serviceProviderId,
 String groupId,
 String serviceUserId,
 ServiceInstanceAddProfile serviceInstanceProfile,
 Integer confirmationToneTimeoutSeconds,
 Boolean deliverOriginatorCLIDInstead)

Method Details

setServiceProviderId

public GroupPaging.GroupGroupPagingAddInstanceRequest setServiceProviderId(String serviceProviderId)

getServiceProviderId

public String getServiceProviderId()

setGroupId

public GroupPaging.GroupGroupPagingAddInstanceRequest setGroupId(String groupId)

getGroupId

public String getGroupId()

setServiceUserId

public GroupPaging.GroupGroupPagingAddInstanceRequest setServiceUserId(String serviceUserId)

getServiceUserId

public String getServiceUserId()

setServiceInstanceProfile

public GroupPaging.GroupGroupPagingAddInstanceRequest setServiceInstanceProfile(ServiceInstanceAddProfile serviceInstanceProfile)

getServiceInstanceProfile

public ServiceInstanceAddProfile getServiceInstanceProfile()

setConfirmationToneTimeoutSeconds

public GroupPaging.GroupGroupPagingAddInstanceRequest setConfirmationToneTimeoutSeconds(Integer confirmationToneTimeoutSeconds)

getConfirmationToneTimeoutSeconds

public Integer getConfirmationToneTimeoutSeconds()

setDeliverOriginatorCLIDInstead

public GroupPaging.GroupGroupPagingAddInstanceRequest setDeliverOriginatorCLIDInstead(Boolean deliverOriginatorCLIDInstead)

getDeliverOriginatorCLIDInstead

public Boolean getDeliverOriginatorCLIDInstead()

setOriginatorCLIDPrefix

public GroupPaging.GroupGroupPagingAddInstanceRequest setOriginatorCLIDPrefix(String originatorCLIDPrefix)

getOriginatorCLIDPrefix

public String getOriginatorCLIDPrefix()

setNetworkClassOfService

public GroupPaging.GroupGroupPagingAddInstanceRequest setNetworkClassOfService(String networkClassOfService)

getNetworkClassOfService

public String getNetworkClassOfService()

getEmptyObject

public static GroupPaging.GroupGroupPagingAddInstanceRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<DefaultResponse>