A B C D E F G H I J K L M N O P R S T U V W X Z

A

AbstractCache - Class in org.codeforamerica.open311.internals.caching

Implements all the operations of the Cache interface.

AbstractCache() - Constructor for class org.codeforamerica.open311.internals.caching.AbstractCache

AbstractParser - Class in org.codeforamerica.open311.internals.parsing

Contains common methods of the different DataParser implementations.

AbstractParser() - Constructor for class org.codeforamerica.open311.internals.parsing.AbstractParser

ACCOUNT_ID_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

activate(Object) - Method in class org.codeforamerica.open311.internals.logging.LogManager

Activates the logging for a concrete wrapper.

ADDRESS_ID_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

ADDRESS_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

addServiceWrapperRelationship(List<Service>, APIWrapper) - Method in class org.codeforamerica.open311.facade.data.RelationshipManager

Adds a relationship between a List<Service> and the APIWrapper which generated it.

AGENCY_RESPONSIBLE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

allStringsAreEmpty(String...) - Method in class org.codeforamerica.open311.internals.parsing.AbstractParser

Check if all the given strings are empty.

AndroidCache - Class in org.codeforamerica.open311.internals.caching

Uses the SharedPreferences of Android to store the data.

AndroidLogger - Class in org.codeforamerica.open311.internals.logging

Logger compatible with Android.

AndroidLogger() - Constructor for class org.codeforamerica.open311.internals.logging.AndroidLogger

APIWrapper - Class in org.codeforamerica.open311.facade

Base class of the API.

APIWrapperException - Exception in org.codeforamerica.open311.facade.exceptions

Thrown if it was any problem performing an operation through the APIWrapper.

APIWrapperException(String, APIWrapperException.Error, GeoReportV2Error) - Constructor for exception org.codeforamerica.open311.facade.exceptions.APIWrapperException

APIWrapperException.Error - Enum in org.codeforamerica.open311.facade.exceptions

Different types of errors.

APIWrapperFactory - Class in org.codeforamerica.open311.facade

Builds APIWrapper instances from different aspects specified by the user.

APIWrapperFactory(String) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the endpoint url.

APIWrapperFactory(String, String) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the endpoint url and the jurisdiction_id.

APIWrapperFactory(String, Format) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the endpoint url and the data interchange format.

APIWrapperFactory(String, String, Format) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the endpoint url and the jurisdiction_id.

APIWrapperFactory(City) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the desired city.

APIWrapperFactory(City, EndpointType) - Constructor for class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an instance from the desired city and endpoint type.

Attribute - Interface in org.codeforamerica.open311.facade.data

Specifies the required operations of an attribute useful for the POST Service Request operation.

ATTRIBUTE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

AttributeInfo - Class in org.codeforamerica.open311.facade.data

Represents a single attribute of a service definition.

AttributeInfo(Boolean, String, AttributeInfo.Datatype, Boolean, String, Integer, String, Map<String, String>) - Constructor for class org.codeforamerica.open311.facade.data.AttributeInfo

AttributeInfo.Datatype - Enum in org.codeforamerica.open311.facade.data

ATTRIBUTES_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

B

build() - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

Builds an APIWrapper.

buildCache() - Method in class org.codeforamerica.open311.internals.platform.PlatformManager

Builds a cache instance taking care of the execution environment.

buildDataParser(Format) - Method in class org.codeforamerica.open311.internals.parsing.DataParserFactory

Builds a data parser taking care of the desired format.

buildGetServiceDefinitionUrl(String) - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a GET Service Definition URL.

buildGetServiceListUrl() - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a GET Service List URL.

buildGetServiceRequest(String) - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a GET Service Request URL.

buildGetServiceRequestIdFromATokenUrl(String) - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a GET Service Request ID From Token URL.

buildGetServiceRequests(Map<String, String>) - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a GET Service Requests URL.

buildLogger() - Method in class org.codeforamerica.open311.internals.platform.PlatformManager

Builds a logger instance taking care of the execution environment.

buildPostServiceRequestBody(Map<String, String>, List<Attribute>) - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds the list of arguments of a POST service request.

buildPostServiceRequestUrl() - Method in class org.codeforamerica.open311.internals.network.URLBuilder

Builds a POST Service Request URL.

