Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.ejbgen
Annotation Type SqlFinder


@Retention(value=CLASS)
@Target(value=java.lang.annotation.ElementType.TYPE)
public @interface SqlFinder


Required Element Summary
 String signature
          Specifies exactly the signature to be generated on the Home class.
 String sql
          Specifies the Weblogic Server EJB QL request as it will appear in the deployment descriptor.
 
Optional Element Summary
 DBSpecificSQL[] dbSpecificSql
          Specifies the Weblogic Server EJB QL request as it will appear in the deployment descriptor.
 Constants.Bool enableQueryCaching
          Controls whether read-only entity EJBs can be cached at the query level.
 SqlFinder.GenerateOn generateOn
          (Local|Remote) Determines which Home this finder will be generated on.
 Constants.Bool includeUpdates
          (True|False) Determines whether updates made during the current transaction must be reflected in the result of a query.
 Constants.IsolationLevel isolationLevel
          (TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.
 String maxElements
          Specifies the maximum number of elements that should be returned by a multi-valued query.
 Constants.Bool sqlSelectDistinct
          Determines whether the generated SQL SELECT will contain a DISTINCT qualifier.
 String sqlShapeName
          Specifies the EJB QL request as it will appear in the deployment descriptor.
 Constants.TransactionAttribute transactionAttribute
          (NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this local method.
 

Element Detail

signature

public abstract String signature
Specifies exactly the signature to be generated on the Home class. EJBGen will add the conformant exceptions, but you must specify the fully qualified type of each parameter, even if it belongs to java.lang.


sql

public abstract String sql
Specifies the Weblogic Server EJB QL request as it will appear in the deployment descriptor. Note: if this request is needed, enclose both EJB-QL and Weblogic Server EJB-QL within double quotes.

maxElements

public abstract String maxElements
Specifies the maximum number of elements that should be returned by a multi-valued query.

Default:
"UNSPECIFIED"

includeUpdates

public abstract Constants.Bool includeUpdates
(True|False) Determines whether updates made during the current transaction must be reflected in the result of a query.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

isolationLevel

public abstract Constants.IsolationLevel isolationLevel
(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) Specifies the type of transaction isolation for this method.

Default:
weblogic.ejbgen.Constants.IsolationLevel.UNSPECIFIED

dbSpecificSql

public abstract DBSpecificSQL[] dbSpecificSql
Specifies the Weblogic Server EJB QL request as it will appear in the deployment descriptor. Note: if this request is needed, enclose both EJB-QL and Weblogic Server EJB-QL within double quotes.

Default:
{}

sqlShapeName

public abstract String sqlShapeName
Specifies the EJB QL request as it will appear in the deployment descriptor.

Default:
"UNSPECIFIED"

transactionAttribute

public abstract Constants.TransactionAttribute transactionAttribute
(NotSupported|Supports|Required|RequiresNew|Mandatory|Never) Specifies the transaction attribute for this local method. If not specified, the default transaction attribute will be used. Methods with this tag will be generated on the Local class.

Default:
weblogic.ejbgen.Constants.TransactionAttribute.UNSPECIFIED

generateOn

public abstract SqlFinder.GenerateOn generateOn
(Local|Remote) Determines which Home this finder will be generated on. If unspecified, it will be generated on both.

Default:
weblogic.ejbgen.SqlFinder.GenerateOn.UNSPECIFIED

sqlSelectDistinct

public abstract Constants.Bool sqlSelectDistinct
Determines whether the generated SQL SELECT will contain a DISTINCT qualifier.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

enableQueryCaching

public abstract Constants.Bool enableQueryCaching
Controls whether read-only entity EJBs can be cached at the query level.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02