BlackBerry Administration API
v5.0.3.29

com.rim.bes.bas.baa.dispatcher.dto
Class GetDispatcherNamesResultType

Package class diagram package GetDispatcherNamesResultType
java.lang.Object
  extended by com.rim.bes.bas.dto.BASBaseDTO
      extended by com.rim.bes.bas.baa.dispatcher.dto.GetDispatcherNamesResultType
Direct Known Subclasses:
GetDispatcherNamesResult

public abstract class GetDispatcherNamesResultType
extends BASBaseDTO

Java class for GetDispatcherNamesResultType complex type.

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

 <complexType name="GetDispatcherNamesResultType">
   <complexContent>
     <extension base="{http://www.rim.com/com.rim.bes.bas.dto}BASBaseDTO">
       <sequence>
         <element name="dispatcherHostNames" type="{http://www.rim.com/com.rim.bes.basplugin.dispatcher.dto}DispatcherHostName" maxOccurs="unbounded" minOccurs="0"/>
         <element name="getDispatcherNamesReturnStatus" type="{http://www.rim.com/com.rim.bes.bas.baa.dispatcher.dto}GetDispatcherNamesReturnStatus" minOccurs="0"/>
         <element name="metadata" type="{http://www.rim.com/com.rim.bes.bas.baa.common.dto}Metadata" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rim.bes.bas.dto.BASBaseDTO
BASBaseDTO.VersionStamps
 
Field Summary
protected  java.util.List<DispatcherHostName> dispatcherHostNames
           
protected  GetDispatcherNamesReturnStatus getDispatcherNamesReturnStatus
           
protected  Metadata metadata
           
 
Fields inherited from class com.rim.bes.bas.dto.BASBaseDTO
versionStamps
 
Constructor Summary
GetDispatcherNamesResultType()
           
 
Method Summary
 java.util.List<DispatcherHostName> getDispatcherHostNames()
          list of Dispatchers in the BlackBerry Domain.
 GetDispatcherNamesReturnStatus getGetDispatcherNamesReturnStatus()
          Indicates whether or not an error has occurred.
 Metadata getMetadata()
          Gets the value of the metadata property.
 void setGetDispatcherNamesReturnStatus(GetDispatcherNamesReturnStatus value)
          Sets the value of the getDispatcherNamesReturnStatus property.
 void setMetadata(Metadata value)
          Sets the value of the metadata property.
 
Methods inherited from class com.rim.bes.bas.dto.BASBaseDTO
getVersionStamps, setVersionStamps
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dispatcherHostNames

protected java.util.List<DispatcherHostName> dispatcherHostNames

getDispatcherNamesReturnStatus

protected GetDispatcherNamesReturnStatus getDispatcherNamesReturnStatus

metadata

protected Metadata metadata
Constructor Detail

GetDispatcherNamesResultType

public GetDispatcherNamesResultType()
Method Detail

getDispatcherHostNames

public java.util.List<DispatcherHostName> getDispatcherHostNames()
list of Dispatchers in the BlackBerry Domain. Gets the value of the dispatcherHostNames 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 dispatcherHostNames property.

For example, to add a new item, do as follows:

    getDispatcherHostNames().add(newItem);
 

Objects of the following type(s) are allowed in the list DispatcherHostName


getGetDispatcherNamesReturnStatus

public GetDispatcherNamesReturnStatus getGetDispatcherNamesReturnStatus()
Indicates whether or not an error has occurred.

Returns:
possible object is GetDispatcherNamesReturnStatus

setGetDispatcherNamesReturnStatus

public void setGetDispatcherNamesReturnStatus(GetDispatcherNamesReturnStatus value)
Sets the value of the getDispatcherNamesReturnStatus property.

Parameters:
value - allowed object is GetDispatcherNamesReturnStatus

getMetadata

public Metadata getMetadata()
Gets the value of the metadata property.

Returns:
possible object is Metadata

setMetadata

public void setMetadata(Metadata value)
Sets the value of the metadata property.

Parameters:
value - allowed object is Metadata

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.