BlackBerry Administration API
v5.0.3.29

com.rim.bes.basplugin.emailcommon.dto
Class MailStoreUserSearchCriteriaType

Package class diagram package MailStoreUserSearchCriteriaType
java.lang.Object
  extended by com.rim.bes.bas.dto.BASBaseDTO
      extended by com.rim.bes.basplugin.emailcommon.dto.MailStoreUserSearchCriteriaType
Direct Known Subclasses:
MailStoreUserSearchCriteria

public abstract class MailStoreUserSearchCriteriaType
extends BASBaseDTO

Java class for MailStoreUserSearchCriteriaType complex type.

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

 <complexType name="MailStoreUserSearchCriteriaType">
   <complexContent>
     <extension base="{http://www.rim.com/com.rim.bes.bas.dto}BASBaseDTO">
       <sequence>
         <element name="displayName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="emailAddress" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="isNewUserOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="mailStoreAddressId" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="type" type="{http://www.w3.org/2001/XMLSchema}int" 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.lang.String displayName
           
protected  java.lang.String emailAddress
           
protected  java.lang.Boolean isNewUserOnly
           
protected  java.lang.Integer mailStoreAddressId
           
protected  java.lang.Integer type
           
 
Fields inherited from class com.rim.bes.bas.dto.BASBaseDTO
versionStamps
 
Constructor Summary
MailStoreUserSearchCriteriaType()
           
 
Method Summary
 java.lang.String getDisplayName()
          Gets the value of the displayName property.
 java.lang.String getEmailAddress()
          Gets the value of the emailAddress property.
 java.lang.Integer getMailStoreAddressId()
          Gets the value of the mailStoreAddressId property.
 java.lang.Integer getType()
          Refers to MS Addresses table type column value: 0 - All mailstore entries, 6 - User is mail-enabled, 7 - User is non-mail-enabled (eg contact), 8 - Distribution list
 java.lang.Boolean isIsNewUserOnly()
          Set to true to eliminate any user who is currently BlackBerry enabled from the resulting set of users.
 void setDisplayName(java.lang.String value)
          Sets the value of the displayName property.
 void setEmailAddress(java.lang.String value)
          Sets the value of the emailAddress property.
 void setIsNewUserOnly(java.lang.Boolean value)
          Sets the value of the isNewUserOnly property.
 void setMailStoreAddressId(java.lang.Integer value)
          Sets the value of the mailStoreAddressId property.
 void setType(java.lang.Integer value)
          Sets the value of the type 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

displayName

protected java.lang.String displayName

emailAddress

protected java.lang.String emailAddress

isNewUserOnly

protected java.lang.Boolean isNewUserOnly

mailStoreAddressId

protected java.lang.Integer mailStoreAddressId

type

protected java.lang.Integer type
Constructor Detail

MailStoreUserSearchCriteriaType

public MailStoreUserSearchCriteriaType()
Method Detail

getDisplayName

public java.lang.String getDisplayName()
Gets the value of the displayName property.

Returns:
possible object is String

setDisplayName

public void setDisplayName(java.lang.String value)
Sets the value of the displayName property.

Parameters:
value - allowed object is String

getEmailAddress

public java.lang.String getEmailAddress()
Gets the value of the emailAddress property.

Returns:
possible object is String

setEmailAddress

public void setEmailAddress(java.lang.String value)
Sets the value of the emailAddress property.

Parameters:
value - allowed object is String

isIsNewUserOnly

public java.lang.Boolean isIsNewUserOnly()
Set to true to eliminate any user who is currently BlackBerry enabled from the resulting set of users.

Returns:
possible object is Boolean

setIsNewUserOnly

public void setIsNewUserOnly(java.lang.Boolean value)
Sets the value of the isNewUserOnly property.

Parameters:
value - allowed object is Boolean

getMailStoreAddressId

public java.lang.Integer getMailStoreAddressId()
Gets the value of the mailStoreAddressId property.

Returns:
possible object is Integer

setMailStoreAddressId

public void setMailStoreAddressId(java.lang.Integer value)
Sets the value of the mailStoreAddressId property.

Parameters:
value - allowed object is Integer

getType

public java.lang.Integer getType()
Refers to MS Addresses table type column value: 0 - All mailstore entries, 6 - User is mail-enabled, 7 - User is non-mail-enabled (eg contact), 8 - Distribution list

Returns:
possible object is Integer

setType

public void setType(java.lang.Integer value)
Sets the value of the type property.

Parameters:
value - allowed object is Integer

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.