Package co.ecg.alpaca.toolkit.generated

Class User.UserGetServiceInstanceListInSystemRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserGetServiceInstanceListInSystemResponse>

co.ecg.alpaca.toolkit.generated.User.UserGetServiceInstanceListInSystemRequest

Enclosing class:

User

public static class User.UserGetServiceInstanceListInSystemRequest
extends Request<User.UserGetServiceInstanceListInSystemResponse>

Request the list of Service Instances in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the service instances in the administrator's reseller meeting the search criteria are returned. The response is either a UserGetServiceInstanceListInSystemResponse or an ErrorResponse. The following data elements are only used in AS data mode: searchCriteriaResellerId

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 java.lang.Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactServiceProvider	searchCriteriaExactServiceProvider
protected @Valid SearchCriteriaExactServiceType	searchCriteriaExactServiceType
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor	Description
UserGetServiceInstanceListInSystemRequest()
UserGetServiceInstanceListInSystemRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
java.lang.Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactServiceProvider	getSearchCriteriaExactServiceProvider()
SearchCriteriaExactServiceType	getSearchCriteriaExactServiceType()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
User.UserGetServiceInstanceListInSystemRequest	setResponseSizeLimit(java.lang.Integer responseSizeLimit)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaExactServiceType(SearchCriteriaExactServiceType searchCriteriaExactServiceType)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGetServiceInstanceListInSystemRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

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

Methods inherited from class java.lang.Object

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

Field Details

responseSizeLimit

protected java.lang.Integer responseSizeLimit

searchCriteriaExactServiceType

@Valid protected @Valid SearchCriteriaExactServiceType searchCriteriaExactServiceType

searchCriteriaUserId

@Valid protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaUserLastName

@Valid protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaDn

@Valid protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaGroupId

@Valid protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaExactServiceProvider

@Valid protected @Valid SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider

searchCriteriaServiceProviderId

@Valid protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaResellerId

@Valid protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

Constructor Details

UserGetServiceInstanceListInSystemRequest

public UserGetServiceInstanceListInSystemRequest()

UserGetServiceInstanceListInSystemRequest

public UserGetServiceInstanceListInSystemRequest(BroadWorksServer broadWorksServer)

Method Details

setResponseSizeLimit

public User.UserGetServiceInstanceListInSystemRequest setResponseSizeLimit(java.lang.Integer responseSizeLimit)

getResponseSizeLimit

public java.lang.Integer getResponseSizeLimit()

setSearchCriteriaExactServiceType

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaExactServiceType(SearchCriteriaExactServiceType searchCriteriaExactServiceType)

getSearchCriteriaExactServiceType

public SearchCriteriaExactServiceType getSearchCriteriaExactServiceType()

setSearchCriteriaUserId

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserLastName

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaDn

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaGroupId

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaExactServiceProvider

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)

getSearchCriteriaExactServiceProvider

public SearchCriteriaExactServiceProvider getSearchCriteriaExactServiceProvider()

setSearchCriteriaServiceProviderId

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaResellerId

public User.UserGetServiceInstanceListInSystemRequest setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)

getSearchCriteriaResellerId

public SearchCriteriaResellerId[] getSearchCriteriaResellerId()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<User.UserGetServiceInstanceListInSystemResponse>