BESHAPool (BlackBerry Web Services for Enterprise Administration 12.0.0 API Reference)

Object
- BESHAPool

public class BESHAPool
extends Object

Contains data about a high availability pool, including failover information, SRP data, and encryption data.

Java class for BESHAPool complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="BESHAPool">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="uid" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="localeNameAndDescription" type="{http://ws.rim.com/enterprise/admin}LocaleNameAndDescription" maxOccurs="unbounded" minOccurs="0"/>
         <element name="userCount" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="srpId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="srpStatus" type="{http://ws.rim.com/enterprise/admin}SRPStatus" minOccurs="0"/>
         <element name="srpKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="srpAddressInformation" type="{http://ws.rim.com/enterprise/admin}SRPAddressInformation" minOccurs="0"/>
         <element name="hostRoutingInfo" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="encryptionAlgorithm" type="{http://ws.rim.com/enterprise/admin}EncryptionAlgorithm" minOccurs="0"/>
         <element name="externalServicesEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="automaticFailoverEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="automaticConnectionFailoverEnabled" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="automaticFailoverlastUpdated" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="besServices" type="{http://ws.rim.com/enterprise/admin}BESService" maxOccurs="unbounded" minOccurs="0"/>
         <element name="automaticFailoverInformation" type="{http://ws.rim.com/enterprise/admin}AutomaticFailoverInformation" minOccurs="0"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Object>`	`any`
`protected Boolean`	`automaticConnectionFailoverEnabled`
`protected Boolean`	`automaticFailoverEnabled`
`protected AutomaticFailoverInformation`	`automaticFailoverInformation`
`protected String`	`automaticFailoverlastUpdated`
`protected List<BESService>`	`besServices`
`protected EncryptionAlgorithm`	`encryptionAlgorithm`
`protected boolean`	`externalServicesEnabled`
`protected String`	`hostRoutingInfo`
`protected List<LocaleNameAndDescription>`	`localeNameAndDescription`
`protected String`	`name`
`protected SRPAddressInformation`	`srpAddressInformation`
`protected String`	`srpId`
`protected String`	`srpKey`
`protected SRPStatus`	`srpStatus`
`protected String`	`uid`
`protected int`	`userCount`

Constructor Summary

Constructors
Constructor and Description

BESHAPool()

Constructors
Constructor and Description
`BESHAPool()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Object>`	`getAny()` Gets the value of the any property.
`AutomaticFailoverInformation`	`getAutomaticFailoverInformation()` Gets the value of the automaticFailoverInformation property.
`String`	`getAutomaticFailoverlastUpdated()` Gets the value of the automaticFailoverlastUpdated property.
`List<BESService>`	`getBesServices()` Gets the value of the besServices property.
`EncryptionAlgorithm`	`getEncryptionAlgorithm()` Gets the value of the encryptionAlgorithm property.
`String`	`getHostRoutingInfo()` Gets the value of the hostRoutingInfo property.
`List<LocaleNameAndDescription>`	`getLocaleNameAndDescription()` Gets the value of the localeNameAndDescription property.
`String`	`getName()` Gets the value of the name property.
`SRPAddressInformation`	`getSrpAddressInformation()` Gets the value of the srpAddressInformation property.
`String`	`getSrpId()` Gets the value of the srpId property.
`String`	`getSrpKey()` Gets the value of the srpKey property.
`SRPStatus`	`getSrpStatus()` Gets the value of the srpStatus property.
`String`	`getUid()` Gets the value of the uid property.
`int`	`getUserCount()` Gets the value of the userCount property.
`Boolean`	`isAutomaticConnectionFailoverEnabled()` Gets the value of the automaticConnectionFailoverEnabled property.
`Boolean`	`isAutomaticFailoverEnabled()` Gets the value of the automaticFailoverEnabled property.
`boolean`	`isExternalServicesEnabled()` Gets the value of the externalServicesEnabled property.
`void`	`setAutomaticConnectionFailoverEnabled(Boolean value)` Sets the value of the automaticConnectionFailoverEnabled property.
`void`	`setAutomaticFailoverEnabled(Boolean value)` Sets the value of the automaticFailoverEnabled property.
`void`	`setAutomaticFailoverInformation(AutomaticFailoverInformation value)` Sets the value of the automaticFailoverInformation property.
`void`	`setAutomaticFailoverlastUpdated(String value)` Sets the value of the automaticFailoverlastUpdated property.
`void`	`setEncryptionAlgorithm(EncryptionAlgorithm value)` Sets the value of the encryptionAlgorithm property.
`void`	`setExternalServicesEnabled(boolean value)` Sets the value of the externalServicesEnabled property.
`void`	`setHostRoutingInfo(String value)` Sets the value of the hostRoutingInfo property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setSrpAddressInformation(SRPAddressInformation value)` Sets the value of the srpAddressInformation property.
`void`	`setSrpId(String value)` Sets the value of the srpId property.
`void`	`setSrpKey(String value)` Sets the value of the srpKey property.
`void`	`setSrpStatus(SRPStatus value)` Sets the value of the srpStatus property.
`void`	`setUid(String value)` Sets the value of the uid property.
`void`	`setUserCount(int value)` Sets the value of the userCount property.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - uid
```
protected String uid
```
  - name
```
protected String name
```
  - localeNameAndDescription
```
protected List<LocaleNameAndDescription> localeNameAndDescription
```
  - userCount
```
protected int userCount
```
  - srpId
```
protected String srpId
```
  - srpStatus
```
protected SRPStatus srpStatus
```
  - srpKey
```
protected String srpKey
```
  - srpAddressInformation
```
protected SRPAddressInformation srpAddressInformation
```
  - hostRoutingInfo
```
protected String hostRoutingInfo
```
  - encryptionAlgorithm
```
protected EncryptionAlgorithm encryptionAlgorithm
```
  - externalServicesEnabled
```
protected boolean externalServicesEnabled
```
  - automaticFailoverEnabled
```
protected Boolean automaticFailoverEnabled
```
  - automaticConnectionFailoverEnabled
```
protected Boolean automaticConnectionFailoverEnabled
```
  - automaticFailoverlastUpdated
```
protected String automaticFailoverlastUpdated
```
  - besServices
```
protected List<BESService> besServices
```
  - automaticFailoverInformation
```
protected AutomaticFailoverInformation automaticFailoverInformation
```
  - any
```
protected List<Object> any
```
- Constructor Detail
  - BESHAPool
```
public BESHAPool()
```
- Method Detail
  - getUid
```
public String getUid()
```
    Gets the value of the uid property.
    
    Returns:
    possible object is String
  - setUid
```
public void setUid(String value)
```
    Sets the value of the uid property.
    
    Parameters:
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getLocaleNameAndDescription
```
public List<LocaleNameAndDescription> getLocaleNameAndDescription()
```
    Gets the value of the localeNameAndDescription property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the localeNameAndDescription property.
    For example, to add a new item, do as follows:
```
 getLocaleNameAndDescription().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LocaleNameAndDescription
  - getUserCount
```
public int getUserCount()
```
    Gets the value of the userCount property.
  - setUserCount
```
public void setUserCount(int value)
```
    Sets the value of the userCount property.
  - getSrpId
```
public String getSrpId()
```
    Gets the value of the srpId property.
    
    Returns:
    possible object is String
  - setSrpId
```
public void setSrpId(String value)
```
    Sets the value of the srpId property.
    
    Parameters:
    value - allowed object is String
  - getSrpStatus
```
public SRPStatus getSrpStatus()
```
    Gets the value of the srpStatus property.
    
    Returns:
    possible object is SRPStatus
  - setSrpStatus
```
public void setSrpStatus(SRPStatus value)
```
    Sets the value of the srpStatus property.
    
    Parameters:
    value - allowed object is SRPStatus
  - getSrpKey
```
public String getSrpKey()
```
    Gets the value of the srpKey property.
    
    Returns:
    possible object is String
  - setSrpKey
```
public void setSrpKey(String value)
```
    Sets the value of the srpKey property.
    
    Parameters:
    value - allowed object is String
  - getSrpAddressInformation
```
public SRPAddressInformation getSrpAddressInformation()
```
    Gets the value of the srpAddressInformation property.
    
    Returns:
    possible object is SRPAddressInformation
  - setSrpAddressInformation
```
public void setSrpAddressInformation(SRPAddressInformation value)
```
    Sets the value of the srpAddressInformation property.
    
    Parameters:
    value - allowed object is SRPAddressInformation
  - getHostRoutingInfo
```
public String getHostRoutingInfo()
```
    Gets the value of the hostRoutingInfo property.
    
    Returns:
    possible object is String
  - setHostRoutingInfo
```
public void setHostRoutingInfo(String value)
```
    Sets the value of the hostRoutingInfo property.
    
    Parameters:
    value - allowed object is String
  - getEncryptionAlgorithm
```
public EncryptionAlgorithm getEncryptionAlgorithm()
```
    Gets the value of the encryptionAlgorithm property.
    
    Returns:
    possible object is EncryptionAlgorithm
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(EncryptionAlgorithm value)
```
    Sets the value of the encryptionAlgorithm property.
    
    Parameters:
    value - allowed object is EncryptionAlgorithm
  - isExternalServicesEnabled
```
public boolean isExternalServicesEnabled()
```
    Gets the value of the externalServicesEnabled property.
  - setExternalServicesEnabled
```
public void setExternalServicesEnabled(boolean value)
```
    Sets the value of the externalServicesEnabled property.
  - isAutomaticFailoverEnabled
```
public Boolean isAutomaticFailoverEnabled()
```
    Gets the value of the automaticFailoverEnabled property.
    
    Returns:
    possible object is Boolean
  - setAutomaticFailoverEnabled
```
public void setAutomaticFailoverEnabled(Boolean value)
```
    Sets the value of the automaticFailoverEnabled property.
    
    Parameters:
    value - allowed object is Boolean
  - isAutomaticConnectionFailoverEnabled
```
public Boolean isAutomaticConnectionFailoverEnabled()
```
    Gets the value of the automaticConnectionFailoverEnabled property.
    
    Returns:
    possible object is Boolean
  - setAutomaticConnectionFailoverEnabled
```
public void setAutomaticConnectionFailoverEnabled(Boolean value)
```
    Sets the value of the automaticConnectionFailoverEnabled property.
    
    Parameters:
    value - allowed object is Boolean
  - getAutomaticFailoverlastUpdated
```
public String getAutomaticFailoverlastUpdated()
```
    Gets the value of the automaticFailoverlastUpdated property.
    
    Returns:
    possible object is String
  - setAutomaticFailoverlastUpdated
```
public void setAutomaticFailoverlastUpdated(String value)
```
    Sets the value of the automaticFailoverlastUpdated property.
    
    Parameters:
    value - allowed object is String
  - getBesServices
```
public List<BESService> getBesServices()
```
    Gets the value of the besServices property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the besServices property.
    For example, to add a new item, do as follows:
```
 getBesServices().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list BESService
  - getAutomaticFailoverInformation
```
public AutomaticFailoverInformation getAutomaticFailoverInformation()
```
    Gets the value of the automaticFailoverInformation property.
    
    Returns:
    possible object is AutomaticFailoverInformation
  - setAutomaticFailoverInformation
```
public void setAutomaticFailoverInformation(AutomaticFailoverInformation value)
```
    Sets the value of the automaticFailoverInformation property.
    
    Parameters:
    value - allowed object is AutomaticFailoverInformation
  - getAny
```
public List<Object> getAny()
```
    Gets the value of the any property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.
    For example, to add a new item, do as follows:
```
 getAny().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Object

Class BESHAPool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

uid

name

localeNameAndDescription

userCount

srpId

srpStatus

srpKey

srpAddressInformation

hostRoutingInfo

encryptionAlgorithm

externalServicesEnabled

automaticFailoverEnabled

automaticConnectionFailoverEnabled

automaticFailoverlastUpdated

besServices

automaticFailoverInformation

any

Constructor Detail

BESHAPool

Method Detail

getUid

setUid

getName

setName

getLocaleNameAndDescription

getUserCount

setUserCount

getSrpId

setSrpId

getSrpStatus

setSrpStatus

getSrpKey

setSrpKey

getSrpAddressInformation

setSrpAddressInformation

getHostRoutingInfo

setHostRoutingInfo

getEncryptionAlgorithm

setEncryptionAlgorithm

isExternalServicesEnabled

setExternalServicesEnabled

isAutomaticFailoverEnabled

setAutomaticFailoverEnabled

isAutomaticConnectionFailoverEnabled

setAutomaticConnectionFailoverEnabled

getAutomaticFailoverlastUpdated

setAutomaticFailoverlastUpdated

getBesServices

getAutomaticFailoverInformation

setAutomaticFailoverInformation

getAny