Source Code Cross Referenced for FieldNullConstraint.java in  » Database-ORM » MMBase » org » mmbase » storage » search » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:
03:        This software is OSI Certified Open Source Software.
04:        OSI Certified is a certification mark of the Open Source Initiative.
05:
06:        The license (Mozilla version 1.0) can be read at the MMBase site.
07:        See http://www.MMBase.org/license
08:
09:         */
10:        package org.mmbase.storage.search;
11:
12:        /**
13:         * A constraint that tests if a stepfield value is null.
14:         * <p>
15:         * This corresponds to IS NULL in SQL SELECT-syntax.
16:         *
17:         * @author Rob van Maris
18:         * @version $Id: FieldNullConstraint.java,v 1.2 2003/03/10 11:50:47 pierre Exp $
19:         * @since MMBase-1.7
20:         */
21:        public interface FieldNullConstraint extends FieldConstraint {
22:
23:            /**
24:             * Returns a string representation of this FieldNullConstraint. 
25:             * The string representation has the form 
26:             * "FieldNullConstraint(inverse:&lt:inverse&gt;, field:&lt;field&gt;, 
27:             *  casesensitive:&lt;casesensitive&gt;)"
28:             * where 
29:             * <ul>
30:             * <li><em>&lt;inverse&gt;</em>is the value returned by
31:             *      {@link #isInverse isInverse()}
32:             * <li><em>&lt;field&gt;</em> is the field alias returned by 
33:             *     <code>FieldConstraint#getField().getAlias()</code>
34:             * <li><em>&lt;casesensitive&gt;</em> is the value returned by
35:             *     {@link FieldConstraint#isCaseSensitive isCaseSensitive()}
36:             * </ul>
37:             *
38:             * @return A string representation of this FieldNullConstraint.
39:             */
40:            public String toString();
41:
42:        }