Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

What's New in This Guide

• New and Changed Features for Release 12c (12.1.3)
• Other Significant Changes in this Document for Release 12c (12.1.3)

1 Introduction to ADF Model

• 1.1 About ADF Model
• 1.2 Data Control Types
• 1.3 Data Controls Not Covered By This Guide
• 1.4 What You May Need to Know About Non-Adapter Framework Data Controls

2 Using ADF Data Controls

• 2.1 Core Development Steps For Data Control Applications
• 2.2 Exposing Business Services with Data Controls
  • 2.2.1 How to Create ADF Data Controls
  • 2.2.2 What Happens in Your Project When You Create a Data Control
    • 2.2.2.1 DataControls.dcx Overview Editor
    • 2.2.2.2 Data Controls Panel
  • 2.2.3 Display of Business Services in the Data Controls Panel
  • 2.2.4 Data Control Built-in Operations
• 2.3 Creating Databound UI Components from the Data Controls Panel
  • 2.3.1 How to Use the Data Controls Panel
  • 2.3.2 What Happens When You Use the Data Controls Panel
  • 2.3.3 What You May Need to Know About Iterator Result Caching
    • 2.3.3.1 Setting an Iterator to Not Cache Its Result Set
    • 2.3.3.2 Using a Button to Reexecute the Iterator

3 Creating and Configuring EJB Data Controls

• 3.1 About EJB Data Controls
  • 3.1.1 EJB Data Control Use Cases and Examples
  • 3.1.2 Additional Functionality for EJB Data Controls
• 3.2 Preparing a Session Bean to Use With a Data Control
  • 3.2.1 Supported Types and Constructs in EJB Data Controls
  • 3.2.2 EJB Data Control Objects
  • 3.2.3 About the Session Facade Pattern
  • 3.2.4 EJB Data Control Prerequisites and Considerations
    • 3.2.4.1 Recommended Entity Bean Elements
    • 3.2.4.2 Recommended Session Facade Elements
    • 3.2.4.3 What You May Need to Know About Overloaded Get Methods
  • 3.2.5 Creating EJBs for a Data Control in JDeveloper
  • 3.2.6 What You May Need to Know About How EJB and Bean Data Controls Use Getter Methods
  • 3.2.7 About Commit Models for EJB Session Beans
    • 3.2.7.1 Implicit Commit Models
    • 3.2.7.2 Explicit Commit Models
  • 3.2.8 About Generating IDs for Primary Keys with the @GeneratedValue Annotation
  • 3.2.9 How to Change a Persistence Unit's Schema Generation Behavior
  • 3.2.10 How to Automatically Update a Session Facade
  • 3.2.11 What You May Need to Know About Refreshing JPA Queries
• 3.3 Exposing Session Bean Services with ADF Data Controls
  • 3.3.1 How to Create EJB Data Controls
  • 3.3.2 What Happens in Your Project When You Create an EJB Data Control
  • 3.3.3 How EJB and Bean Data Controls Appear in the IDE
    • 3.3.3.1 DataControls.dcx Overview Editor for EJB and Bean Data Controls
    • 3.3.3.2 Data Controls Panel for EJB and Bean Data Controls
    • 3.3.3.3 EJB and Bean Data Control Built-in Operations
  • 3.3.4 What You May Need to Know About the Support Named Criteria Option and Paging
  • 3.3.5 What You May Need to Know About CRUD Operations in an EJB Data Control
  • 3.3.6 What You May Need to Know About the Merge and Persist Methods
  • 3.3.7 What You May Need to Know About Remove Methods
  • 3.3.8 About Automatically Persisting New Rows
  • 3.3.9 How to Change the EagerPersist Property
  • 3.3.10 What You May Need to Know About the Persistence Context and Resubmitting Queries
  • 3.3.11 How to Create Different Data Controls for a Single Bean
  • 3.3.12 What Happens When You Create an Additional Data Control Instance
• 3.4 Paginated Fetching of Data in EJB Data Controls
  • 3.4.1 How to Change Paging Mode for a Data Control
  • 3.4.2 How to Set Range Size for a Data Control that Uses Range Paging
  • 3.4.3 What You May Need to Know About the Scrollable and Range Paging Modes
  • 3.4.4 How to Specify Access Mode for Individual Objects in the Data Control
  • 3.4.5 What You May Need to Know About Sorting Tables Based on Range Paginated Collections
