qadevOOo/tests/java/ifc/sdb/_XRowSetApproveBroadcaster.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: _XRowSetApproveBroadcaster.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package ifc.sdb;
  32
  33 import lib.MultiMethodTest;
  34 import lib.Status;
  35 import lib.StatusException;
  36
  37 import com.sun.star.lang.EventObject;
  38 import com.sun.star.sdb.RowChangeEvent;
  39 import com.sun.star.sdb.XRowSetApproveBroadcaster;
  40 import com.sun.star.sdb.XRowSetApproveListener;
  41
  42 /**
  43 * <code>com.sun.star.sdb.XRowSetApproveBroadcaster</code> interface test. <p>
  44 * Required object relations :
  45 * <ul>
  46 * <li> <code>'XRowSetApproveBroadcaster.ApproveChecker'</code>:
  47 *      implementation of inner interface <code>RowSetApproveChecker</code>
  48 *      which can move cursor within a rowset, change row, and change the
  49 *      whole rowset. </li>
  50 * </ul> <p>
  51 * It is better to recreate the object after test, because of unknown
  52 * actions made by <code>RowSetApproveChecker</code> interface implementation.
  53 *
  54 * @see com.sun.star.sdb.XRowSetApproveBroadcaster
  55 * @see _XRowSetApproveBroadcaster.RowSetApproveChecker
  56 */
  57 public class _XRowSetApproveBroadcaster extends MultiMethodTest {
  58
  59     // oObj filled by MultiMethodTest
  60     public XRowSetApproveBroadcaster oObj = null ;
  61
  62     /**
  63     * The purpose of this interface is to pass to this test
  64     * relation which can make some operations with row set
  65     * on which <code>XRowSetApproveListener</code>s can react.
  66     * @see com.sun.star.sdb.XRowSetApproveListener
  67     */
  68     public static interface RowSetApproveChecker {
  69         /**
  70         * Moves cursor within row set. Method <code>approveCursorMove</code>
  71         * of <code>XRowSetApproveListener</code> must be called.
  72         */
  73         public void moveCursor() ;
  74         /**
  75         * Change rows in row set. Method <code>approveRowChange</code>
  76         * of <code>XRowSetApproveListener</code> must be called.
  77         * @return <code>RowChangeEvent</code> structure which contains
  78         * what type of change was made and how many rows it affected.
  79         * @see com.sun.star.sdb.RowChangeEvent
  80         */
  81         public RowChangeEvent changeRow() ;
  82         /**
  83         * Change the whole row set. Method <code>approveRowSetChange</code>
  84         * of <code>XRowSetApproveListener</code> must be called.
  85         */
  86         public void changeRowSet() ;
  87     }
  88
  89     /**
  90     * Implementation of <code>XRowSetApproveListener</code> interface
  91     * which just detects and stores approve requipements. They are checked
  92     * later.
  93     */
  94     private class TestListener implements XRowSetApproveListener {
  95         public boolean approveRequests = true ;
  96         public boolean approveCursorMoveCalled = false ;
  97         public boolean approveRowChangeCalled = false ;
  98         public RowChangeEvent approveRowChangeEvent = null ;
  99         public boolean approveRowSetChangeCalled = false ;
 100
 101         public TestListener(boolean approve) {
 102             approveRequests = approve ;
 103         }
 104
 105         public void reset() {
 106             approveCursorMoveCalled = false ;
 107             approveRowChangeCalled = false ;
 108             approveRowSetChangeCalled = false ;
 109         }
 110         public boolean approveCursorMove(EventObject ev) {
 111             approveCursorMoveCalled = true ;
 112             return approveRequests ;
 113         }
 114         public boolean approveRowChange(RowChangeEvent ev) {
 115             approveRowChangeCalled = true ;
 116             approveRowChangeEvent = ev ;
 117             return approveRequests ;
 118         }
 119         public boolean approveRowSetChange(EventObject ev) {
 120             approveRowSetChangeCalled = true ;
 121             return approveRequests ;
 122         }
 123         public void disposing(EventObject ev) {}
 124     }
 125     private TestListener listener1 = null ;
 126
 127     private RowSetApproveChecker checker = null ;
 128
 129     /**
 130     * Tries to retrieve object relation.
 131     */
 132     public void before() {
 133         checker = (RowSetApproveChecker) tEnv.getObjRelation
 134             ("XRowSetApproveBroadcaster.ApproveChecker") ;
 135
 136         if (checker == null) {
 137             log.println("!!! Relation for test not found !!!") ;
 138             throw new StatusException(Status.failed
 139                 ("!!! Relation for test not found !!!")) ;
 140         }
 141     }
 142
 143     /**
 144     * Creates and adds listener, then call <code>RowSetApproveChecker</code>
 145     * methods for listener methods to be called. Then checks if
 146     * listener methods were called on appropriate actions. <p>
 147     * Has OK status : If and only if appropriate listener methods called,
 148     * and listener <code>approveRowChange</code> method has write parameter,
 149     * i.e. type and rows number expected.
 150     */
 151     public void _addRowSetApproveListener() {
 152         listener1 = new TestListener(true) ;
 153         oObj.addRowSetApproveListener(listener1) ;
 154         log.println("Listener added.") ;
 155
 156         boolean result = true ;
 157
 158         checker.moveCursor() ;
 159         log.println("Cursor moved.") ;
 160         result &= listener1.approveCursorMoveCalled ;
 161
 162         listener1.reset() ;
 163         RowChangeEvent actualEvent = checker.changeRow() ;
 164         log.println("Row changed.") ;
 165
 166         RowChangeEvent event = listener1.approveRowChangeEvent ;
 167         result &= listener1.approveRowChangeCalled ;
 168
 169         boolean eventOK = event.Action == actualEvent.Action &&
 170                           event.Rows == actualEvent.Rows ;
 171
 172         result &= eventOK ;
 173
 174         listener1.reset() ;
 175         checker.changeRowSet();
 176         log.println("Row set changed.") ;
 177         result &= listener1.approveRowSetChangeCalled ;
 178
 179         tRes.tested("addRowSetApproveListener()", result) ;
 180     }
 181
 182     /**
 183     * Removes listener inserted before, then perform all actions
 184     * on which listener must react. <p>
 185     * Has OK status if no listener methods were called. <p>
 186     * Methods required to pass before :
 187     * <ul>
 188     * <li> <code>_addRowSetApproveListener</code> </li>
 189     * </ul>
 190     */
 191     public void _removeRowSetApproveListener() {
 192         requiredMethod("addRowSetApproveListener()") ;
 193
 194         listener1.reset() ;
 195
 196         oObj.removeRowSetApproveListener(listener1) ;
 197
 198         checker.moveCursor() ;
 199         checker.changeRow() ;
 200         checker.changeRowSet() ;
 201
 202         tRes.tested("removeRowSetApproveListener()",
 203             !listener1.approveCursorMoveCalled &&
 204             !listener1.approveRowChangeCalled &&
 205             !listener1.approveRowSetChangeCalled) ;
 206     }
 207
 208     /**
 209     * Disposes object environment.
 210     */
 211     public void after() {
 212         disposeEnvironment() ;
 213     }
 214
 215 }  // finish class _XRowSetApproveBroadcaster
 216
 217