org.codeforamerica.open311.facade.data.operations
Class GETServiceRequestsFilter

java.lang.Object
  org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

All Implemented Interfaces:

Serializable

public class GETServiceRequestsFilter
extends Object
implements Serializable

Useful to pass optional parameters to the APIWrapper.getServiceRequests(GETServiceRequestsFilter) operation. Use the method chaining to add optional values to the object.

Author:

Santiago Munín

See Also:

Serialized Form

Constructor Summary

GETServiceRequestsFilter()

Method Summary

Map<String,String>	getOptionalParametersMap() Builds a map containing all the set arguments.
GETServiceRequestsFilter	setEndDate(Date endDate)
GETServiceRequestsFilter	setServiceCode(String serviceCode)
GETServiceRequestsFilter	setServiceRequestId(String serviceRequestId) Adds one or more service request ids to the filtering parameters.
GETServiceRequestsFilter	setStartDate(Date startDate)
GETServiceRequestsFilter	setStatus(ServiceRequest.Status status)

Methods inherited from class java.lang.Object

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

Constructor Detail

GETServiceRequestsFilter

public GETServiceRequestsFilter()

Method Detail

setServiceRequestId

public GETServiceRequestsFilter setServiceRequestId(String serviceRequestId)

Adds one or more service request ids to the filtering parameters.

Parameters:

serviceRequestId - A comma delimited list of service request ids. Example: 1 or 1,2,3.

Returns:

The same object with the given parameter added as an argument.

setServiceCode

public GETServiceRequestsFilter setServiceCode(String serviceCode)

setStartDate

public GETServiceRequestsFilter setStartDate(Date startDate)

setEndDate

public GETServiceRequestsFilter setEndDate(Date endDate)

setStatus

public GETServiceRequestsFilter setStatus(ServiceRequest.Status status)

getOptionalParametersMap

public Map<String,String> getOptionalParametersMap()

Builds a map containing all the set arguments.

Returns:

List of pairs (key, value) with the required arguments.