/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XChainable_idl__ 
#define __com_sun_star_util_XChainable_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** enables the object to be a member of a chain.
 */
published interface XChainable: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
    /** @returns 
                the previous object in this chain or NULL, if this is the first  
                object of this chain.
     */
    com::sun::star::util::XChainable getPredecessor(); 
 
    //------------------------------------------------------------------------- 
    /** @returns 
                the next object in this chain or NULL, if this is the last  
                object in this chain.
     */
    com::sun::star::util::XChainable getSuccessor(); 
 
    //------------------------------------------------------------------------- 
    /** connects the specified object to this object as the successor in a chain. 
        
        <p>This implies that this object will become the predecessor of 
        <var>xChainable</var>.  </p>
     */
    void setSuccessor( [in] com::sun::star::util::XChainable xChainable ) 
            raises( com::sun::star::lang::IllegalArgumentException ); 
 
    //------------------------------------------------------------------------- 
    /** checks if the specified object can be linked to this.
     */
    boolean isChainable( [in] com::sun::star::util::XChainable xChainable ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 
