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, 2011.  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 com.ibm.rational.wvcm.stp.cq.CqAction;
016    import com.ibm.rational.wvcm.stp.cq.CqRecord;
017    
018    /**
019     * Interface to let a CM API application deal with state transitions of
020     * ClearQuest records. 
021     * This callback is invoked if there are required fields for the transition 
022     * that the user needs to provide.
023     */
024    public interface CqRecordAutoTransitionCallback {
025        
026        /**
027         * Notify the client of a state transition
028         * @param cqRecord the record being transitioned
029         * @param cqAction the action being performed
030         * @return true if the record's state was transitioned; false otherwise
031         */
032        public boolean handleAutoTransition(
033                CqRecord cqRecord,
034                CqAction cqAction);
035    }