org.eclipse.persistence.platform.database.oracle.annotations.PLSQLRecord Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation
Show all versions of org.eclipse.persistence.core Show documentation
EclipseLink build based upon Git transaction ecdf3c32c4
/*
* Copyright (c) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation
package org.eclipse.persistence.platform.database.oracle.annotations;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* A PLSQLRecord annotation is used to define a database PLSQL RECORD type.
* This type can be used within PLSQL procedure calls.
*
* @see NamedPLSQLStoredProcedureQuery
* @author James Sutherland
* @since EclipseLink 2.3
*/
@Target({TYPE})
@Retention(RUNTIME)
public @interface PLSQLRecord {
/**
* (Required) The name of the record type in the database.
*/
String name();
/**
* (Required) The name of the database OBJECT TYPE that mirrors the record's structure.
* The record will be converted to/from this type so it can be passed through JDBC.
*/
String compatibleType();
/**
* (Optional) The Java class to map the object-type to.
* This class must be mapped using a @Struct annotation.
*/
Class javaType() default void.class;
/**
* (Required) Defines the fields in the record type.
*/
PLSQLParameter[] fields();
}