com.ibm.as400.access.JDFieldMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation

The Open Source version of the IBM Toolbox for Java

The newest version!

///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                                 
//                                                                             
// Filename: JDFieldMap.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2001 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

import java.sql.SQLException;



/**
The JDFieldMap interface that defines how the client sees
the data for a field. It is generated based on row data that
is returned from the system.
**/
interface JDFieldMap
{



    /**
    Returns the value for a field.
    
    @param   row        The row from which to map.
    @return             The value.
    
    @exception       SQLException   If an error occurs.
    **/
    public abstract Object getValue (JDRow row)
    throws SQLException;

    /**
    Is there a data mapping error for the field?
    
    @param      row     The row from which to map.
    @return             true or false
    
    @exception  SQLException    If an error occurs.
    **/
    public abstract boolean isDataMappingError(JDRow row)
    throws SQLException;


    /**
    Is this field value SQL NULL?
    
    @param   row     The row from which to map.
    @return          true or false
    
    @exception       SQLException   If an error occurs.
    **/
    public abstract boolean isNull (JDRow row)
    throws SQLException;


}