Lookup (iTunes API 4.0 API)

java.lang.Object
- be.ceau.itunesapi.Lookup

All Implemented Interfaces:

Serializable
```
public class Lookup
extends Object
implements Serializable
```
Request object for the iTunes Lookup API.

See Also:

Lookup API, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Lookup()
No-arg constructor.

Constructors
Constructor and Description
`Lookup()` No-arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Lookup`	`addAmgAlbumId(String amgAlbumId)`
`Lookup`	`addAmgArtistId(String amgArtistId)`
`Lookup`	`addAmgVideoId(String amgVideoId)`
`Lookup`	`addId(String id)`
`Lookup`	`addIsbn(String isbn)`
`Lookup`	`addUpc(String upc)`
`String`	`build()` Create the request url for this `Lookup`
`Response`	`execute()` Execute this iTunes Lookup API request.
`Response`	`execute(Connector connector)` Execute this iTunes Lookup API request using the provided `Connector` implementation.
`Set<String>`	`getAmgAlbumIds()`
`Set<String>`	`getAmgArtistIds()`
`Set<String>`	`getAmgVideoIds()`
`Entity`	`getEntity()`
`Set<String>`	`getIds()`
`Set<String>`	`getIsbns()`
`int`	`getLimit()`
`Sort`	`getSort()`
`Set<String>`	`getUpcs()`
`Lookup`	`setAmgAlbumId(Collection<String> amgAlbumIds)`
`Lookup`	`setAmgArtistIds(Collection<String> amgArtistIds)`
`Lookup`	`setAmgVideoIds(Collection<String> amgVideoIds)`
`Lookup`	`setEntity(Entity entity)`
`Lookup`	`setIds(Collection<String> ids)`
`Lookup`	`setIsbns(Collection<String> isbns)`
`Lookup`	`setLimit(int limit)`
`Lookup`	`setSort(Sort sort)`
`Lookup`	`setUpcs(Collection<String> upcs)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Lookup
```
public Lookup()
```
    No-arg constructor.
- Method Detail
  - execute
```
public Response execute()
```
    Execute this iTunes Lookup API request.
    
    Returns:
    
    parsed Response from iTunes
    
    Throws:
    
    RuntimeException - wrapping any IOException thrown performing the request or parsing the response
    
    See Also:
    
    execute(Connector)
  - execute
```
public Response execute(Connector connector)
```
    Execute this iTunes Lookup API request using the provided Connector implementation.
    
    Parameters:
    
    connector - Connector instance, not null
    
    Returns:
    
    parsed Response from iTunes
    
    Throws:
    
    IllegalArgumentException - if argument null
    
    RuntimeException - wrapping any IOException thrown performing the request or parsing the response
    
    See Also:
    
    execute()
  - getIds
```
public Set<String> getIds()
```
    Returns:
    
    modifiable Set containing all ids currently set in this Lookup, never null
  - addId
```
public Lookup addId(String id)
```
    Parameters:
    
    id - an iTunes item id, can be null
    
    Returns:
    
    this instance for method chaining
  - setIds
```
public Lookup setIds(Collection<String> ids)
```
    Parameters:
    
    ids - a Collection of iTunes item ids, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getAmgArtistIds
```
public Set<String> getAmgArtistIds()
```
    Returns:
    
    modifiable Set containing all AMG artist ids currently set in this Lookup, never null
  - addAmgArtistId
```
public Lookup addAmgArtistId(String amgArtistId)
```
    Parameters:
    
    amgArtistId - an All Music artist id, can be null
    
    Returns:
    
    this instance for method chaining
  - setAmgArtistIds
```
public Lookup setAmgArtistIds(Collection<String> amgArtistIds)
```
    Parameters:
    
    amgArtistIds - a Collection of All Music artist ids, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getAmgAlbumIds
```
public Set<String> getAmgAlbumIds()
```
    Returns:
    
    modifiable Set containing all AMG album ids currently set in this Lookup, never null
  - addAmgAlbumId
```
public Lookup addAmgAlbumId(String amgAlbumId)
```
    Parameters:
    
    amgAlbumId - an All Music album id, can be null
    
    Returns:
    
    this instance for method chaining
  - setAmgAlbumId
```
public Lookup setAmgAlbumId(Collection<String> amgAlbumIds)
```
    Parameters:
    
    amgAlbumIds - a Collection of All Music album ids, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getAmgVideoIds
```
public Set<String> getAmgVideoIds()
```
    Returns:
    
    modifiable Set containing all AMG video ids currently set in this Lookup, never null
  - addAmgVideoId
```
public Lookup addAmgVideoId(String amgVideoId)
```
    Parameters:
    
    amgVideoId - an All Music video id, can be null
    
    Returns:
    
    this instance for method chaining
  - setAmgVideoIds
```
public Lookup setAmgVideoIds(Collection<String> amgVideoIds)
```
    Parameters:
    
    amgVideoIds - a Collection of All Music video ids, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getUpcs
```
public Set<String> getUpcs()
```
    Returns:
    
    modifiable Set containing all UPCs currently set in this Lookup, never null
  - addUpc
```
public Lookup addUpc(String upc)
```
    Parameters:
    
    upc - a UPC, can be null
    
    Returns:
    
    this instance for method chaining
  - setUpcs
```
public Lookup setUpcs(Collection<String> upcs)
```
    Parameters:
    
    upcs - a Collection of UPCs, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getIsbns
```
public Set<String> getIsbns()
```
    Returns:
    
    modifiable Set containing all ISBNs currently set in this Lookup, never null
  - addIsbn
```
public Lookup addIsbn(String isbn)
```
    Parameters:
    
    isbn - an ISBN, can be null
    
    Returns:
    
    this instance for method chaining
  - setIsbns
```
public Lookup setIsbns(Collection<String> isbns)
```
    Parameters:
    
    isbns - a Collection of ISBNs, can be null or empty
    
    Returns:
    
    this instance for method chaining
  - getEntity
```
public Entity getEntity()
```
    Returns:
    
    an Entity, or null
  - setEntity
```
public Lookup setEntity(Entity entity)
```
    Parameters:
    
    entity - an Entity, or null
    
    Returns:
    
    this instance for method chaining
  - getLimit
```
public int getLimit()
```
    Returns:
    
    maximum number of results to include in the response, or 0 if not set
  - setLimit
```
public Lookup setLimit(int limit)
```
    Parameters:
    
    limit - the maximum number of results to include in the response
    
    Returns:
    
    this instance for method chaining
  - getSort
```
public Sort getSort()
```
    Returns:
    
    Sort instance, or null
  - setSort
```
public Lookup setSort(Sort sort)
```
    Parameters:
    
    sort - a Sort instance, or null
    
    Returns:
    
    this instance for method chaining
  - build
```
public String build()
```
    Create the request url for this Lookup
    
    Returns:
    
    full request url String matching this Lookup

Class Lookup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Lookup

Method Detail

execute

execute

getIds

addId

setIds

getAmgArtistIds

addAmgArtistId

setAmgArtistIds

getAmgAlbumIds

addAmgAlbumId

setAmgAlbumId

getAmgVideoIds

addAmgVideoId

setAmgVideoIds

getUpcs

addUpc

setUpcs

getIsbns

addIsbn

setIsbns

getEntity

setEntity

getLimit

setLimit

getSort

setSort

build