com.yahoo.search
Class ImageSearchRequest

java.lang.Object
  com.yahoo.rest.RestRequest
      com.yahoo.search.ImageSearchRequest

public class ImageSearchRequest
extends RestRequest

Image search request object.

Author:

Ryan Kennedy

Constructor Summary

ImageSearchRequest(String query)
Constructs a new image search request.

Method Summary

void	setAdultOk(boolean adultOk) Specifies if adult related results are permitted.
void	setColoration(String coloration) The service returns only the images of the coloration specified (color or black-and-white).
void	setFormat(String format) Specifies the kind of image file to search for.
void	setQuery(String query) The image query to search for.
void	setResults(int results) The maximum number of results to return.
void	setStart(BigInteger start) The starting result position.
void	setType(String type) Sets the type of the search.

Methods inherited from class com.yahoo.rest.RestRequest

addParameter, clearParameter, getParameters, getRequestUrl, setParameter, setRequestUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageSearchRequest

public ImageSearchRequest(String query)

Constructs a new image search request.

Parameters:

query - The query to search for. This is the only required attribute.

Method Detail

setQuery

public void setQuery(String query)

The image query to search for.

Parameters:

query - The image query to search for.

setType

public void setType(String type)

Sets the type of the search. At the time of writing, three options are available:

• all (default): returns results with all query terms
• any: returns results with one or more of the query terms
• phrase: returns results containing the query terms as a phrase

Parameters:

type - The type of search to execute.

setResults

public void setResults(int results)

The maximum number of results to return. May return fewer results if there aren't enough results in the database. At the time of writing, the default value is 10, the maximum value is 50.

Parameters:

results - The maximum number of results to return.

setStart

public void setStart(BigInteger start)

The starting result position. This number should increment by the value of the results argument each time the user chooses the next page of results. The default is 1.

Parameters:

start - The starting result position.

setFormat

public void setFormat(String format)

Specifies the kind of image file to search for. At the time of writing, the following options are available: all (default), bmp, gif, jpeg, png.

Parameters:

format - Specifies the kind of image file to search for.

setAdultOk

public void setAdultOk(boolean adultOk)

Specifies if adult related results are permitted. Defaults to false.

Parameters:

adultOk - Specifies if adult related results are permitted.

setColoration

public void setColoration(String coloration)

The service returns only the images of the coloration specified (color or black-and-white).

Parameters:

coloration - The coloration of the results to return. Default is any.