org.dajlab.bricksetapi.v3.vo

Class SetParameters

java.lang.Object

org.dajlab.bricksetapi.v3.vo.SetParameters

public class SetParameters
extends Object

Constructor Summary

Constructors

Constructor and Description
SetParameters()

Method Summary

Modifier and Type	Method and Description
SetParameters	addSetNumber(String setNumber) Full set number, in the format {number}-{variant}, e.g. 6876-1
SetParameters	addSubtheme(String subtheme)
SetParameters	addTheme(String theme)
SetParameters	addYear(String year)
Boolean	getExtendedData()
OrderByEnum	getOrderBy()
protected Boolean	getOwned()
Integer	getPageNumber()
Integer	getPageSize()
String	getQuery()
Integer	getSetId()
List<String>	getSetNumber()
List<String>	getSubtheme()
String	getTag()
List<String>	getTheme()
Calendar	getUpdatedSince()
protected Boolean	getWanted()
List<String>	getYear()
SetParameters	onlyOwned() Retrieve a user's owned sets
SetParameters	onlyWanted() Retrieve a user's wanted sets.
void	setExtendedData(Boolean extendedData) Set to true to retrieve the full data set, including tags, description and notes.
SetParameters	setOrderBy(OrderByEnum orderBy) Sort order
protected void	setOwned(Boolean owned) Set to true to retrieve a user's owned sets
SetParameters	setPageNumber(Integer pageNumber) Specify which page of records to retrieve, use in conjunction with pageSize (default: 1)
SetParameters	setPageSize(Integer pageSize) Specify how many records to retrieve (default: 20, max: 500)
SetParameters	setQuery(String query) Search term: searches set number, name, theme, subtheme, barcode
SetParameters	setSetId(Integer setId) Internal SetID.
void	setTag(String tag)
SetParameters	setUpdatedSince(Calendar updatedSince)
protected void	setWanted(Boolean wanted) Set to true to retrieve a user's wanted sets
SetParameters	withExtendedData() Retrieve the full data set, including tags, description and notes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SetParameters

public SetParameters()

Method Detail

onlyOwned

public final SetParameters onlyOwned()

Retrieve a user's owned sets

Returns:

this

onlyWanted

public final SetParameters onlyWanted()

Retrieve a user's wanted sets.

Returns:

this

setSetId

public final SetParameters setSetId(Integer setId)

Internal SetID.

Parameters:

setId - the setId to set

Returns:

this

setQuery

public final SetParameters setQuery(String query)

Search term: searches set number, name, theme, subtheme, barcode

Parameters:

query - the query to set

Returns:

this

addTheme

public final SetParameters addTheme(String theme)

Parameters:

theme - the theme to set

Returns:

this

addSubtheme

public final SetParameters addSubtheme(String subtheme)

Parameters:

subtheme - the subtheme to set

Returns:

this

addSetNumber

public final SetParameters addSetNumber(String setNumber)

Full set number, in the format {number}-{variant}, e.g. 6876-1

Parameters:

setNumber - the setNumber to set

Returns:

this

addYear

public final SetParameters addYear(String year)

Parameters:

year - the year to set

Returns:

this

setOwned

protected final void setOwned(Boolean owned)

Set to true to retrieve a user's owned sets

Parameters:

owned - the owned to set

setWanted

protected final void setWanted(Boolean wanted)

Set to true to retrieve a user's wanted sets

Parameters:

wanted - the wanted to set

setUpdatedSince

public final SetParameters setUpdatedSince(Calendar updatedSince)

Parameters:

updatedSince - the updatedSince to set

Returns:

this

setOrderBy

public final SetParameters setOrderBy(OrderByEnum orderBy)

Sort order

Parameters:

orderBy - the orderBy to set

Returns:

this

setPageSize

public final SetParameters setPageSize(Integer pageSize)

Specify how many records to retrieve (default: 20, max: 500)

Parameters:

pageSize - the pageSize to set

Returns:

this

setPageNumber

public final SetParameters setPageNumber(Integer pageNumber)

Specify which page of records to retrieve, use in conjunction with pageSize (default: 1)

Parameters:

pageNumber - the pageNumber to set

Returns:

this

withExtendedData

public SetParameters withExtendedData()

Retrieve the full data set, including tags, description and notes.

Returns:

this

getSetId

public final Integer getSetId()

Returns:

the setId

getQuery

public final String getQuery()

Returns:

the query

getTheme

public final List<String> getTheme()

Returns:

the theme

getSubtheme

public final List<String> getSubtheme()

Returns:

the subtheme

getSetNumber

public final List<String> getSetNumber()

Returns:

the setNumber

getYear

public final List<String> getYear()

Returns:

the year

getOwned

protected final Boolean getOwned()

Returns:

the owned

getWanted

protected final Boolean getWanted()

Returns:

the wanted

getUpdatedSince

public final Calendar getUpdatedSince()

Returns:

the updatedSince

getOrderBy

public final OrderByEnum getOrderBy()

Returns:

the orderBy

getPageSize

public final Integer getPageSize()

Returns:

the pageSize

getPageNumber

public final Integer getPageNumber()

Returns:

the pageNumber

getTag

public String getTag()

Returns:

the tag

setTag

public void setTag(String tag)

Parameters:

tag - the tag to set

getExtendedData

public Boolean getExtendedData()

Returns:

the extendedData

setExtendedData

public void setExtendedData(Boolean extendedData)

Set to true to retrieve the full data set, including tags, description and notes.

Parameters:

extendedData - the extendedData to set