public class

AppsForYourDomainQuery

extends Query
java.lang.Object
   ↳ com.google.gdata.client.Query
     ↳ com.google.gdata.client.appsforyourdomain.AppsForYourDomainQuery

Class Overview

The AppsForYourDomainQuery class extends the base GData Query class to define convenient APIs for AppsForYourDomain custom query parameters.

Summary

Constants
String RECIPIENT
String START_EMAILLIST_NAME
String START_NICKNAME
String START_RECIPIENT
String START_USERNAME
String USERNAME
[Expand]
Inherited Constants
From class com.google.gdata.client.Query
[Expand]
Inherited Fields
From class com.google.gdata.client.Query
Public Constructors
AppsForYourDomainQuery(URL feedUrl)
Constructs a new AppsForYourDomainQuery object that targets a feed.
Public Methods
String getRecipient()
String getStartEmailListName()
String getStartNickname()
String getStartRecipient()
String getStartUsername()
String getUsername()
void setRecipient(String recipient)
Sets the recipient for which we want to conduct email list searches.
void setStartEmailListName(String startEmailListName)
Sets the startEmailListName for which we want to conduct email list retrievals.
void setStartNickname(String startNickname)
Sets the startNickname for which we want to conduct nickname retrievals.
void setStartRecipient(String startRecipient)
Sets the startRecipient for which we want to conduct email list recipient retrievals.
void setStartUsername(String startUsername)
Sets the startUsername for which we want to conduct user retrievals.
void setUsername(String username)
Sets the username to restrict the retrieval of NicknameFeed entries.
Protected Methods
String getParameter(String parameterKey)
void setParameter(String parameterKey, String parameterValue)
[Expand]
Inherited Methods
From class com.google.gdata.client.Query
From class java.lang.Object

Constants

public static final String RECIPIENT

Constant Value: "recipient"

public static final String START_EMAILLIST_NAME

Constant Value: "startEmailListName"

public static final String START_NICKNAME

Constant Value: "startNickname"

public static final String START_RECIPIENT

Constant Value: "startRecipient"

public static final String START_USERNAME

Constant Value: "startUsername"

public static final String USERNAME

Constant Value: "username"

Public Constructors

public AppsForYourDomainQuery (URL feedUrl)

Constructs a new AppsForYourDomainQuery object that targets a feed. The initial state of the query contains no parameters, meaning all entries in the feed would be returned if the query was executed immediately after construction.

Parameters
feedUrl The URL of the feed against which queries will be executed.

Public Methods

public String getRecipient ()

Returns
  • the recipient that will be found in all EmailListFeed entries. A value of null indicates that recipient based querying is disabled.

public String getStartEmailListName ()

Returns
  • the starting emailList name of the EmailListFeed we are retrieving. All emailLists returned will have names occuring at or after this value. A value of null indicates that recipient based querying is disabled.

public String getStartNickname ()

Returns
  • the starting nickname of the NicknameFeed we are retrieving. All nicknames returned will have names occuring at or after this value. A value of null indicates that recipient based querying is disabled.

public String getStartRecipient ()

Returns
  • the starting recipient of the EmailListRecipientFeed we are retrieving. All recipients returned will have email addresses occuring at or after this value. A value of null indicates that recipient based querying is disabled.

public String getStartUsername ()

Returns
  • the starting username of the UserFeed we are retrieving. All users returned will have usernames occuring at or after this value. A value of null indicates that startUsername based querying is disabled.

public String getUsername ()

Returns
  • the username that will be found in all NicknameFeed entries. A value of null indicates that username based querying is disabled.

public void setRecipient (String recipient)

Sets the recipient for which we want to conduct email list searches.

Parameters
recipient The recipient for which we want to obtain email list subscription.

public void setStartEmailListName (String startEmailListName)

Sets the startEmailListName for which we want to conduct email list retrievals.

Parameters
startEmailListName The emailList name at which we want to start our email list retrieval.

public void setStartNickname (String startNickname)

Sets the startNickname for which we want to conduct nickname retrievals.

Parameters
startNickname The nickname at which we want to start our nickname retrieval.

public void setStartRecipient (String startRecipient)

Sets the startRecipient for which we want to conduct email list recipient retrievals.

Parameters
startRecipient The recipient at which we want to start our email list recipient retrieval.

public void setStartUsername (String startUsername)

Sets the startUsername for which we want to conduct user retrievals.

Parameters
startUsername The username at which we want to start our user retrieval.

public void setUsername (String username)

Sets the username to restrict the retrieval of NicknameFeed entries.

Parameters
username The username for we wish to obtain the nicknames.

Protected Methods

protected String getParameter (String parameterKey)

Parameters
parameterKey

protected void setParameter (String parameterKey, String parameterValue)

Parameters
parameterKey
parameterValue