package com.informatica.mdm.userexit;

import java.sql.Connection;

/**
 * Represents the hub context that is passed to the user exit interfaces.
 * This is a placeholder for data that is applicable to all user exits.
 * 
 */
public class UserExitContext {
    String jobRowid;
    String tablName;
    String stagingTablName;
    Connection conn;

    /**
     * See the corresponding {@link #setBatchJobRowid(String) setter} method for details.
     *     
     * @return the rowid of the batch job
     */
    public String getBatchJobRowid() {
        return this.jobRowid;
    }

    /**
     * See the corresponding {@link #setTableName(String) setter} method for details.
     *     
     * @return the name of the table used in the hub process
     */
    public String getTableName() {
        return this.tablName;
    }

    /**
     * See the corresponding {@link #setDBConnection(String) setter} method for details.
     *     
     * @return the database connection used in the hub process
     */    
    public Connection getDBConnection() {
        return this.conn;
    }

    /**
     * Set the rowid of the batch job in the context. This is applicable to batch jobs only.
     * 
     * @param batchJobRowid the rowid of the batch job
     */
    public void setBatchJobRowid(String batchJobRowid) {
        this.jobRowid = batchJobRowid;
    }

    /**
     * Set the name of the table used in the hub process.
     * 
     * @param tableName the name of the table
     */    
    public void setTableName(String tableName) {
        this.tablName = tableName;
    }

    /**
     * See the corresponding {@link #setStagingTableName(String) setter} method for details.
     *     
     * @return the name of the staging table used in the hub load and stage process
     */   
    public String getStagingTableName() {
        return this.stagingTablName;
    }

    /**
     * Set the name of the staging table used in the context. This is applicable to load and stage process.
     * 
     * @param stagingTableName the name of the staging table
     */    
    public void setStagingTableName(String stagingTableName) {
        this.stagingTablName = stagingTableName;
    }

    /**
     * Set the database connection in the context.
     * 
     * @param connection the database connection used in the hub process
     */    
    public void setDBConnection(Connection connection) {
        this.conn = connection;
    }

}