001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 * $Id:LifeCycleState.java 4249 2006-10-16 19:56:10Z janguenot $
019 */
020
021package org.nuxeo.ecm.core.lifecycle;
022
023import java.util.Collection;
024
025/**
026 * Life cycle state.
027 *
028 * @see org.nuxeo.ecm.core.lifecycle.impl.LifeCycleStateImpl
029 * @author <a href="mailto:[email protected]">Julien Anguenot</a>
030 */
031public interface LifeCycleState {
032
033    /**
034     * Returns the life cycle state name.
035     *
036     * @return the life cycle state name as a string
037     */
038    String getName();
039
040    /**
041     * Returns the life cycle state descriptions.
042     *
043     * @return the life cycle state description
044     */
045    String getDescription();
046
047    /**
048     * Returns the allowed state transitions.
049     *
050     * @return a collection of string representing the allowed state transitions
051     */
052    Collection<String> getAllowedStateTransitions();
053
054    /**
055     * Returns true if state is a valid initial state
056     */
057    boolean isInitial();
058
059}