cisco.uc.cuae.legacy
Class CiscoDeviceList.QueryOptions

java.lang.Object
  cisco.uc.cuae.legacy.CiscoDeviceList.QueryOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CiscoDeviceList

public static class CiscoDeviceList.QueryOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	callManagerIP The CallManagerIP action parameter can be used to restrict the query to devices matching the specified Cisco Unified Communications Manager publisher IP address.
java.lang.String	description The Description action parameter can be used to restrict the query to devices matching the specified description.
java.lang.String	iP The IP action parameter can be used to restrict the query to devices matching the specified IP address.
java.lang.String	name The Name action parameter can be used to restrict the query to devices matching the specified name.
java.lang.String	pool The Pool action parameter can be used to restrict the query to devices with a configured Device Pool matching the specified value.
java.lang.String	searchSpace The SearchSpace action parameter can be used to restrict the query to devices with a configured CallingSearchSpace matching the specified value.
CiscoDeviceList.Status	status The Status action parameter can used to restrict the query to devices matching the specified status value.
CiscoDeviceList.Type	type The Type action parameter can be used to restrict the query to only devices of a particular type.

Constructor Summary

CiscoDeviceList.QueryOptions()
Constructs the QueryOptions.

CiscoDeviceList.QueryOptions(CiscoDeviceList.Type type, java.lang.String name, java.lang.String description, java.lang.String searchSpace, java.lang.String pool, java.lang.String iP, CiscoDeviceList.Status status, java.lang.String callManagerIP)
Constructs the QueryOptions.

Method Summary

