BlackBerry Administration API
v5.0.3.29

com.rim.bes.bas.baa.dto
Class FindUsersResultType

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

public abstract class FindUsersResultType
extends BASBaseDTO

Java class for FindUsersResultType complex type.

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

 <complexType name="FindUsersResultType">
   <complexContent>
     <extension base="{http://www.rim.com/com.rim.bes.bas.dto}BASBaseDTO">
       <sequence>
         <element name="findUsersReturnStatus" type="{http://www.rim.com/com.rim.bes.bas.baa.dto}FindUsersReturnStatus" minOccurs="0"/>
         <element name="metadata" type="{http://www.rim.com/com.rim.bes.bas.baa.common.dto}Metadata" minOccurs="0"/>
         <element name="userSearchResult" type="{http://www.rim.com/com.rim.bes.bas.dto}UserSearchResult" maxOccurs="unbounded" 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  FindUsersReturnStatus findUsersReturnStatus
           
protected  Metadata metadata
           
protected  java.util.List<UserSearchResult> userSearchResult
           
 
Fields inherited from class com.rim.bes.bas.dto.BASBaseDTO
versionStamps
 
Constructor Summary
FindUsersResultType()
           
 
Method Summary
 FindUsersReturnStatus getFindUsersReturnStatus()
          Indicates whether or not an error has occurred.
 Metadata getMetadata()
          Gets the value of the metadata property.
 java.util.List<UserSearchResult> getUserSearchResult()
          Contains the search result for the FindUsers API.
 void setFindUsersReturnStatus(FindUsersReturnStatus value)
          Sets the value of the findUsersReturnStatus 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

findUsersReturnStatus

protected FindUsersReturnStatus findUsersReturnStatus

metadata

protected Metadata metadata

userSearchResult

protected java.util.List<UserSearchResult> userSearchResult
Constructor Detail

FindUsersResultType

public FindUsersResultType()
Method Detail

getFindUsersReturnStatus

public FindUsersReturnStatus getFindUsersReturnStatus()
Indicates whether or not an error has occurred.

Returns:
possible object is FindUsersReturnStatus

setFindUsersReturnStatus

public void setFindUsersReturnStatus(FindUsersReturnStatus value)
Sets the value of the findUsersReturnStatus property.

Parameters:
value - allowed object is FindUsersReturnStatus

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

getUserSearchResult

public java.util.List<UserSearchResult> getUserSearchResult()

Contains the search result for the FindUsers API.

Gets the value of the userSearchResult 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 userSearchResult property.

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

    getUserSearchResult().add(newItem);
 

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


BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.