001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.sql.framework.model;
043:
044: import java.util.List;
045:
046: import com.sun.sql.framework.exception.BaseException;
047:
048: /**
049: * Case operator used when we want to do a join and lookup
050: *
051: * @version $Revision$
052: * @author Sudhi Seshachala
053: */
054: public interface SQLCaseOperator extends SQLConnectableObject,
055: SQLCanvasObject {
056:
057: public static final String DEFAULT = "default";
058:
059: public static final String SWITCH = "switch";
060:
061: /**
062: * addSQLWhen adds an SQLWhen object to the when list.
063: *
064: * @param when is the SQLWhen to be added.
065: * @return boolean true when added.
066: * @throws BaseException when the input is null.
067: */
068: public boolean addSQLWhen(SQLWhen when) throws BaseException;
069:
070: /**
071: * createSQLWhen creates a new SQLWhen object and returns it.
072: *
073: * @param theName is the name for the SQLWhen object.
074: * @param predicate is a comparison object to use.
075: * @param thenAction is an operand to use.
076: * @return SQLWhen as the newly created object.
077: * @throws BaseException if any input params are passed in as null.
078: */
079: public SQLWhen createSQLWhen() throws BaseException;
080:
081: public String generateNewWhenName();
082:
083: /**
084: * get list of child sql objects
085: */
086: public List getChildSQLObjects();
087:
088: public int getJdbcType();
089:
090: /**
091: * Gets a specific SQLWhen by name.
092: *
093: * @param whenName of the SQLWhen object to return.
094: * @return SQLWhen instance with the given name.
095: */
096: public SQLWhen getWhen(String whenName);
097:
098: /**
099: * getWhenCount returns the size of the when list.
100: *
101: * @return int the size of the list.
102: */
103: public int getWhenCount();
104:
105: public List<SQLWhen> getWhenList();
106:
107: /**
108: * removeSQLWhen removes an SQLWhen object to the when list.
109: *
110: * @param when is the SQLWhen to be removed.
111: * @return boolean true when removed.
112: * @throws BaseException when the input is null.
113: */
114: public boolean removeSQLWhen(SQLWhen when) throws BaseException;
115:
116: }
|