Package co.ecg.alpaca.toolkit.generated

Class User.UserGetServiceInstanceListInServiceProviderRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserGetServiceInstanceListInServiceProviderRequest

Enclosing class:

User

public static class User.UserGetServiceInstanceListInServiceProviderRequest
extends Request<User.UserGetServiceInstanceListInServiceProviderResponse>

Request the list of Service Instances in a service provider or an enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider. The response is either a UserGetServiceInstanceListInServiceProviderResponse or an ErrorResponse.

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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactServiceType	searchCriteriaExactServiceType
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
UserGetServiceInstanceListInServiceProviderRequest()
UserGetServiceInstanceListInServiceProviderRequest(ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static User.UserGetServiceInstanceListInServiceProviderRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactServiceType	getSearchCriteriaExactServiceType()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
ServiceProvider	getServiceProvider()
User.UserGetServiceInstanceListInServiceProviderRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaExactServiceType(SearchCriteriaExactServiceType searchCriteriaExactServiceType)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGetServiceInstanceListInServiceProviderRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
User.UserGetServiceInstanceListInServiceProviderRequest	setServiceProvider(ServiceProvider serviceProvider)

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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

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

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

Constructor Details

UserGetServiceInstanceListInServiceProviderRequest

public UserGetServiceInstanceListInServiceProviderRequest()

UserGetServiceInstanceListInServiceProviderRequest

public UserGetServiceInstanceListInServiceProviderRequest(ServiceProvider serviceProvider)

Method Details

setServiceProvider

public User.UserGetServiceInstanceListInServiceProviderRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setResponseSizeLimit

public User.UserGetServiceInstanceListInServiceProviderRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaGroupId

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

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaExactServiceType

public User.UserGetServiceInstanceListInServiceProviderRequest setSearchCriteriaExactServiceType(SearchCriteriaExactServiceType searchCriteriaExactServiceType)

getSearchCriteriaExactServiceType

public SearchCriteriaExactServiceType getSearchCriteriaExactServiceType()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaExactUserDepartment

public User.UserGetServiceInstanceListInServiceProviderRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

getEmptyObject

public static User.UserGetServiceInstanceListInServiceProviderRequest 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<User.UserGetServiceInstanceListInServiceProviderResponse>