org.noorm.jdbc.IBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of noorm-runtime Show documentation

There is a newer version: 1.5.0

package org.noorm.jdbc;

/**
 * @author Ulf Pietruschka / [email protected]
 *         Date: 20.05.11
 *         Time: 14:27
 */
public interface IBean {

	/**
	 * Generic object to enrich the Bean with additional information.
	 * @return the generic object.
	 */
	T getAuxiliaryData();

	/**
	 * Generic object to enrich the Bean with additional information.
	 * @param pAuxiliaryData
	 */
	void setAuxiliaryData(final T pAuxiliaryData);

	/**
	 * The database name of this Bean. Can either be a table or an updateable view.
	 * @return the database name
	 */
	String getTableName();

	/**
	 * The Oracle name of the primary key columns.
	 * @return the primary key column names.
	 */
	String[] getPrimaryKeyColumnNames();

	/**
	 * The Oracle sequence name used to generate numeric primary keys for this table or view.
	 * @return the sequence name.
	 */
	String getSequenceName();

	/**
	 * The table column used for modification checking for optimistic locking.
	 * @return the version column name.
	 */
	String getVersionColumnName();
}