de.westnordost.osmapi.notes

Class QueryNotesFilters

java.lang.Object

de.westnordost.osmapi.notes.QueryNotesFilters

public class QueryNotesFilters
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
QueryNotesFilters()

Method Summary

Modifier and Type	Method and Description
QueryNotesFilters	byTerm(java.lang.String term)
QueryNotesFilters	byUser(long userId)
QueryNotesFilters	byUser(java.lang.String displayName)
QueryNotesFilters	createdAfter(java.util.Date date)
QueryNotesFilters	createdBefore(java.util.Date date)
QueryNotesFilters	hideClosedNotesAfter(int days)
QueryNotesFilters	limit(int count)
java.lang.String	toParamString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryNotesFilters

public QueryNotesFilters()

Method Detail

byTerm

public QueryNotesFilters byTerm(java.lang.String term)

Parameters:

term - search for a certain string

byUser

public QueryNotesFilters byUser(java.lang.String displayName)

Parameters:

displayName - limit search to only the given user name

Throws:

java.lang.IllegalArgumentException - if a user has already been specified by id

byUser

public QueryNotesFilters byUser(long userId)

Parameters:

userId - limit search to only the given user id

Throws:

java.lang.IllegalArgumentException - if a user has already been specified by user name

createdAfter

public QueryNotesFilters createdAfter(java.util.Date date)

Parameters:

date - include notes only created after the given date

createdBefore

public QueryNotesFilters createdBefore(java.util.Date date)

Parameters:

date - include notes only created after the given date. If not specified, now

hideClosedNotesAfter

public QueryNotesFilters hideClosedNotesAfter(int days)

Parameters:

days - include closed notes in the search closed not more than x days ago. Default is 7 days. A value of -1 means all notes are returned

limit

public QueryNotesFilters limit(int count)

Parameters:

count - return at most this many notes. Default is 100. Must be within 1 and 10000.

Throws:

java.lang.IllegalArgumentException - if the given limit is not within 1 and 10000

toParamString

public java.lang.String toParamString()