BlackBerry Administration API
v5.0.3.29

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

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

public abstract class FindGroupsResultType
extends BASBaseDTO

Java class for FindGroupsResultType complex type.

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

 <complexType name="FindGroupsResultType">
   <complexContent>
     <extension base="{http://www.rim.com/com.rim.bes.bas.dto}BASBaseDTO">
       <sequence>
         <element name="findGroupsReturnStatus" type="{http://www.rim.com/com.rim.bes.bas.baa.dto}FindGroupsReturnStatus" minOccurs="0"/>
         <element name="groups" type="{http://www.rim.com/com.rim.bes.bas.baa.dto}Group" maxOccurs="unbounded" 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  FindGroupsReturnStatus findGroupsReturnStatus
           
protected  java.util.List<Group> groups
           
protected  Metadata metadata
           
 
Fields inherited from class com.rim.bes.bas.dto.BASBaseDTO
versionStamps
 
Constructor Summary
FindGroupsResultType()
           
 
Method Summary
 FindGroupsReturnStatus getFindGroupsReturnStatus()
          Indicates whether or not an error has occurred.
 java.util.List<Group> getGroups()
          The groups in the specified organization.
 Metadata getMetadata()
          Gets the value of the metadata property.
 void setFindGroupsReturnStatus(FindGroupsReturnStatus value)
          Sets the value of the findGroupsReturnStatus 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

findGroupsReturnStatus

protected FindGroupsReturnStatus findGroupsReturnStatus

groups

protected java.util.List<Group> groups

metadata

protected Metadata metadata
Constructor Detail

FindGroupsResultType

public FindGroupsResultType()
Method Detail

getFindGroupsReturnStatus

public FindGroupsReturnStatus getFindGroupsReturnStatus()
Indicates whether or not an error has occurred.

Returns:
possible object is FindGroupsReturnStatus

setFindGroupsReturnStatus

public void setFindGroupsReturnStatus(FindGroupsReturnStatus value)
Sets the value of the findGroupsReturnStatus property.

Parameters:
value - allowed object is FindGroupsReturnStatus

getGroups

public java.util.List<Group> getGroups()
The groups in the specified organization. Gets the value of the groups 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 groups property.

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

    getGroups().add(newItem);
 

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


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.