buildUrl(String) - Method in class org.codeforamerica.open311.internals.parsing.AbstractParser

Tries to build a URL.

C

Cache - Interface in org.codeforamerica.open311.internals.caching

Specifies all the operations needed to do data caching and avoid useless and slow network requests.

Cache.CacheableOperation - Enum in org.codeforamerica.open311.internals.caching

Set of operations which will be cached.

CacheableObject - Class in org.codeforamerica.open311.internals.caching

A pair of serializable, expiration date.

CacheableObject(Serializable, int) - Constructor for class org.codeforamerica.open311.internals.caching.CacheableObject

CacheableObject(String) - Constructor for class org.codeforamerica.open311.internals.caching.CacheableObject

CHANGESET_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

CHARSET - Static variable in interface org.codeforamerica.open311.internals.network.NetworkManager

checkParameters(String...) - Method in class org.codeforamerica.open311.internals.parsing.AbstractParser

Checks if any parameter is valid.

City - Enum in org.codeforamerica.open311.facade

An enumeration of cities which contains the service discovery urls and jurisdiction IDs.

CODE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

CONTACT_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

D

DataParser - Interface in org.codeforamerica.open311.internals.parsing

Specifies required operations to the parsers.

DataParserFactory - Class in org.codeforamerica.open311.internals.parsing

Builds instances of DataParser.

DataParsingException - Exception in org.codeforamerica.open311.facade.exceptions

Represents a problem in the parsing of any string.

DataParsingException(String) - Constructor for exception org.codeforamerica.open311.facade.exceptions.DataParsingException

DATATYPE_DESCRIPTION_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

DATATYPE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

DateParser - Class in org.codeforamerica.open311.internals.parsing

Provides operations to handle dates.

DateParser() - Constructor for class org.codeforamerica.open311.internals.parsing.DateParser

deleteCache() - Method in class org.codeforamerica.open311.internals.caching.AndroidCache

deleteCache() - Method in interface org.codeforamerica.open311.internals.caching.Cache

Deletes the cache.

deleteCache() - Method in class org.codeforamerica.open311.internals.caching.NoCache

deleteCache() - Method in class org.codeforamerica.open311.internals.caching.RegularJavaCache

DESCRIPTION_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

DEVICE_ID_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

disable(Object) - Method in class org.codeforamerica.open311.internals.logging.LogManager

Disables the logging for a concrete wrapper.

DISCOVERY_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

discoveryXML() - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

Mock service discovery.

doGet(URL) - Method in class org.codeforamerica.open311.internals.network.HTTPNetworkManager

doGet(URL) - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

doGet(URL) - Method in interface org.codeforamerica.open311.internals.network.NetworkManager

Sends a GET HTTP request.

doPost(URL, Map<String, String>) - Method in class org.codeforamerica.open311.internals.network.HTTPNetworkManager

doPost(URL, Map<String, String>) - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

doPost(URL, Map<String, String>) - Method in interface org.codeforamerica.open311.internals.network.NetworkManager

Sends a POST HTTP request.

E

EMAIL_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

END_DATE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

Endpoint - Class in org.codeforamerica.open311.facade.data

Wraps the information relative to a single endpoint.

Endpoint(String, String, Date, EndpointType, List<Format>) - Constructor for class org.codeforamerica.open311.facade.data.Endpoint

ENDPOINT_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

EndpointType - Enum in org.codeforamerica.open311.facade

Represents the different types of endpoints.

ERROR_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

errorJSON() - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

Mock error.

errorXML() - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

Mock error.

EXPECTED_DATETIME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

F

FILE - Static variable in class org.codeforamerica.open311.internals.caching.AbstractCache

FIRST_NAME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

Format - Enum in org.codeforamerica.open311.facade

Represent the different formats allowed by the library.

FORMAT_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

G

generatePOSTRequestParameter() - Method in interface org.codeforamerica.open311.facade.data.Attribute

Generates a list of pairs (String, String) ready to be passed as paremeters to a POST request.

generatePOSTRequestParameter() - Method in class org.codeforamerica.open311.facade.data.MultiValueAttribute

generatePOSTRequestParameter() - Method in class org.codeforamerica.open311.facade.data.SingleValueAttribute

