// 
// Copyright (c) 2004, Caltha - Gajda, Krzewski, Mach, Potempski Sp.J. 
// All rights reserved. 
// 
// 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 Caltha - Gajda, Krzewski, Mach, Potempski Sp.J.  
//       nor the names of its contributors may be used to endorse or promote products  
//       derived from this software without specific prior written permission. 
// 
// 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 MERCHANTABILITY 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 net.cyklotron.cms.category;

import org.objectledge.coral.store.Resource;

import net.cyklotron.cms.CmsNodeResource;
import net.cyklotron.cms.SeeableResource;
import net.cyklotron.cms.link.BaseLinkResource;

/**
 * Defines the accessor methods of <code>category.category</code> Coral resource class.
 *
 * @author Coral Maven plugin
 */
public interface CategoryResource
    extends Resource, CmsNodeResource, SeeableResource
{
    // constants /////////////////////////////////////////////////////////////

    /** The name of the Coral resource class. */    
    public static final String CLASS_NAME = "category.category";

    // public interface //////////////////////////////////////////////////////
 
    /**
     * Returns the value of the <code>link</code> attribute.
     *
     * @return the value of the the <code>link</code> attribute.
     */
    public BaseLinkResource getLink();

    /**
     * Sets the value of the <code>link</code> attribute.
     *
     * @param value the value of the <code>link</code> attribute,
     *        or <code>null</code> to remove value.
     */
    public void setLink(BaseLinkResource value);   
   
	/**
	 * Checks if the value of the <code>link</code> attribute is defined.
	 *
	 * @return <code>true</code> if the value of the <code>link</code> attribute is defined.
	 */
    public boolean isLinkDefined();
 
    /**
     * Returns the value of the <code>uiStyle</code> attribute.
     *
     * @return the value of the the <code>uiStyle</code> attribute.
     */
    public String getUiStyle();

    /**
     * Sets the value of the <code>uiStyle</code> attribute.
     *
     * @param value the value of the <code>uiStyle</code> attribute,
     *        or <code>null</code> to remove value.
     */
    public void setUiStyle(String value);   
   
	/**
	 * Checks if the value of the <code>uiStyle</code> attribute is defined.
	 *
	 * @return <code>true</code> if the value of the <code>uiStyle</code> attribute is defined.
	 */
    public boolean isUiStyleDefined();
  
    // @custom methods ///////////////////////////////////////////////////////
}