/* 
 * E-XML Library:  For XML, XML-RPC, HTTP, and related.
 * Copyright (C) 2002-2008  Elias Ross
 * 
 * genman@noderunner.net
 * http://noderunner.net/~genman
 * 
 * 1025 NE 73RD ST
 * SEATTLE WA 98115
 * USA
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * $Id$
 */

package net.noderunner.xmlrpc.example;

/**
 * This interface is used for provisioning names in a database.
 */
public interface ProvisioningInterface {

	String INTERFACE_NAME = "ProvisioningInterface";

	/**
	 * Add subscribers.
	 * @param s interator containing instances of <code>Subscriber</code>
	 * objects.
	 * @return failures, if existant
	 * @throws ProvException if the subscriber could not be added.
	 */
	ProvIterator addSubscribers(ProvIterator i)
		throws ProvException;

	/**
	 * Deletes subscribers by name.
	 * @param u interator containing instances of <code>Subscriber</code>
	 * objects.
	 * @return failures, if existant
	 * @throws ProvException if the subscriber could not be deleted.
	 */
	ProvIterator deleteSubscribers(ProvIterator i)
		throws ProvException;

	/**
	 * Finds matching subscribers.  <code>ProvIterator</code> contains a list
	 * of names, which are instances of <code>Subscriber</code> objects.
	 * @param ss refer to <code>SubscriberSearch</code> for matching names
	 * @return matching names
	 * @throws ProvException if the names could not be retrieved
	 */
	ProvIterator findSubscribers(SubscriberSearch ss)
		throws ProvException;
}
