org.jooq.RecordContext Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
/**
* A context object for {@link Record} manipulation passed to registered
* {@link RecordListener}'s.
*
* @author Lukas Eder
*/
public interface RecordContext extends Scope {
/**
* The type of database interaction that is being executed.
*
* Unlike {@link ExecuteContext#type()}, this can only result in any of
* these:
*
* - {@link ExecuteType#BATCH} when calling
* {@link DSLContext#batchStore(UpdatableRecord...) batchStore()},
* {@link DSLContext#batchInsert(UpdatableRecord...) batchInsert()},
* {@link DSLContext#batchUpdate(UpdatableRecord...) batchUpdate()},
* {@link DSLContext#batchDelete(UpdatableRecord...) batchDelete()}.
* - {@link ExecuteType#READ} when calling
* {@link UpdatableRecord#refresh() refresh()}
* - {@link ExecuteType#WRITE} when calling
* {@link UpdatableRecord#store() store()}, {@link UpdatableRecord#insert()
* insert()}, {@link UpdatableRecord#update() update()},
* {@link UpdatableRecord#delete() delete()}.
*
*
* @see ExecuteType
*/
ExecuteType type();
/**
* The Record that is being manipulated.
*
* @return The Record being manipulated. This is never
* null
*/
Record record();
/**
* The RecordType of the {@link #record()} that is being
* manipulated.
*
* @return The RecordType being manipulated. This is never
* null.
*/
RecordType recordType();
/**
* The Record(s) that are being manipulated in batch mode.
*
* If a single Record is being manipulated in non-batch mode,
* this will return an array of length 1, containing that
* Record.
*
* @return The Record(s) being manipulated. This is never
* null
*/
Record[] batchRecords();
/**
* The {@link Exception} being thrown or null.
*/
Exception exception();
}