/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the "License").  You may not use this file except
 * in compliance with the License.
 *
 * You can obtain a copy of the license at
 * http://www.opensource.org/licenses/cddl1.php
 * See the License for the specific language governing
 * permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * HEADER in each file and include the License file at
 * http://www.opensource.org/licenses/cddl1.php.  If 
 * applicable, add the following below this CDDL HEADER, 
 * with the fields enclosed by brackets "[]" replaced 
 * with your own identifying information: 
 * Portions Copyright [yyyy]
 * [name of copyright owner]
 */ 

/*
 * $(@)TopologyManager.java $Revision: 1.1.1.1 $ $Date: 2006/03/15 13:12:10 $
 * 
 * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
 */
/**

 *

 * @version: 1.0

 * @date: Jan 28, 2003

 *

 */

package com.sun.sjc.idtv.vod.server.topologymanager;



import java.util.*;

import java.sql.*;

import javax.ejb.EJBObject;

import java.rmi.RemoteException;



import com.sun.sjc.idtv.vod.shared.data.*;



/**

 * Remote interface for the <code>TopologyManagerBean</code>. The remote interface, <code>TopologyManager</code>

 * defines all possible business methods for the bean.

 *

 * @see TopologyManagerHome

 * @see TopologyManagerBean

 */

public interface TopologyManager extends EJBObject {

 

    /**

     * Allocate QAM resources for a particular CPE

     * @param cpeId customer premise equiment id

     * @return qam resource: qam ip, port, tsid, rf channel

     * @exception RemoteException

     */

   public QamResource allocate(String cpeId) throws RemoteException,

   SQLException;



    /**

     * Free QAM resources for a particular CPE

     * @param cpeId customer premise equiment id

     * @return true if ok, false if an exception occured

     * @exception RemoteException

     */

   public boolean release(String cpeId) throws RemoteException, SQLException;



   /**

    * Allocate IP resource for a particular CPE

    * @param cpeId (customer premise equipment id)

    * @return IPResource: server ip

    * @exception RemoteException 

    */

   public IpResource allocateIpResource(String cpeId, String serverIp) throws RemoteException,

   SQLException;



   /**

    * Releasing IP resource for a particular CPE

    * @param cpeId (customer premise equipment id)

    * @return boolean 

    * @exception RemoteException 

    */

   public boolean releaseIpResource(String cpeId) throws RemoteException,

   SQLException;



}