org.intabulas.sandler.introspection.Introspection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sandler Show documentation
A java tookit for generating and processing Atom messages
The newest version!
/**
 * Copyright (c) 2003-2004, Mark Lussier
 * All rights reserved.
 *
 * Portions Copyright (c) 2003 by David A. Czarnecki
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 * 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.
 * Neither the name of the "Mark Lussier" and "Sandler" nor the names of
 * its contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * Products derived from this software may not be called "Sandler",
 * nor may "Sandler" appear in their name, without prior written permission of
 * Mark Lussier
 *
 * 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
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE COPYRIGHT OWNER 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.intabulas.sandler.introspection;

/**
 * Introspection
 * 
 * @author Mark Lussier
 * @version $Id: Introspection.java,v 1.3 2004/01/02 01:43:57 intabulas Exp $
 */
public interface Introspection {

    public static final String ELEMENT_INTROSPECTION = "introspection";
    public static final String ELEMENT_CREATEENTRY = "create-entry";
    public static final String ELEMENT_SEARCHENTRY = "search-entries";

    /**
     * Set's the Search URL to return whn an Introspection Query is made
     * 
     * @param url a String representing the Search Entries URL
     */
    void setSearchUrl(String url);

    /**
     * Returns the Search URL used in  an Introspection Query is made
     * 
     * @return a String representing the Search Entries URL
     */
    String getSearchUrl();

    /**
     * Set's the Create URL to return whn an Introspection Query is made
     * 
     * @param url a String representing the Create Entries URL
     */
    void setCreateUrl(String url);

    /**
     * Returns the Create URL used in  an Introspection Query is made
     * 
     * @return a String representing the Create Entries URL
     */
    String getCreateUrl();

}