com.afrigis.services.search.extension.intiendoLS.api2.params.PostalCodeParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of search-extension Show documentation

Search extensions for API's such as Census and Postal Codes

The newest version!

package com.afrigis.services.search.extension.intiendoLS.api2.params;

import com.afrigis.services.Response;
import com.afrigis.services.search.extension.PostalCodeGetType;
import com.afrigis.services.search.extension.impl.PostalCodeResponseDownloadImpl;
import com.afrigis.services.search.extension.impl.PostalCodeResponseImpl;

/**
 * 
 * Object contains service specific parameters for Postal Code service call
 * 
 *
 * @author Takalani
 */
public class PostalCodeParams extends SeoidLatLongAbstractParams {

    /**
     * 
     * Specify what kind of report to pull from the service call, JSON or PDF(in
     * the form of byte array)
     * 
     */
    private PostalCodeGetType postalCodeGetType;

    public void setPostalCodeGetType(PostalCodeGetType postalCodeGetType) {
        this.postalCodeGetType = postalCodeGetType;
    }

    public PostalCodeGetType getPostalCodeGetType() {
        return this.postalCodeGetType;
    }

    /**
     * 
     * Get postal code report using seoid
     * 
     *
     * @param email AfriGIS service client email making service call
     * @param seoid location identifier
     * @param postalCodeGetType get JSON or PDF report
     */
    public PostalCodeParams(String email, String seoid, PostalCodeGetType postalCodeGetType) {
        super(email, seoid);
        this.postalCodeGetType = postalCodeGetType;
    }

    /**
     *
     * 
     * Get postal code report using latitude and longitude
     * 
     *
     * @param email AfriGIS service client email making service call
     * @param latitude identify location
     * @param longitude identify location
     * @param postalCodeGetType get JSON or PDF report
     */
    public PostalCodeParams(String email, String latitude, String longitude, PostalCodeGetType postalCodeGetType) {
        super(email, latitude, longitude);
        this.postalCodeGetType = postalCodeGetType;
    }

    /**
     * 
     * Service to call, this based on postalCodeGetType
     * 
     *
     * @return String service to call
     */
    @Override
    public String getServiceName() {
        return postalCodeGetType.toString();
    }

    @Override
    public Class getResponseType() {
        return postalCodeGetType == PostalCodeGetType.JSON ? PostalCodeResponseImpl.class : PostalCodeResponseDownloadImpl.class;
    }

}