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

Part Number E27170-01

weblogic.ejbgen
Annotation Type CmpField


@Retention(value=CLASS)
@Target(value=java.lang.annotation.ElementType.METHOD)
public @interface CmpField


Required Element Summary
 String column
          Specifies the column where this CMP field will be mapped.
 
Optional Element Summary
 CmpField.ColumnType columnType
          (OracleClob|OracleBlob) Specifies the type of this column.
 Constants.Bool dbmsDefaultValue
           
 Constants.Bool excludeFromValueObject
          (True|False) If True, this field will not be generated in the value object.
 String groupNames
          Specifies the names of the groups to which this field belongs, separated by commas.
 String orderingNumber
          (0..n) Specifies the number where this field must appear in signatures and constructors.
 Constants.Bool primkeyField
          (True|False) Sets whether this field is part of the compound primary key.
 Constants.Bool readOnlyInValueObject
          (True|False) If True, only the getter will be generated for this field in the value object.
 String tableName
          Specifies the table(s) where this field should be mapped.
 

Element Detail

column

public abstract String column
Specifies the column where this CMP field will be mapped.

readOnlyInValueObject

public abstract Constants.Bool readOnlyInValueObject
(True|False) If True, only the getter will be generated for this field in the value object.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

tableName

public abstract String tableName
Specifies the table(s) where this field should be mapped.

Default:
"UNSPECIFIED"

groupNames

public abstract String groupNames
Specifies the names of the groups to which this field belongs, separated by commas.

Default:
"UNSPECIFIED"

orderingNumber

public abstract String orderingNumber
(0..n) Specifies the number where this field must appear in signatures and constructors. For this ordering to work, all CMR and CMP fields must have this attribute with a distinct numeric value.

Default:
"0"

excludeFromValueObject

public abstract Constants.Bool excludeFromValueObject
(True|False) If True, this field will not be generated in the value object.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

columnType

public abstract CmpField.ColumnType columnType
(OracleClob|OracleBlob) Specifies the type of this column.

Default:
weblogic.ejbgen.CmpField.ColumnType.UNSPECIFIED

primkeyField

public abstract Constants.Bool primkeyField
(True|False) Sets whether this field is part of the compound primary key.

Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

dbmsDefaultValue

public abstract Constants.Bool dbmsDefaultValue
Default:
weblogic.ejbgen.Constants.Bool.UNSPECIFIED

Copyright 1996, 2013, 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.2)

Part Number E27170-01