GeoReportV2Error - Class in org.codeforamerica.open311.facade.exceptions

Wraps a GeoReport v2 API error.

GeoReportV2Error(String, String) - Constructor for class org.codeforamerica.open311.facade.exceptions.GeoReportV2Error

getAccountId() - Method in class org.codeforamerica.open311.facade.data.POSTServiceRequestResponse

getAddress() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getAddressId() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getAgencyResponsible() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getAttributes() - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Obtains the attributes related to the object.

getAttributes() - Method in class org.codeforamerica.open311.facade.data.ServiceDefinition

getBestFormat() - Method in class org.codeforamerica.open311.facade.data.Endpoint

Returns the more suitable format.

getBodyRequestParameters() - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Builds a map containing all the arguments.

getCache() - Method in class org.codeforamerica.open311.facade.APIWrapper

Returns the cache used by the wrapper.

getChangeset() - Method in class org.codeforamerica.open311.facade.data.Endpoint

getChangeset() - Method in class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

getCityName() - Method in enum org.codeforamerica.open311.facade.City

getCode() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getCode() - Method in class org.codeforamerica.open311.facade.exceptions.GeoReportV2Error

getContact() - Method in class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

getDatatype() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getDatatypeDescription() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getDescription() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getDescription() - Method in class org.codeforamerica.open311.facade.data.Service

getDescription() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getDescription() - Method in class org.codeforamerica.open311.facade.exceptions.GeoReportV2Error

getDescription() - Method in enum org.codeforamerica.open311.facade.Format

getDiscoveryUrl() - Method in enum org.codeforamerica.open311.facade.City

getEndpoints() - Method in class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

getEndpointUrl() - Method in class org.codeforamerica.open311.facade.APIWrapper

getError() - Method in exception org.codeforamerica.open311.facade.exceptions.APIWrapperException

getExpectedDatetime() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getFromHTTPContentTypeString(String) - Static method in enum org.codeforamerica.open311.facade.Format

Builds an instance from the content type.

getFromString(String) - Static method in enum org.codeforamerica.open311.facade.data.AttributeInfo.Datatype

Returns an instance of this class from a given string.

getFromString(String) - Static method in enum org.codeforamerica.open311.facade.data.Service.Type

Returns an instance of this class from a given string.

getFromString(String) - Static method in enum org.codeforamerica.open311.facade.data.ServiceRequest.Status

getFromString(String) - Static method in enum org.codeforamerica.open311.facade.EndpointType

Builds an instance from a string.

getGeoReportError() - Method in exception org.codeforamerica.open311.facade.exceptions.APIWrapperException

getGroup() - Method in class org.codeforamerica.open311.facade.data.Service

getHTTPContentType() - Method in enum org.codeforamerica.open311.facade.Format

getInstance() - Static method in class org.codeforamerica.open311.facade.data.RelationshipManager

getInstance(Context) - Static method in class org.codeforamerica.open311.internals.caching.AndroidCache

Returns the unique instance of the class.

getInstance() - Static method in class org.codeforamerica.open311.internals.caching.RegularJavaCache

Returns the unique instance of the class.

getInstance() - Static method in class org.codeforamerica.open311.internals.logging.LogManager

Returns the unique instance of the class.

getInstance() - Static method in class org.codeforamerica.open311.internals.parsing.DataParserFactory

getInstance() - Static method in class org.codeforamerica.open311.internals.platform.PlatformManager

Returns the unique instance of the class.

getJurisdictionId() - Method in enum org.codeforamerica.open311.facade.City

getKeyService() - Method in class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

getKeywords() - Method in class org.codeforamerica.open311.facade.data.Service

getKeywords(String) - Method in class org.codeforamerica.open311.internals.parsing.AbstractParser

Parses a comma separated list of keywords.

getLatitude() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getLongitude() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getMediaUrl() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getMoreSuitableEndpoint(EndpointType) - Method in class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

Searches through the list of endpoints and tries to find a valid endpoint of the given type.

getObject() - Method in class org.codeforamerica.open311.internals.caching.CacheableObject

getOptionalParametersMap() - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

Builds a map containing all the set arguments.

