View Javadoc
1   /*
2    * Copyright (C) 2003-2012 David E. Berry
3    *
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2.1 of the License, or (at your option) any later version.
8    *
9    * This library is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   * Lesser General Public License for more details.
13   *
14   * You should have received a copy of the GNU Lesser General Public
15   * License along with this library; if not, write to the Free Software
16   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17   *
18   * A copy of the GNU Lesser General Public License may also be found at
19   * http://www.gnu.org/licenses/lgpl.txt
20   */
21  package org.synchronoss.cpo;
22  
23  /**
24   * CpoWhere is an interface for specifying the where clause to filter objects that are returned from the Datasource.
25   *
26   * @author david berry
27   */
28  public interface CpoWhere {
29  
30    static final int COMP_NONE = -1;
31    static final int COMP_EQ = 0;
32    static final int COMP_LT = 1;
33    static final int COMP_GT = 2;
34    static final int COMP_NEQ = 3;
35    static final int COMP_IN = 4;
36    static final int COMP_LIKE = 5;
37    static final int COMP_LTEQ = 6;
38    static final int COMP_GTEQ = 7;
39    static final int COMP_EXISTS = 8;
40    static final int COMP_ISNULL = 9;
41    static final int LOGIC_NONE = -1;
42    static final int LOGIC_AND = 0;
43    static final int LOGIC_OR = 1;
44  
45    public void setComparison(int comp);
46  
47    public int getComparison();
48  
49    public void setLogical(int log);
50  
51    public int getLogical();
52  
53    public void setAttribute(String attr);
54  
55    public String getAttribute();
56  
57    public void setRightAttribute(String attr);
58  
59    public String getRightAttribute();
60  
61    public void setValue(Object val);
62  
63    public Object getValue();
64  
65    public boolean getNot();
66  
67    public void setNot(boolean b);
68  
69    public void addWhere(CpoWhere cw) throws CpoException;
70  
71    public void setAttributeFunction(String s);
72  
73    public String getAttributeFunction();
74  
75    public void setValueFunction(String s);
76  
77    public String getValueFunction();
78  
79    public void setRightAttributeFunction(String s);
80  
81    public String getRightAttributeFunction();
82  
83    public void setStaticValue(String staticValue);
84  
85    public String getStaticValue();
86  
87    public boolean isLeaf();
88  
89    /**
90     * Gets a string representing the name of this instance of the CpoOrderBy
91     *
92     * @return String The name of the CpoOrderBy
93     */
94    public String getName();
95  
96    /**
97     * Sets a string representing the name of this instance of the CpoOrderBy
98     *
99     * @param s The name of the CpoOrderBy
100    */
101   public void setName(String s);
102 }