Files
alfresco-community-repo/source/java/org/alfresco/web/bean/wizard/IWizardBean.java
Paul Holmes-Higgin 7fd19e7e88 Updated copyright
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5186 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2007-02-19 17:17:36 +00:00

89 lines
2.8 KiB
Java

/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.web.bean.wizard;
import org.alfresco.web.bean.dialog.IDialogBean;
/**
* Interface that defines the contract for a wizard backing bean
*
* @author gavinc
*/
public interface IWizardBean extends IDialogBean
{
/**
* Called when the next button is pressed by the user
*
* @return Reserved for future use
*/
public String next();
/**
* Called when the back button is pressed by the user
*
* @return Reserved for future use
*/
public String back();
/**
* Returns the label to use for the next button
*
* @return The next button label
*/
public String getNextButtonLabel();
/**
* Returns the label to use for the back button
*
* @return The back button label
*/
public String getBackButtonLabel();
/**
* Determines whether the next button on the wizard should be disabled
*
* @return true if the button should be disabled
*/
public boolean getNextButtonDisabled();
/**
* Returns the title to be used for the current step
* <p>If this returns <tt>null</tt> the WizardManager will
* lookup the title via the dialog configuration</p>
*
* @return The title or <tt>null</tt> if the title is to be acquired via configuration
*/
public String getStepTitle();
/**
* Returns the description to be used for the current step
* <p>If this returns <tt>null</tt> the WizardManager will
* lookup the description via the dialog configuration</p>
*
* @return The decsription or <tt>null</tt> if the title is to be acquired via configuration
*/
public String getStepDescription();
}