org.nhindirect.config.service.AddressService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-service-jar Show documentation
NHIN Direct Java RI config service jar.
There is a newer version: 8.0.5
/* 
Copyright (c) 2010, NHIN Direct Project
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer 
   in the documentation and/or other materials provided with the distribution.  
3. Neither the name of the The NHIN Direct Project (nhindirect.org) nor the names of its contributors may be used to endorse or promote 
   products derived from this software without specific prior written permission.
   
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS 
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.nhindirect.config.service;

import java.util.Collection;

import javax.jws.WebMethod;
import javax.jws.WebParam;

import org.nhindirect.config.store.Address;
import org.nhindirect.config.store.EntityStatus;

/**
 * Service class for methods related to an Address object.
 */
public interface AddressService {

    /**
     * Add an Address.
     * 
     * @param address
     *            The Address to add.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "addAddress", action = "urn:AddAddress")
    void addAddress(@WebParam(name = "address") Collection address) throws ConfigurationServiceException;

    /**
     * Update an Address.
     * 
     * @param address
     *            The Address to update.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "updateAddress", action = "urn:UpdateAddress")
    void updateAddress(@WebParam(name = "address") Address address) throws ConfigurationServiceException;;

    /**
     * Get a count of Addresses.
     * 
     * @return a count of Addresses.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getAddressCount", action = "urn:GetAddressCount")
    int getAddressCount() throws ConfigurationServiceException;;

    /**
     * Get a collection of all Addresses matching the parameters.
     * 
     * @param addressNames
     *            A collection of address names.
     * @param status
     *            An EntityStatus object.
     * @return a collection of all Addresses matching the parameters.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "getAddresss", action = "urn:GetAddresss")
    Collection getAddress(@WebParam(name = "emailAddress") Collection addressNames,
            @WebParam(name = "status") EntityStatus status) throws ConfigurationServiceException;;

    /**
     * Remove an Address.
     * 
     * @param addressName
     *            The address name.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "removeAddress", action = "urn:RemoveAddress")
    void removeAddress(@WebParam(name = "emailAddress") String addressName) throws ConfigurationServiceException;;

    /**
     * Return a list of Addresses matching the parameters.
     * 
     * @param lastAddressName
     *            The last address name.
     * @param maxResults
     *            The maximum number of results.
     * @return a list of Addresses matching the parameters.
     * @throws ConfigurationServiceException
     */
    @WebMethod(operationName = "listAddresss", action = "urn:ListAddresss")
    Collection listAddresss(@WebParam(name = "lastEmailAddress") String lastAddressName,
            @WebParam(name = "maxResults") int maxResults) throws ConfigurationServiceException;;
}