org.eclipse.persistence.platform.database.oracle.annotations.OracleObject Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction 774c696
/*******************************************************************************
* Copyright (c) 2011, 2013 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 v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* 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;
/**
* An OracleObject annotation is used to define an Oracle database OBJECT type.
* This type can be used within PLSQL procedure calls.
*
* @see NamedPLSQLStoredProcedureQuery
* @author David McCann
* @since EclipseLink 2.5
*/
@Target({TYPE})
@Retention(RUNTIME)
public @interface OracleObject {
/**
* (Required) The name of the OBJECT type in the database.
*/
String name();
/**
* (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();
}