/* this belongs to the WebRaveler package */
package webraveler.vurl;

import java.io.*;


import webraveler.http.HTTPRequest;
import webraveler.http.HTTPResponse;
import webraveler.ravel.Raveler;

/**
 * Models a VURL.
 *
 * @author The Web Raveler Development Squad
 * @version 1.0
 */
public interface VURL extends Serializable {

  /**
   * Returns the HTTP response associated with the given virtual
   * URL.  
   *
   * @param username a string containing the current user's name
   * @param query a string containing any available query on the VURL
   * @param request an HTTPRequest containing the HTTP request for the virtual url
   * @param ravel a Raveler instance
   * @return an HTTPResponse containing the content to return to the client
   */
  public HTTPResponse resolveVURL(String username, String query, HTTPRequest request, Raveler ravel);
}