001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.shared;
029
030/**
031 * Interface defining the data used to call a content collector.<p>
032 */
033public interface I_CmsContentLoadCollectorInfo {
034
035    /**
036     * Returns the collector name.<p>
037     *
038     * @return the collector name
039     */
040    public String getCollectorName();
041
042    /**
043     * Returns the collectorParams.<p>
044     *
045     * @return the collectorParams
046     */
047    public String getCollectorParams();
048
049    /**
050     * Sets the collectorName.<p>
051     *
052     * @param collectorName the collectorName to set
053     */
054    public void setCollectorName(String collectorName);
055
056    /**
057     * Sets the collectorParams.<p>
058     *
059     * @param collectorParams the collectorParams to set
060     */
061    public void setCollectorParams(String collectorParams);
062
063    /** Returns the fully qualified class name of the used collector. It has to be specified only if the collector name is not set.
064     * @return the fully qualified class name of the used collector.
065     */
066    String getCollectorClass();
067
068    /**
069     * Gets the id.<p>
070     *
071     * @return the id
072     */
073    String getId();
074
075    /** Sets the class name to identify the collector implementation.
076     * @param className the fully qualified class name.
077     */
078    void setCollectorClass(String className);
079
080    /**
081     * Sets the id.<p>
082     *
083     * @param id the id
084     */
085    void setId(String id);
086
087}