java.lang.String	getCallManagerIP() Gets the value.
java.lang.String	getDescription() Gets the value.
java.lang.String	getIP() Gets the value.
java.lang.String	getName() Gets the value.
java.lang.String	getPool() Gets the value.
java.lang.String	getSearchSpace() Gets the value.
CiscoDeviceList.Status	getStatus() Gets the value.
CiscoDeviceList.Type	getType() Gets the value.
void	setCallManagerIP(java.lang.String value) Sets the value.
void	setDescription(java.lang.String value) Sets the value.
void	setIP(java.lang.String value) Sets the value.
void	setName(java.lang.String value) Sets the value.
void	setPool(java.lang.String value) Sets the value.
void	setSearchSpace(java.lang.String value) Sets the value.
void	setStatus(CiscoDeviceList.Status value) Sets the value.
void	setType(CiscoDeviceList.Type value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

type

public CiscoDeviceList.Type type

The Type action parameter can be used to restrict the query to only devices of a particular type. Valid values are as follows: Cisco7905 Cisco7912 Cisco7920 Cisco7940 Cisco7941 Cisco7941G Cisco7960 Cisco7961G Cisco7970 Cisco7971 IPCommunicator

name

public java.lang.String name

The Name action parameter can be used to restrict the query to devices matching the specified name.

description

public java.lang.String description

The Description action parameter can be used to restrict the query to devices matching the specified description.

searchSpace

public java.lang.String searchSpace

The SearchSpace action parameter can be used to restrict the query to devices with a configured CallingSearchSpace matching the specified value.

pool

public java.lang.String pool

The Pool action parameter can be used to restrict the query to devices with a configured Device Pool matching the specified value.

iP

public java.lang.String iP

The IP action parameter can be used to restrict the query to devices matching the specified IP address.

status

public CiscoDeviceList.Status status

The Status action parameter can used to restrict the query to devices matching the specified status value. Note that in Cisco Unified Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered devices are returned so this field has less value for those versions since NotFound is not supported. NotFound - The device is configured in the Cisco Unified Communications Manager database, but is not registered or connected in any way. Registered - The device is registered to the Cisco Unified Communications Manager. Only for this status should one expect a valid value for the IP address of the device. FoundAndUnregistered - The device is or recently was connected to the Cisco Unified Communications Manager, but is not registered.

callManagerIP

public java.lang.String callManagerIP

The CallManagerIP action parameter can be used to restrict the query to devices matching the specified Cisco Unified Communications Manager publisher IP address.

Constructor Detail

CiscoDeviceList.QueryOptions

public CiscoDeviceList.QueryOptions()

Constructs the QueryOptions. Don't init any fields.

CiscoDeviceList.QueryOptions

public CiscoDeviceList.QueryOptions(CiscoDeviceList.Type type,
                                    java.lang.String name,
                                    java.lang.String description,
                                    java.lang.String searchSpace,
                                    java.lang.String pool,
                                    java.lang.String iP,
                                    CiscoDeviceList.Status status,
                                    java.lang.String callManagerIP)

Constructs the QueryOptions.

Parameters:

type - The Type action parameter can be used to restrict the query to only devices type of a particular type. Valid values are as follows: type type Cisco7905 type Cisco7912 type Cisco7920 type Cisco7940 type Cisco7941 type Cisco7941G type Cisco7960 type Cisco7961G type Cisco7970 type Cisco7971 type IPCommunicator type

name - The Name action parameter can be used to restrict the query to devices name matching the specified name. name

description - The Description action parameter can be used to restrict the query to description devices matching the specified description. description

searchSpace - The SearchSpace action parameter can be used to restrict the query to searchSpace devices with a configured CallingSearchSpace matching the specified value. searchSpace

pool - The Pool action parameter can be used to restrict the query to devices with pool a configured Device Pool matching the specified value. pool

iP - The IP action parameter can be used to restrict the query to devices iP matching the specified IP address. iP

status - The Status action parameter can used to restrict the query to devices status matching the specified status value. Note that in Cisco Unified status Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered status devices are returned so this field has less value for those versions since status NotFound is not supported. status status NotFound - The device is configured in the Cisco Unified Communications status Manager database, but is not registered or connected in any status way. status Registered - The device is registered to the Cisco Unified Communications status Manager. Only for this status should one expect a valid status value for the IP address of the device. status FoundAndUnregistered - The device is or recently was connected to the status Cisco Unified Communications Manager, but is not status registered. status

callManagerIP - The CallManagerIP action parameter can be used to restrict the query to callManagerIP devices matching the specified Cisco Unified Communications Manager callManagerIP publisher IP address. callManagerIP

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getType

public CiscoDeviceList.Type getType()

Gets the value. The Type action parameter can be used to restrict the query to only devices of a particular type. Valid values are as follows: Cisco7905 Cisco7912 Cisco7920 Cisco7940 Cisco7941 Cisco7941G Cisco7960 Cisco7961G Cisco7970 Cisco7971 IPCommunicator

Returns:

the value.

setType

public void setType(CiscoDeviceList.Type value)

Sets the value. The Type action parameter can be used to restrict the query to only devices of a particular type. Valid values are as follows: Cisco7905 Cisco7912 Cisco7920 Cisco7940 Cisco7941 Cisco7941G Cisco7960 Cisco7961G Cisco7970 Cisco7971 IPCommunicator

Parameters:

value - the value.

getName

public java.lang.String getName()

Gets the value. The Name action parameter can be used to restrict the query to devices matching the specified name.

Returns:

the value.

setName

public void setName(java.lang.String value)

Sets the value. The Name action parameter can be used to restrict the query to devices matching the specified name.

Parameters:

value - the value.

getDescription

public java.lang.String getDescription()

Gets the value. The Description action parameter can be used to restrict the query to devices matching the specified description.

Returns:

the value.

setDescription

public void setDescription(java.lang.String value)

Sets the value. The Description action parameter can be used to restrict the query to devices matching the specified description.

Parameters:

value - the value.

getSearchSpace

public java.lang.String getSearchSpace()

Gets the value. The SearchSpace action parameter can be used to restrict the query to devices with a configured CallingSearchSpace matching the specified value.

Returns:

the value.

setSearchSpace

public void setSearchSpace(java.lang.String value)

Sets the value. The SearchSpace action parameter can be used to restrict the query to devices with a configured CallingSearchSpace matching the specified value.

Parameters:

value - the value.

getPool

public java.lang.String getPool()

Gets the value. The Pool action parameter can be used to restrict the query to devices with a configured Device Pool matching the specified value.

Returns:

the value.

setPool

public void setPool(java.lang.String value)

Sets the value. The Pool action parameter can be used to restrict the query to devices with a configured Device Pool matching the specified value.

Parameters:

value - the value.

getIP

public java.lang.String getIP()

Gets the value. The IP action parameter can be used to restrict the query to devices matching the specified IP address.

Returns:

the value.

setIP

public void setIP(java.lang.String value)

Sets the value. The IP action parameter can be used to restrict the query to devices matching the specified IP address.

Parameters:

value - the value.

getStatus

public CiscoDeviceList.Status getStatus()

Gets the value. The Status action parameter can used to restrict the query to devices matching the specified status value. Note that in Cisco Unified Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered devices are returned so this field has less value for those versions since NotFound is not supported. NotFound - The device is configured in the Cisco Unified Communications Manager database, but is not registered or connected in any way. Registered - The device is registered to the Cisco Unified Communications Manager. Only for this status should one expect a valid value for the IP address of the device. FoundAndUnregistered - The device is or recently was connected to the Cisco Unified Communications Manager, but is not registered.

Returns:

the value.

setStatus

public void setStatus(CiscoDeviceList.Status value)

Sets the value. The Status action parameter can used to restrict the query to devices matching the specified status value. Note that in Cisco Unified Communications Manager 5.x/6.x, only Registered and FoundAndUnregistered devices are returned so this field has less value for those versions since NotFound is not supported. NotFound - The device is configured in the Cisco Unified Communications Manager database, but is not registered or connected in any way. Registered - The device is registered to the Cisco Unified Communications Manager. Only for this status should one expect a valid value for the IP address of the device. FoundAndUnregistered - The device is or recently was connected to the Cisco Unified Communications Manager, but is not registered.

Parameters:

value - the value.

getCallManagerIP

public java.lang.String getCallManagerIP()

Gets the value. The CallManagerIP action parameter can be used to restrict the query to devices matching the specified Cisco Unified Communications Manager publisher IP address.

Returns:

the value.

setCallManagerIP

public void setCallManagerIP(java.lang.String value)

Sets the value. The CallManagerIP action parameter can be used to restrict the query to devices matching the specified Cisco Unified Communications Manager publisher IP address.

Parameters:

value - the value.