• 3.5 Providing UI Hints for Attributes Using Annotations
• 3.6 Enabling Failover in an EJB Data Control

4 Creating and Configuring Bean Data Controls

• 4.1 About Bean Data Controls
  • 4.1.1 About JPA-Based Bean Data Controls
  • 4.1.2 About non-JPA Bean Data Controls
  • 4.1.3 Additional Functionality for Bean Data Controls
• 4.2 Preparing a Bean to Expose with a Data Control
  • 4.2.1 Supported Types and Constructs in Bean Data Controls
  • 4.2.2 Bean Data Control Objects
  • 4.2.3 Bean Data Control Prerequisites and Considerations
  • 4.2.4 How to Create a Service Facade for a JPA-Based Bean Data Control
• 4.3 Exposing Java Collections and Methods With Bean Data Controls
  • 4.3.1 How to Create a JPA-Based Bean Data Control
  • 4.3.2 How to Create a non-JPA-Based Bean Data Control
  • 4.3.3 What Happens in Your Project When You Create a Bean Data Control
  • 4.3.4 What You May Need to Know About Primary Keys for Non-JPA Bean Data Controls
• 4.4 Paginated Fetching of Data in Bean Data Controls
  • 4.4.1 How To Manually Implement Pagination Support in a Data Control
  • 4.4.2 How to Implement a Custom Handler for Querying and Pagination
• 4.5 Enabling Failover in a Bean Data Control
  • 4.5.1 What You May Need to Know About Calling PageFlowScope from the Constructor
• 4.6 Enabling Custom CRUD Operations in a Bean Data Control
• 4.7 Adding Transactional Behavior to a non-JPA Bean Data Control
• 4.8 Using Annotations to Declare Metadata for Bean Data Controls
• 4.9 Creating Custom Bean Data Controls

5 Exposing Web Services Using the ADF Model Layer

• 5.1 About Web Service Data Controls in ADF Applications
  • 5.1.1 Web Service Data Control Use Cases and Examples
  • 5.1.2 Additional Functionality for Web Service Data Controls in ADF Applications
• 5.2 Creating Web Service Data Controls
  • 5.2.1 How to Create a Data Control for a SOAP-based Web Service
  • 5.2.2 How to Create a Data Control for a RESTful Web Service
  • 5.2.3 How to Include a Header Parameter for a Web Service Data Control
  • 5.2.4 How to Adjust the Endpoint for a SOAP Web Service Data Control
  • 5.2.5 How to Refresh a SOAP Web Service Data Control
  • 5.2.6 What You May Need to Know About Primary Keys in SOAP Web Service Data Controls
  • 5.2.7 How to Add Custom Attributes to a REST Web Service Data Control
  • 5.2.8 What You May Need to Know About Web Service Data Controls
  • 5.2.9 What You May Need to Know About Making an XML Schema Available to a REST Data Control
• 5.3 Securing Web Service Data Controls
  • 5.3.1 Oracle WSM Policy Framework
  • 5.3.2 Using Key Stores
  • 5.3.3 How to Define SOAP Web Service Data Control Security

6 Exposing URL Services Using the ADF Model Layer

• 6.1 About Using ADF Model with URL Services
  • 6.1.1 URL Services Use Cases and Examples
  • 6.1.2 Additional Functionality for URL Services
• 6.2 Exposing URL Services with ADF Data Controls
  • 6.2.1 How to Create a URL Connection
  • 6.2.2 How to Create a URL Service Data Control
  • 6.2.3 What Happens When You Create a URL Service Data Control
  • 6.2.4 What You May Need to Know About Generating URL Data Controls without Schema
  • 6.2.5 How to Include a Custom Header Parameter for a URL Service Data Control
  • 6.2.6 What You May Need to Know About Primary Keys in URL Service Data Controls
  • 6.2.7 What You May Need to Know About URL Service Data Controls
• 6.3 Using URL Service Data Controls

7 Adding Business Logic to Data Controls

