001    /*
002     * file CqRecordAutoTransitionCallback.java
003     *
004     * Licensed Materials - Property of IBM
005     * Restricted Materials of IBM 
006     *
007     * com.ibm.rational.wvcm.stp.cq.CqRecordAutoTransitionCallback
008     *
009     * (C) Copyright IBM Corporation 2008.  All Rights Reserved.
010     * Note to U.S. Government Users Restricted Rights:  Use, duplication or 
011     * disclosure restricted by GSA ADP  Schedule Contract with IBM Corp.
012     */
013    package com.ibm.rational.wvcm.stp.cc;
014    
015    import javax.wvcm.WvcmException;
016    
017    import com.ibm.rational.wvcm.stp.cq.CqAction;
018    import com.ibm.rational.wvcm.stp.cq.CqRecord;
019    
020    /**
021     * Interface to let a CM API application deal with state transitions of
022     * ClearQuest records. 
023     * This callback is invoked if there are required fields for the transition 
024     * that the user needs to provide.
025     */
026    public interface CqRecordAutoTransitionCallback {
027        
028        /**
029         * Notify the client of a state transition
030         * @param cqRecord the record being transitioned
031         * @param cqAction the action being performed
032         * @return true if the record's state was transitioned; false otherwise
033         */
034        public boolean handleAutoTransition(
035                CqRecord cqRecord,
036                CqAction cqAction);
037    }