getOrder() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getProperty(String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

Retrieves a property.

getProperty(String) - Method in class org.codeforamerica.open311.internals.caching.AndroidCache

getProperty(String) - Method in class org.codeforamerica.open311.internals.caching.RegularJavaCache

getRequestedDatetime() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getSerialversionuid() - Static method in exception org.codeforamerica.open311.facade.exceptions.APIWrapperException

getServiceCode() - Method in class org.codeforamerica.open311.facade.data.Service

getServiceCode() - Method in class org.codeforamerica.open311.facade.data.ServiceDefinition

getServiceCode() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getServiceDefinition(String) - Method in class org.codeforamerica.open311.facade.APIWrapper

Gets the service definition of a concrete service.

getServiceDefinition() - Method in class org.codeforamerica.open311.facade.data.Service

Retrieves the ServiceDefinition of this instance.

getServiceList() - Method in class org.codeforamerica.open311.facade.APIWrapper

Gets a list of services from the endpoint.

getServiceName() - Method in class org.codeforamerica.open311.facade.data.Service

getServiceName() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getServiceNotice() - Method in class org.codeforamerica.open311.facade.data.POSTServiceRequestResponse

getServiceNotice() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getServiceRequest(String) - Method in class org.codeforamerica.open311.facade.APIWrapper

GET Service Request operation.

getServiceRequestId() - Method in class org.codeforamerica.open311.facade.data.POSTServiceRequestResponse

getServiceRequestId() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getServiceRequestId() - Method in class org.codeforamerica.open311.facade.data.ServiceRequestIdResponse

getServiceRequestIdFromToken(String) - Method in class org.codeforamerica.open311.facade.APIWrapper

This function is useful when the POST Service Request returns a token.

getServiceRequests(GETServiceRequestsFilter) - Method in class org.codeforamerica.open311.facade.APIWrapper

Retrieves all the service requests which accord to the given data.

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

Useful to pass optional parameters to the getServiceRequests(GETServiceRequestsFilter) operation.

GETServiceRequestsFilter() - Constructor for class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

getSpecificationUrl() - Method in class org.codeforamerica.open311.facade.data.Endpoint

getStatus() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getStatusNotes() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getToken() - Method in class org.codeforamerica.open311.facade.data.POSTServiceRequestResponse

getToken() - Method in class org.codeforamerica.open311.facade.data.ServiceRequestIdResponse

getType() - Method in class org.codeforamerica.open311.facade.data.Endpoint

getType() - Method in class org.codeforamerica.open311.facade.data.Service

getUpdatedDatetime() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

getUrl() - Method in class org.codeforamerica.open311.facade.data.Endpoint

getValues() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

getWrapperInfo() - Method in class org.codeforamerica.open311.facade.APIWrapper

Returns a string with some info.

getZipCode() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

H

hasMetadata() - Method in class org.codeforamerica.open311.facade.data.Service

HTTPNetworkManager - Class in org.codeforamerica.open311.internals.network

Implementation using the Apache HttpComponents library.

HTTPNetworkManager(Format) - Constructor for class org.codeforamerica.open311.internals.network.HTTPNetworkManager

I

InvalidValueError - Error in org.codeforamerica.open311.facade.exceptions

Will be thrown if one given argument has an incorrect value.

InvalidValueError(String) - Constructor for error org.codeforamerica.open311.facade.exceptions.InvalidValueError

InvalidXMLWrapper - Class in org.codeforamerica.open311.facade

Some endpoints return invalid characters in its XML response.

isCompatibleWithFormat(Format) - Method in class org.codeforamerica.open311.facade.data.Endpoint

Returns whether it allows the given format or not.

isRequired() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

isVariable() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

J

JSONParser - Class in org.codeforamerica.open311.internals.parsing

Implementation of a DataParser which takes JSON data as input.

JSONParser() - Constructor for class org.codeforamerica.open311.internals.parsing.JSONParser

K

KEY_SERVICE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

KEY_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

KEYWORDS_SEPARATOR - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

KEYWORDS_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

L

LAST_NAME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

LATITUDE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

logError(String) - Method in class org.codeforamerica.open311.internals.logging.AndroidLogger

logError(String) - Method in interface org.codeforamerica.open311.internals.logging.Logger

Logs an error.

logError(Object, String) - Method in class org.codeforamerica.open311.internals.logging.LogManager

Logs any problem.

logError(String) - Method in class org.codeforamerica.open311.internals.logging.RegularJavaLogger

Logger - Interface in org.codeforamerica.open311.internals.logging

Defines all the required operations to log events in the library.

logInfo(String) - Method in class org.codeforamerica.open311.internals.logging.AndroidLogger

logInfo(String) - Method in interface org.codeforamerica.open311.internals.logging.Logger

Logs a non-critical event.

logInfo(Object, String) - Method in class org.codeforamerica.open311.internals.logging.LogManager

Logs a non-critical event.

logInfo(String) - Method in class org.codeforamerica.open311.internals.logging.RegularJavaLogger

LogManager - Class in org.codeforamerica.open311.internals.logging

Manages all the login related operations.

LONGITUDE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

M

MEDIA_URL_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

METADATA_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

MockNetworkManager - Class in org.codeforamerica.open311.internals.network

Mock NetworkManager, useful for testing.

MockNetworkManager() - Constructor for class org.codeforamerica.open311.internals.network.MockNetworkManager

MultiValueAttribute - Class in org.codeforamerica.open311.facade.data

Multi valued attribute useful for the POST Service Request operation.

MultiValueAttribute(String, String...) - Constructor for class org.codeforamerica.open311.facade.data.MultiValueAttribute

N

NAME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

networkGet(URL) - Method in class org.codeforamerica.open311.facade.APIWrapper

Tries to perform an HTTP GET operation and returns the result.

networkGet(URL) - Method in class org.codeforamerica.open311.facade.InvalidXMLWrapper

GET operation.

NetworkManager - Interface in org.codeforamerica.open311.internals.network

Specifies the required operations of a NetworkManager

networkPost(URL, Map<String, String>) - Method in class org.codeforamerica.open311.facade.APIWrapper

Tries to perform an HTTP POST operation and returns the result.

networkPost(URL, Map<String, String>) - Method in class org.codeforamerica.open311.facade.InvalidXMLWrapper

POST operation.

NoCache - Class in org.codeforamerica.open311.internals.caching

This class is a special implementation of the Cache interface which is useful if you don't want to do caching.

NoCache() - Constructor for class org.codeforamerica.open311.internals.caching.NoCache

O

ORDER_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

org.codeforamerica.open311.facade - package org.codeforamerica.open311.facade

Visible part of the system.

org.codeforamerica.open311.facade.data - package org.codeforamerica.open311.facade.data

Visible data objects of the system.

org.codeforamerica.open311.facade.data.operations - package org.codeforamerica.open311.facade.data.operations

Data objects related to some operations of the system.

org.codeforamerica.open311.facade.exceptions - package org.codeforamerica.open311.facade.exceptions

Exceptions of the system.

org.codeforamerica.open311.internals.caching - package org.codeforamerica.open311.internals.caching

Operations caching related functionality.

org.codeforamerica.open311.internals.logging - package org.codeforamerica.open311.internals.logging

org.codeforamerica.open311.internals.network - package org.codeforamerica.open311.internals.network

Network-related functionality of the library.

org.codeforamerica.open311.internals.parsing - package org.codeforamerica.open311.internals.parsing

Parsing-related functionality of the library.

org.codeforamerica.open311.internals.platform - package org.codeforamerica.open311.internals.platform

P

parseDate(String) - Method in class org.codeforamerica.open311.internals.parsing.DateParser

Parses a string representing a date.

parseGeoReportV2Errors(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses an error and returns an object with its information.

parseGeoReportV2Errors(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseGeoReportV2Errors(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parsePostServiceRequestResponse(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses the response of a POST Service Request operation.

parsePostServiceRequestResponse(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parsePostServiceRequestResponse(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parseServiceDefinition(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses a service definition.

parseServiceDefinition(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseServiceDefinition(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parseServiceDiscovery(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses a service discovery and returns an object with its information.

parseServiceDiscovery(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseServiceDiscovery(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parseServiceList(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses the response to the GET service list operation.

parseServiceList(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseServiceList(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parseServiceRequestIdFromAToken(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses the response to the GET service request id from a token.

parseServiceRequestIdFromAToken(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseServiceRequestIdFromAToken(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

parseServiceRequests(String) - Method in interface org.codeforamerica.open311.internals.parsing.DataParser

Parses a list of service requests.

parseServiceRequests(String) - Method in class org.codeforamerica.open311.internals.parsing.JSONParser

parseServiceRequests(String) - Method in class org.codeforamerica.open311.internals.parsing.XMLParser

PHONE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

PlatformManager - Class in org.codeforamerica.open311.internals.platform

Builds some objects which implementation depends of the execution environment.

POST_CONTENT_TYPE - Static variable in interface org.codeforamerica.open311.internals.network.NetworkManager

postServiceRequest(POSTServiceRequestData) - Method in class org.codeforamerica.open311.facade.APIWrapper

Performs a POST Service Request operation.

POSTServiceRequestData - Class in org.codeforamerica.open311.facade.data.operations

Contains all the necessary data to add a new service request to the server.

POSTServiceRequestData(String, float, float, List<Attribute>) - Constructor for class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Builds a POST service request data object from a lat & long location value.

POSTServiceRequestData(String, String, List<Attribute>) - Constructor for class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Builds a POST service request data object from an address location value.

POSTServiceRequestData(String, long, List<Attribute>) - Constructor for class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Builds a POST service request data object from an address_id location value.

POSTServiceRequestResponse - Class in org.codeforamerica.open311.facade.data

Wraps a POST service request response.

POSTServiceRequestResponse(String, String, String, String) - Constructor for class org.codeforamerica.open311.facade.data.POSTServiceRequestResponse

postServiceRequestResponseJSON() - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

Mock post service request response.

postServiceRequestResponseXML() - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

Mock post service request response.

printDate(Date) - Method in class org.codeforamerica.open311.internals.parsing.DateParser

Prints a date.

R

RegularJavaCache - Class in org.codeforamerica.open311.internals.caching

Basic implementation of the Cache interface.

RegularJavaLogger - Class in org.codeforamerica.open311.internals.logging

Default implementation of the Logger interface.

RegularJavaLogger() - Constructor for class org.codeforamerica.open311.internals.logging.RegularJavaLogger

RelationshipManager - Class in org.codeforamerica.open311.facade.data

This class maintains a map between APIWrapper and Service instances.

REQUESTED_DATETIME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

REQUIRED_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

retrieveCachedServiceDefinition(String, String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCachedServiceDefinition(String, String) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for a cached service definition.

retrieveCachedServiceDefinition(String, String) - Method in class org.codeforamerica.open311.internals.caching.NoCache

retrieveCachedServiceDiscoveryInfo(City) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCachedServiceDiscoveryInfo(City) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for the service discovery of a given city in the local cache.

retrieveCachedServiceDiscoveryInfo(City) - Method in class org.codeforamerica.open311.internals.caching.NoCache

retrieveCachedServiceList(String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCachedServiceList(String) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for a cached list of services.

retrieveCachedServiceList(String) - Method in class org.codeforamerica.open311.internals.caching.NoCache

retrieveCachedServiceRequest(String, String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCachedServiceRequest(String, String) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for a cached GET service request response.

retrieveCachedServiceRequest(String, String) - Method in class org.codeforamerica.open311.internals.caching.NoCache

retrieveCachedServiceRequests(String, GETServiceRequestsFilter) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCachedServiceRequests(String, GETServiceRequestsFilter) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for a cached GET service requests response.

retrieveCachedServiceRequests(String, GETServiceRequestsFilter) - Method in class org.codeforamerica.open311.internals.caching.NoCache

retrieveCitiesInfo() - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

retrieveCitiesInfo() - Method in interface org.codeforamerica.open311.internals.caching.Cache

Looks for the endpoints-service discovery relationships.

retrieveCitiesInfo() - Method in class org.codeforamerica.open311.internals.caching.NoCache

S

saveCitiesInfo(String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveCitiesInfo(String) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves the endpoints-service discovery relationships.

saveCitiesInfo(String) - Method in class org.codeforamerica.open311.internals.caching.NoCache

saveListOfServices(String, List<Service>) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveListOfServices(String, List<Service>) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves a list of Service objects related to an endpoint.

saveListOfServices(String, List<Service>) - Method in class org.codeforamerica.open311.internals.caching.NoCache

saveProperty(String, String) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

Saves a property.

saveProperty(String, String) - Method in class org.codeforamerica.open311.internals.caching.AndroidCache

saveProperty(String, String) - Method in class org.codeforamerica.open311.internals.caching.RegularJavaCache

saveServiceDefinition(String, String, ServiceDefinition) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveServiceDefinition(String, String, ServiceDefinition) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves a service definition.

saveServiceDefinition(String, String, ServiceDefinition) - Method in class org.codeforamerica.open311.internals.caching.NoCache

saveServiceDiscovery(City, ServiceDiscoveryInfo) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveServiceDiscovery(City, ServiceDiscoveryInfo) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves a object related to a city.

saveServiceDiscovery(City, ServiceDiscoveryInfo) - Method in class org.codeforamerica.open311.internals.caching.NoCache

saveServiceRequestList(String, GETServiceRequestsFilter, List<ServiceRequest>) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveServiceRequestList(String, GETServiceRequestsFilter, List<ServiceRequest>) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves a list of service requests.

saveServiceRequestList(String, GETServiceRequestsFilter, List<ServiceRequest>) - Method in class org.codeforamerica.open311.internals.caching.NoCache

saveSingleServiceRequest(String, String, ServiceRequest) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

saveSingleServiceRequest(String, String, ServiceRequest) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Saves a service request.

saveSingleServiceRequest(String, String, ServiceRequest) - Method in class org.codeforamerica.open311.internals.caching.NoCache

serialize() - Method in class org.codeforamerica.open311.internals.caching.CacheableObject

Return a serialized version of the object.

serialize(Serializable) - Static method in class org.codeforamerica.open311.internals.caching.CacheableObject

Service - Class in org.codeforamerica.open311.facade.data

Represents a GeoReport service.

Service(String, String, String, Boolean, Service.Type, String[], String) - Constructor for class org.codeforamerica.open311.facade.data.Service

Service.Type - Enum in org.codeforamerica.open311.facade.data

Different types of Service.

SERVICE_CODE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_DEFINITION_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_GROUP_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_NAME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_NOTICE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_REQUEST_ID_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_REQUEST_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_REQUESTS_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

SERVICE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

ServiceDefinition - Class in org.codeforamerica.open311.facade.data

Represents a service definition.

ServiceDefinition(String, List<AttributeInfo>) - Constructor for class org.codeforamerica.open311.facade.data.ServiceDefinition

ServiceDiscoveryInfo - Class in org.codeforamerica.open311.facade.data

Contains information regarding to a city (endpoints, allowed formats...).

ServiceDiscoveryInfo(Date, String, String, List<Endpoint>) - Constructor for class org.codeforamerica.open311.facade.data.ServiceDiscoveryInfo

ServiceRequest - Class in org.codeforamerica.open311.facade.data

Represents a Service Request.

ServiceRequest(String, ServiceRequest.Status, String, String, String, String, String, String, Date, Date, Date, String, Long, Integer, Float, Float, URL) - Constructor for class org.codeforamerica.open311.facade.data.ServiceRequest

ServiceRequest.Status - Enum in org.codeforamerica.open311.facade.data

ServiceRequestIdResponse - Class in org.codeforamerica.open311.facade.data

Represents an answer to the GET service id from a token.

ServiceRequestIdResponse(String, String) - Constructor for class org.codeforamerica.open311.facade.data.ServiceRequestIdResponse

setAccountId(long) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets an account_id.

setAddress(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets an address parameter.

setAddressId(long) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets an address_id parameter.

setApiKey(String) - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

Sets the api key.

setCache(Cache) - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

Sets a desired cache system.

setCustomTimeToLive(Cache.CacheableOperation, int) - Method in class org.codeforamerica.open311.internals.caching.AbstractCache

setCustomTimeToLive(Cache.CacheableOperation, int) - Method in interface org.codeforamerica.open311.internals.caching.Cache

Set a custom time to live to a given operation.

setCustomTimeToLive(Cache.CacheableOperation, int) - Method in class org.codeforamerica.open311.internals.caching.NoCache

setDescription(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets a description.

setDeviceId(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets a device_id.

setEmail(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets an email.

setEndDate(Date) - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

setFirstName(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets the first_name.

setFormat(Format) - Method in class org.codeforamerica.open311.facade.APIWrapper

Updates the format of the wrapper.

setFormat(Format) - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

Selects the desired data exchange format.

setFormat(Format) - Method in class org.codeforamerica.open311.internals.network.HTTPNetworkManager

setFormat(Format) - Method in class org.codeforamerica.open311.internals.network.MockNetworkManager

setFormat(Format) - Method in interface org.codeforamerica.open311.internals.network.NetworkManager

Sets the desired format of the requests.

setLastName(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets the last_name.

setLatLong(float, float) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets a (latitude, longitude) coordinates.

setMediaUrl(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets a media URL.

setNetworkManager(NetworkManager) - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

Sets a custom NetworkManager, useful if you need to use mocks or a platform-dependent network client which you can build implementing the NetworkManager interface.

setPhone(String) - Method in class org.codeforamerica.open311.facade.data.operations.POSTServiceRequestData

Sets the phone.

setServiceCode(String) - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

setServiceRequestId(String) - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

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

setStartDate(Date) - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

setStatus(ServiceRequest.Status) - Method in class org.codeforamerica.open311.facade.data.operations.GETServiceRequestsFilter

SingleValueAttribute - Class in org.codeforamerica.open311.facade.data

Single valued attribute useful for the POST Service Request operation.

SingleValueAttribute(String, String) - Constructor for class org.codeforamerica.open311.facade.data.SingleValueAttribute

SPECIFICATION_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

START_DATE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

STATUS_NOTES_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

STATUS_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

T

TAG - Static variable in interface org.codeforamerica.open311.internals.logging.Logger

TEXT_FORMAT - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

TOKEN_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

toString() - Method in class org.codeforamerica.open311.facade.APIWrapper

toString() - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

toString() - Method in class org.codeforamerica.open311.facade.data.AttributeInfo

Returns a string of the form ATTRIBUTE[key1][key2]...[keyN]=value1, value2,...valueN.

toString() - Method in class org.codeforamerica.open311.facade.data.Service

toString() - Method in enum org.codeforamerica.open311.facade.data.ServiceRequest.Status

toString() - Method in class org.codeforamerica.open311.facade.data.ServiceRequest

toString() - Method in enum org.codeforamerica.open311.facade.exceptions.APIWrapperException.Error

toString() - Method in exception org.codeforamerica.open311.facade.exceptions.APIWrapperException

toString() - Method in class org.codeforamerica.open311.facade.exceptions.GeoReportV2Error

toString() - Method in enum org.codeforamerica.open311.facade.Format

TYPE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

U

UPDATED_DATETIME_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

URL_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

URLBuilder - Class in org.codeforamerica.open311.internals.network

Builds the necessary URLs to communicate with the endpoints.

URLBuilder(String, String, String) - Constructor for class org.codeforamerica.open311.internals.network.URLBuilder

V

VALUE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.City

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.data.AttributeInfo.Datatype

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.data.Service.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.data.ServiceRequest.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.EndpointType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.exceptions.APIWrapperException.Error

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.facade.Format

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codeforamerica.open311.internals.caching.Cache.CacheableOperation

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.codeforamerica.open311.facade.City

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.data.AttributeInfo.Datatype

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.data.Service.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.data.ServiceRequest.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.EndpointType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.exceptions.APIWrapperException.Error

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.facade.Format

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codeforamerica.open311.internals.caching.Cache.CacheableOperation

Returns an array containing the constants of this enum type, in the order they are declared.

VALUES_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

VARIABLE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

W

withLogs() - Method in class org.codeforamerica.open311.facade.APIWrapperFactory

The built instance will be logged.

withTimezone(DateTimeZone) - Method in class org.codeforamerica.open311.internals.parsing.DateParser

Sets the timezone of the system.

X

XMLParser - Class in org.codeforamerica.open311.internals.parsing

Parses XML files using DOM.

XMLParser() - Constructor for class org.codeforamerica.open311.internals.parsing.XMLParser

Creates an instance of an XMLParser creating a DocumentBuilder.

Z

ZIPCODE_TAG - Static variable in interface org.codeforamerica.open311.internals.parsing.DataParser

A B C D E F G H I J K L M N O P R S T U V W X Z