Package be.ceau.itunesapi

Class Search

java.lang.Object

be.ceau.itunesapi.Search

All Implemented Interfaces:

Serializable

public class Search
extends Object
implements Serializable

Request object for the iTunes Search API.

See Also:

Search API, Serialized Form

Constructor Summary

Constructors

Constructor	Description
Search()	No-arg constructor.
Search(String term)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	build()	Create the request URL for this Search
Response	execute()	Execute this iTunes Search API request.
Response	execute(Connector connector)	Execute this iTunes Search API request using the provided Connector implementation.
Attribute	getAttribute()
Country	getCountry()
Entity	getEntity()
Lang	getLang()
Integer	getLimit()
Media	getMedia()
String	getTerm()
Integer	getVersion()
Boolean	isExplicit()
Search	setAttribute(Attribute attribute)
Search	setCountry(Country country)
Search	setEntity(Entity entity)
Search	setExplicit(boolean explicit)
Search	setLang(Lang lang)
Search	setLimit(int limit)	The number of search results you want the iTunes Store to return.
Search	setMedia(Media media)
Search	setTerm(String term)
Search	setVersion(int version)	The search result key version you want to receive back from your search.

Methods inherited from class java.lang.Object

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

Constructor Detail

Search

public Search()

No-arg constructor.

Search

public Search(String term)

Constructor.

Parameters:

term - word or phrase to search for, String, can be null

Method Detail

execute

public Response execute()

Execute this iTunes Search API request.

Returns:

parsed Response from iTunes

Throws:

IllegalStateException - as thrown by build()

RuntimeException - wrapping any IOException thrown performing the request or parsing the response

execute

public Response execute(Connector connector)

Execute this iTunes Search API request using the provided Connector implementation.

Parameters:

connector - Connector implementation, not null

Returns:

parsed Response from iTunes

Throws:

IllegalArgumentException - if argument null

IllegalStateException - as thrown by build()

RuntimeException - wrapping any IOException thrown performing the request or parsing the response

getTerm

public String getTerm()

Returns:

String instance, or null

setTerm

public Search setTerm(String term)

Parameters:

term - word or phrase to search for, String, can be null

Returns:

this instance for method chaining

getCountry

public Country getCountry()

Returns:

Country instance, or null

setCountry

public Search setCountry(Country country)

Parameters:

country - Country, can be null

Returns:

this instance for method chaining

getMedia

public Media getMedia()

Returns:

Media instance, or null

setMedia

public Search setMedia(Media media)

Parameters:

media - Media, can be null

Returns:

this instance for method chaining

getEntity

public Entity getEntity()

Returns:

Entity instance, or null

setEntity

public Search setEntity(Entity entity)

Parameters:

entity - Entity, can be null

Returns:

this instance for method chaining

getAttribute

public Attribute getAttribute()

Returns:

Attribute instance, or null

setAttribute

public Search setAttribute(Attribute attribute)

Parameters:

attribute - Attribute, can be null

Returns:

this instance for method chaining

getLimit

public Integer getLimit()

Returns:

Integer instance, or null

setLimit

public Search setLimit(int limit)

The number of search results you want the iTunes Store to return. For example: 25. The default is 50. Valid between 1 and 200.

Parameters:

limit - int between 1 (inclusive) and 200 (inclusive)

Returns:

this instance for method chaining

Throws:

IllegalArgumentException - if limit not valid

getLang

public Lang getLang()

Returns:

Lang instance, or null

setLang

public Search setLang(Lang lang)

Parameters:

lang - Lang, can be null

Returns:

this instance for method chaining

getVersion

public Integer getVersion()

Returns:

Integer instance, or null

setVersion

public Search setVersion(int version)

The search result key version you want to receive back from your search. The default is 2. Valid are 1 or 2

Parameters:

version - int 1 or 2

Returns:

this instance for method chaining

Throws:

IllegalArgumentException - if version not valid

isExplicit

public Boolean isExplicit()

Returns:

Boolean instance, or null

setExplicit

public Search setExplicit(boolean explicit)

Parameters:

explicit - boolean indicating whether or not to include explicit results

Returns:

this instance for method chaining

build

public String build()

Create the request URL for this Search

Returns:

full request URL matching this Search

Throws:

IllegalStateException - if no term is set in this Search