• 7.1 Introduction to Adding Business Logic to Data Controls
• 7.2 Configuring Data Controls
  • 7.2.1 How to Edit a Data Control
  • 7.2.2 What Happens When You Edit a Data Control
  • 7.2.3 How to Convert Data Controls from a Previous Release
  • 7.2.4 What You May Need to Know About MDS Customization of Data Controls
• 7.3 Working with Attributes
  • 7.3.1 How to Designate an Attribute as Primary Key
  • 7.3.2 How to Control the Updatability of an Attribute
  • 7.3.3 How to Define a Static Default Value for an Attribute
  • 7.3.4 How to Define a Default Value Using a Groovy Expression
  • 7.3.5 What Happens When You Create a Default Value Using a Groovy Expression
  • 7.3.6 How to Set UI Hints on Attributes
  • 7.3.7 What Happens When You Set UI Hints on Attributes
• 7.4 Adding Transient Attributes to a Data Object
  • 7.4.1 How to Add a Transient Attribute
  • 7.4.2 What Happens When You Add a Transient Attribute
• 7.5 Defining Validation Rules on Attributes Declaratively
  • 7.5.1 How to Add Validation Rules to Attributes
  • 7.5.2 What Happens When You Add a Validation Rule
  • 7.5.3 How to Use the Built-in Declarative Validation Rules
    • 7.5.3.1 Validating Based on a Comparison
    • 7.5.3.2 What Happens When You Validate Based on a Comparison
    • 7.5.3.3 Validating Using a List of Values
    • 7.5.3.4 What Happens When You Validate Using a List of Values
    • 7.5.3.5 Ensuring That a Value Falls Within a Certain Range
    • 7.5.3.6 What Happens When You Use a Range Validator
    • 7.5.3.7 Validating Against a Number of Bytes or Characters
    • 7.5.3.8 What Happens When You Validate Against a Number of Bytes or Characters
    • 7.5.3.9 Validating Using a Regular Expression
    • 7.5.3.10 What Happens When You Validate Using a Regular Expression
  • 7.5.4 How to Use Groovy Expressions For Validation Rules
    • 7.5.4.1 Validating Using a Groovy Expression
    • 7.5.4.2 What Happens When You Validate Based on a Groovy Expression
    • 7.5.4.3 Referencing Data Object Methods in Groovy Validation Expressions
  • 7.5.5 How to Create Validation Error Messages
    • 7.5.5.1 Creating Validation Error Messages
    • 7.5.5.2 What Happens When You Create a Validation Error Message
    • 7.5.5.3 Localizing Validation Messages
    • 7.5.5.4 Raising Error Message Conditionally Using Groovy
    • 7.5.5.5 Embedding a Groovy Expression in an Error Message
  • 7.5.6 How to Set the Severity Level for Validation Exceptions
• 7.6 Filtering Result Sets with Named Criteria
  • 7.6.1 Use Case for Named Criteria
  • 7.6.2 How to Create Named Criteria Declaratively
  • 7.6.3 What Happens When You Create a Named Criteria
  • 7.6.4 How to Use Bind Variables in Named Criteria
  • 7.6.5 What Happens When You Use Bind Variables in Named Criteria
  • 7.6.6 What You May Need to Know About Nested Expressions
  • 7.6.7 How to Set User Interface Hints on Named Criteria
  • 7.6.8 How to Create a Named Criteria Based on Multiple JPA Entities
• 7.7 Creating List of Values Objects
  • 7.7.1 How to an Create LOV for an Attribute
  • 7.7.2 What Happens When You Create an LOV
• 7.8 Testing Data Object Metadata Using the Oracle ADF Model Tester
  • 7.8.1 How to Run the Oracle ADF Model Tester
  • 7.8.2 What Happens When You Use the Oracle ADF Model Tester
  • 7.8.3 How to Test Business Layer Validation
  • 7.8.4 How to Test Row Creation and Default Value Generation
  • 7.8.5 How to Test Named Criteria Using the Oracle ADF Model Tester
  • 7.8.6 How to Update the Oracle ADF Model Tester to Display Project Changes
  • 7.8.7 How to Test Alternate Language Message Bundles and UI Hints
• 7.9 Groovy Language Support
  • 7.9.1 How to Reference ADF Objects in Groovy Expressions
  • 7.9.2 How to Reference ADF Methods and Attributes in Groovy Expressions

A Data Control Feature Comparison