Oracle Configurator · 2003-05-12 · Oracle Configurator beyond what is provided by Oracle Configurator Developer. You create Functional Companion objects, which use the Configuration

Oracle Configurator

Oracle Configuration Interface Object (CIO) Developer’s Guide

Release 11i

March 2001

Part No. A87532-01

This document describes Functional Companions, which augment the functionality of a run-time Oracle Configurator, and the Oracle Configuration Interface Object (CIO), which is used by Functional Companions to access the Oracle Configurator Active Model.

Oracle Configuration Interface Object (CIO) Developer’s Guide, Release 11i

Part No. A87532-01

Copyright © 1996, 2001, Oracle Corporation. All rights reserved.

Primary Author: Mark Sawtelle

Contributors: Brent Benson, Jim Carlson, Ivan Lazarov, David Lee, Anupam Miharia, Marty Plotkin, Brian Ross

The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs is prohibited.

Program Documentation is licensed for use solely to support the deployment of the Programs and not for any other purpose.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.

If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs.

Oracle is a registered trademark, and Oracle SellingPoint Configurator is a trademark or registered trademark of Oracle Corporation. All other company or product names mentioned are used for identification purposes only and may be trademarks of their respective owners.

iii

Contents

List of ExamplesList of FiguresList of Tables

Send Us Your Comments ................................................................................................................... xi

Preface........................................................................................................................................................... xiii

Intended Audience ............................................................................................................................... xiiiStructure ................................................................................................................................................. xiiiRelated Documents.............................................................................................................................. xivConventions.......................................................................................................................................... xivProduct Support.................................................................................................................................... xv

1 Functional Companion Basics

1.1 What Are Functional Companions? ................................................................................... 1–11.1.1 Types of Functional Companions ................................................................................ 1–21.1.2 Important Facts About Functional Companions ....................................................... 1–31.2 Functional Companions and the CIO................................................................................. 1–41.2.1 Using the CIO Interface................................................................................................. 1–41.2.2 Implementing Standard Interface Methods ............................................................... 1–41.3 Building Functional Companions in Java.......................................................................... 1–51.3.1 Procedure for Building Functional Companions in Java ......................................... 1–51.3.2 Installation Requirements for Java Functional Companions................................... 1–71.3.2.1 Requirements for Developing Functional Companions ................................... 1–71.3.2.2 Requirements for Running Functional Companions......................................... 1–71.3.2.3 Requirements for Testing Java Functional Companions .................................. 1–81.3.3 Minimal Example of a Java Functional Companion ................................................. 1–8

iv

1.4 Incorporating Functional Companions in Your Configurator..................................... 1–101.4.1 Associating Functional Companions with your Model......................................... 1–101.4.2 Updating the User Interface....................................................................................... 1–141.4.2.1 Generating or Refreshing a User Interface ....................................................... 1–151.4.2.2 Modifying the Default User Interface ............................................................... 1–151.4.3 Testing Functional Companions in the Run-time Oracle Configurator.............. 1–171.4.3.1 Testing with Oracle Configurator Developer .................................................. 1–171.4.3.2 Testing with an HTML Test Page ...................................................................... 1–181.4.3.3 Test Functionality in the Run-time Oracle Configurator ............................... 1–19

2 Using Functional Companions

2.1 Controlling User Interface Elements.................................................................................. 2–12.1.1 How the CIO Interacts with User Interfaces ............................................................. 2–22.1.2 Getting the Current Screen .......................................................................................... 2–42.1.3 Access to Nodes ............................................................................................................. 2–42.1.4 Access to Screens and Controls ................................................................................... 2–52.1.5 Access to Images and Labels ....................................................................................... 2–62.1.6 Controlling Navigation ................................................................................................ 2–62.1.7 Controlling Images and Labels ................................................................................... 2–72.1.8 Generating Messages and Other Output ................................................................... 2–82.1.8.1 Message Boxes ........................................................................................................ 2–82.1.8.2 Custom HTML Output.......................................................................................... 2–82.1.9 Handling Interface Events ........................................................................................... 2–82.1.9.1 Types of Events....................................................................................................... 2–92.1.9.2 Listener Registration.............................................................................................. 2–92.2 Controlling Parent and Child Windows ......................................................................... 2–102.2.1 Locking, Unlocking and Refreshing Windows....................................................... 2–102.2.2 Accessing a Shared Configuration Model ............................................................... 2–11

3 The Configuration Interface Object (CIO)

3.1 Background ........................................................................................................................... 3–13.1.1 What is the CIO?............................................................................................................ 3–13.1.2 The CIO and Functional Companions........................................................................ 3–23.2 The CIO’s Runtime Node Interface Classes...................................................................... 3–23.3 Initializing the CIO............................................................................................................... 3–4

v

3.4 Access to Configurations...................................................................................................... 3–63.4.1 Creating and Deleting Configurations........................................................................ 3–63.4.2 Saving and Restoring Configurations ......................................................................... 3–73.4.3 Access to Configuration Parameters ........................................................................... 3–83.4.4 Logic Transactions ......................................................................................................... 3–83.5 Access to Nodes of the Model at Runtime...................................................................... 3–113.5.1 Opportunities for Modifying the Model.................................................................. 3–113.5.2 Accessing Components .............................................................................................. 3–123.5.3 Adding and Deleting Optional Components.......................................................... 3–123.5.4 Accessing Features ...................................................................................................... 3–123.5.5 Getting and Setting Logic States ............................................................................... 3–133.5.6 Getting and Setting Numeric Values ....................................................................... 3–153.5.7 Accessing Properties................................................................................................... 3–163.5.8 Access to Options ........................................................................................................ 3–173.6 Introspection through IRuntimeNode ............................................................................ 3–183.7 Handling Logical Contradictions..................................................................................... 3–203.7.1 Generating Error Messages from Contradictions................................................... 3–213.7.2 Overriding Contradictions......................................................................................... 3–213.7.3 Raising Exceptions ...................................................................................................... 3–233.8 Validating Configurations ................................................................................................ 3–243.9 Using Requests ................................................................................................................... 3–263.9.1 Getting Information about Requests ........................................................................ 3–263.9.2 User Requests............................................................................................................... 3–273.9.3 Initial Requests ............................................................................................................ 3–283.9.3.1 Usage Notes on Initial Requests ........................................................................ 3–293.9.3.2 Limitations on Initial Requests .......................................................................... 3–303.9.4 Failed Requests ............................................................................................................ 3–303.10 Standard Interface Methods for Functional Companions ............................................ 3–303.10.1 The initialize() Interface Method .............................................................................. 3–313.10.2 The autoConfigure() Interface Method.................................................................... 3–333.10.3 The validate() Interface Method................................................................................ 3–343.10.4 The generateOutput() Interface Method.................................................................. 3–353.10.5 The terminate() Interface Method............................................................................. 3–36

vi

4 Reference Documentation for the CIO

5 Examples

5.1 Initializing the CIO............................................................................................................... 5–15.2 Thin-Client generateOutput() Functional Companion ................................................... 5–25.3 Using Requests...................................................................................................................... 5–55.3.1 Setting Initial Requests ................................................................................................. 5–55.3.2 Getting a List of Failed Requests................................................................................. 5–75.4 User Interface Interaction .................................................................................................... 5–95.4.1 Navigating to a Screen.................................................................................................. 5–95.4.2 Changing the Caption of a Node .............................................................................. 5–125.4.3 Changing an Image ..................................................................................................... 5–145.5 Controlling Parent and Child Windows ......................................................................... 5–165.5.1 Locking, Unlocking and Refreshing Windows....................................................... 5–165.5.2 Accessing a Shared Configuration Model ............................................................... 5–18

Glossary of Terms

Glossary of Acronyms

A CIO Package and Related Classes

B Package oracle.apps.cz.cio

C Package oracle.apps.cz.common

D Package oracle.apps.cz.utilities

Index

vii

List of Examples

1–1 Elementary Java Functional Companion: MyClass.java ................................................. 1–93–1 Initializing the CIO (short example) ................................................................................... 3–53–2 Creating new Configuration objects ................................................................................... 3–73–3 Using a logic transaction with a deletion........................................................................ 3–103–4 Getting the state of a node ................................................................................................ 3–143–5 Setting the state of a node ................................................................................................. 3–143–6 Setting a numeric value ..................................................................................................... 3–153–7 Testing whether an option is selected, or satisfied........................................................ 3–173–8 Testing whether a node is selected, or satisfied............................................................. 3–193–9 Getting a child node by name........................................................................................... 3–193–10 Collecting all child nodes by type.................................................................................... 3–203–11 Handling and overriding Logical Exceptions ................................................................ 3–223–12 Returning a list of validation failures .............................................................................. 3–253–13 Using initial requests ......................................................................................................... 3–295–1 Initializing the CIO (long example) .................................................................................... 5–15–2 Thin-client Output Functional Companion....................................................................... 5–45–3 Setting initial requests (InitialRequestTest.java)............................................................... 5–55–4 Getting a list of failed requests (OverrideTest.java)......................................................... 5–85–5 Navigation to a screen (ScreenNav.java) ........................................................................ 5–105–6 Changing the caption of a node (CaptionChng.java).................................................... 5–125–7 Changing an image (ImageChange.java)........................................................................ 5–155–8 Launching a Child Window (Launch.java) .................................................................... 5–165–9 Accessing a Shared Configuration Model (Replace.java)............................................. 5–18

viii

List of Figures

1–1 Associating a Component with a Functional Companion ........................................... 1–131–2 Functional Companion Rule: Detail of the Attributes view......................................... 1–141–3 Changing the Label for a Functional Companion Button ............................................ 1–161–4 User Interface Definition for a Functional Companion Button ................................... 1–161–5 Testing a Functional Companion in the Run-time Oracle Configurator.................... 1–201–6 Output Window Generated by Functional Companion Button.................................. 1–21

ix

List of Tables

1–1 Types of Functional Companions ...................................................................................... 1–21–2 Required Software for Functional Companions .............................................................. 1–83–1 Runtime node interface classes for the CIO .................................................................... 3–23–2 Methods of the interface class IOption........................................................................... 3–173–3 Methods of the interface class IRuntimeNode ............................................................. 3–183–4 Typical methods used to make requests ........................................................................ 3–263–5 Type methods of the class Request ................................................................................. 3–273–6 Standard methods of the IFunctionalCompanion interface........................................ 3–31

x

xi

Send Us Your Comments

Oracle Configuration Interface Object (CIO) Developer’s Guide, Release 11i

Part No. A87532-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication. Your input is an important part of the information used for revision.

� Did you find any errors?� Is the information clearly presented?� Do you need more information? If so, where?� Are the examples correct? Do you need more examples?� What features did you like most about this manual?

If you find any errors or have any other suggestions for improvement, please indicate the chapter, section, and page number (if available). You can send comments through your call to Oracle Support Services or by sending them to:

Oracle Configurator Oracle Corporation Documentation 21 North Avenue Burlington, MA 01803 USA

If you would like a reply, please give your name, address, and telephone number below.

If you have problems with the software, please contact your local Oracle Support Services.

xii

xiii

Preface

You can use Functional Companions to augment the functionality of your run-time Oracle Configurator beyond what is provided by Oracle Configurator Developer. You create Functional Companion objects, which use the Configuration Interface Object (CIO) to perform various tasks, including accessing the Model, setting and getting logic states, and adding optional components. You can also use the CIO in your own applications, to interact with the Model.

Intended AudienceThis manual is intended primarily for software developers writing Functional Companions. The language recommended for developing Functional Companions is Java.

This manual assumes that you are an experienced programmer and that you understand Oracle databases, the SQL and Java programming languages, and the principles of JDBC.

.This manual also provides background and reference information on the CIO, which is needed by developers of applications having customized user interfaces that need access to the Oracle Configurator Active Model.

StructureThis manual contains:

� Chapter 1, "Functional Companion Basics"

� Chapter 2, "Using Functional Companions"

� Chapter 3, "The Configuration Interface Object (CIO)"

xiv

� Chapter 4, "Reference Documentation for the CIO"

� Chapter 5, "Examples"

Related DocumentsFor more information, see the following manuals in Release 11i of the Oracle Configurator documentation set:

� Oracle Configurator Implementation Guide

� Oracle Configurator Developer User’s Guide

� Oracle Configurator Developer Tutorial

The following documents are also relevant:

� Oracle8i JDBC Developer's Guide and Reference

ConventionsIn examples, an implied carriage return occurs at the end of each line, unless otherwise noted. You must press the Return key at the end of a line of input.

The following conventions are also used in this manual:

Convention Meaning

. . .

Vertical ellipsis points in an example mean that information not directly related to the example has been omitted.

. . . Horizontal ellipsis points in statements or commands mean that parts of the statement orcommand not directly related to the example have been omitted

boldface text Boldface type in text indicates a term defined in the text, the glossary, or in both locations.

< > Angle brackets enclose user-supplied names.

[ ] Brackets enclose optional clauses from which you can choose one or none.

> The left bracket alone sign represents the MS DOS prompt.

xv

Product SupportThe mission of the Oracle Support Services organization is to help you resolve any issues or questions that you have regarding Oracle Configurator Developer and Oracle Configurator.

To report issues that are not mission-critical, submit a Technical Assistance Request (TAR) via Metalink, Oracle’s customer support Web site, at:

http://metalink.oracle.com

You can also find product-specific documentation and other useful information using Metalink.

For a complete listing of available Oracle Support Services and phone numbers, see:

http://www.oracle.com/support

For general information about Oracle Applications, visit AppsNet at:

http://www.oracle.com/appsnet/index.html

xvi

Functional Companion Basics 1-1

1Functional Companion Basics

Functional Companions extend your run-time Oracle Configurator by attaching custom code through established interfaces.

This chapter describes the essential techniques needed to create all Functional Companions.

1.1 What Are Functional Companions?A Functional Companion is a programming object that you attach to your Model in order to extend the functionality of your run-time Oracle Configurator in ways that are not provided by Oracle Configurator Developer.

You can write a Functional Companion object in several languages, depending on the functionality needed by your application. The Functional Companion communicates with your Model through an API (application programming interface) called the Configuration Interface Object (CIO). The Oracle Configuration Interface Object is written in Java. See Chapter 3, "The Configuration Interface Object (CIO)".

You connect Functional Companions to specific nodes in your Model using Oracle Configurator Developer. You also specify the type of action that you want the specified Functional Companion to perform when your end users select its associated node. Then you generate the logic and user interface, as you normally do for your run-time Oracle Configurator. This action associates the Functional Companion with your application so that when your end users select a node in the Model, the Functional Companion on that node is automatically invoked.

What Are Functional Companions?

1-2 Oracle Configuration Interface Object (CIO) Developer’s Guide

1.1.1 Types of Functional CompanionsYou can assign a Functional Companion to perform any or all of these three types of actions:

Table 1–1 Types of Functional Companions

Type Description

Auto-configuration Configures the state of the Model. You can use this to modify the shape of the Model tree, and the state of its nodes. For instance, your application might gather initial needs assessment information and use it to set up the appropriate set of choices for your end user to make.

In your run-time Oracle Configurator, your end user will explicitly choose to run an auto-configuration Functional Companion

See Section 3.10.2, "The autoConfigure() Interface Method".

Validation Validates the logical choice that the end user has just made. The Functional Companion can perform complex operations beyond the scope of what you can develop in Oracle Configurator Developer. For instance, you can perform sophisticated numeric comparisons.

A Java Functional Companion returns null if the validation is successful. If the validation fails, it returns a List of CompanionValidationFailure objects.

In your run-time Oracle Configurator, all validation Functional Companions are run every time your end user chooses an Option. After each action, the end user gets the collection of strings returned by each Functional Companion that failed.

Validation companions query the Model to determine validity, but should not modify the Model. Modifying the Model in a validation Functional Companion can cause unexpected application failures.

See Section 3.10.3, "The validate() Interface Method".

Output Generates some form of output from the configuration. This output might be a report, a performance graph, a geometric rendering, or a graphical representation of the configuration.

In your run-time Oracle Configurator, your end user will explicitly choose to run an output Functional Companion.

See Section 3.10.4, "The generateOutput() Interface Method".

What Are Functional Companions?


1.1.2 Important Facts About Functional Companions� To build a Functional Companion, you implement an object class in the

language that you choose as being most appropriate for the operation that you want to perform. Oracle recommends using Java for developing Functional Companions. Java Functional Companions can run on any platform supported by Java.

� When the run-time Oracle Configurator starts up, it creates an instance of the CIO, which creates runtime instances of all the Components in the Model. If you used Oracle Configurator Developer to associate a Functional Companion with a Component, then the application creates, for each instance of that Component, an instance of the class that you defined for your Functional Companion and attaches the Functional Companion instance to the Component.

� You can associate more than one Functional Companion with a particular Component; the CIO will create instances of all of them.

� If any Functional Companions cannot be loaded when you create a new configuration (for instance, due to internal errors or an incorrect CLASSPATH), the configuration will fail to open.

� In addition to Components, you can also associate Functional Companions with Products and BOM Models, which are considered equivalent entities.

� For Functional Companions built with Java, you implement a class that extends oracle.apps.cz.cio.FunctionalCompanion. See Section 1.3, "Building Functional Companions in Java".

� For all language choices, you also implement one or more of the standard interface methods of oracle.apps.cz.cio.IFunctionalCompanion, which are described in Section 3.10, "Standard Interface Methods for Functional Companions".

� In order to communicate with the Model of your application, the Functional Companion uses Oracle’s CIO API. The CIO can also be used to develop a custom user interface that allows the run-time Oracle Configurator to access the Model. See Section 1.2, "Functional Companions and the CIO".

– As a point of information, both Oracle Configurator Developer and the default user interface for the run-time Oracle Configurator communicate in just this way with the Model, using the Oracle Configurator schema to store structure, rules, and user interface information (in addition to your end user ’s data).

Functional Companions and the CIO


1.2 Functional Companions and the CIOFunctional Companions are invoked by the CIO through the run-time Oracle Configurator, and Functional Companions call the CIO to get information from the Active Model. The CIO is like a broker for the Active Model, in that it passes information both ways. Programmers writing Functional Companions need to know how to use the CIO.

Each Functional Companion is an object class. For every Component instance in your Model that is associated with a Functional Companion, the CIO creates an instance of this class.

1.2.1 Using the CIO InterfaceYour Functional Companion is a client of the CIO. When you program against the CIO, you create instances of a set of public interface objects, which are defined in oracle.apps.cz.cio.

Your code should refer only to these public interface objects. See Section 3.2, "The CIO’s Runtime Node Interface Classes".

ReferenceFor reference documentation, see: Package oracle.apps.cz.cio.

1.2.2 Implementing Standard Interface MethodsYou provide functionality for your Functional Companion by implementing body code for the methods:

� initialize

� autoConfigure

� validate

� generateOutput

� terminate

These methods are described in Section 3.10, "Standard Interface Methods for Functional Companions".

For particulars that apply to the languages currently supported by the CIO, and examples, see Section 1.3, "Building Functional Companions in Java".

Building Functional Companions in Java


1.3 Building Functional Companions in Java

1.3.1 Procedure for Building Functional Companions in JavaHere is an overview of the tasks for Building Functional Companions in Java. See also Section 1.3.2, "Installation Requirements for Java Functional Companions".

1. Use a Java development environment or text editor to create a .java file in which to define a Java class.

2. Import the classes for the CIO (oracle.apps.cz.cio.*).

import oracle.apps.cz.cio.*;

3. Define a class in which to determine the behavior of your Functional Companion.

Here is the relevant line from Example 1–1:

public class MyClass extends FunctionalCompanion // line 6

When you define your Functional Companion class, you can do one of the following:

� Normally: Extend the base class for Functional Companions— oracle.apps.cz.cio.FunctionalCompanion—and override just the particular methods that you need. In this case, you gain the functionality of the FunctionalCompanion base class. This functionality includes: saving references to the runtime node with which the Functional Companion is associated (with the FunctionalCompanion.getRuntimeNode() method), and returning the name of the Functional Companion (with the FunctionalCompanion.getName() method). See the reference for: FunctionalCompanion.

� More rarely: Implement the interface class for Functional Companions—oracle.apps.cz.cio.IFunctionalCompanion—and implement all its methods. You do not extend oracle.apps.cz.cio.FunctionalCompanion. In this case, you lose the functionality of the FunctionalCompanion base class. See the reference for: FunctionalCompanion.

4. You may want to override oracle.apps.cz.cio.FunctionalCompanion.initialize(). (See Section 3.10.1, "The initialize() Interface Method".)



You should ordinarily never directly call FunctionalCompanion.initialize(), since the CIO does that for you. However, if your Functional Companion overrides FunctionalCompanionas its base class, then the initialize() method of your class should callsuper.initialize(). This passes some necessary variables to the superclass (oracle.apps.cz.cio.FunctionalCompanion) so that its methods will work.

public void initialize(IRuntimeNode comp_node, String name, Stringdescription, int id)

{this.comp_node = comp_node;super.initialize(comp_node, name, description, id); // line 35}

5. Override one or more of the other interface methods of oracle.apps.cz.cio.IFunctionalCompanion (see Section 3.10, "Standard Interface Methods for Functional Companions"):

autoConfigurevalidategenerateOutputterminate

public void autoConfigure()

public List validate()

public String generateOutput()

6. Optionally, call the methods of the other interface classes of the CIO (see Section 3.2, "The CIO’s Runtime Node Interface Classes").

7. Compile the .java file into a .class file for example, with JDK 1.1.x:

javac FuncCompTest1.java

8. Put the resulting .class file in your classpath, or into a JAR file in your classpath. For example:

Note: Basic Functional Companions, ones that only use the standard interface methods listed in step 5, do not need to use the interface classes of the CIO.



jar cvf FuncComps.jar FuncCompTest1.class

set CLASSPATH=%CLASSPATH%;D:\companions\FuncComps.jar

9. Run Oracle Configurator Developer with this classpath. Associate your Functional Companion with a Component in your Model. See Section 1.4, "Incorporating Functional Companions in Your Configurator" on page 1-10. Generate the Active Model and User Interface.

10. To test your Functional Companion, click the Test button in Oracle Configurator Developer. When the run-time Oracle Configurator starts up, click the buttons that have been generated in the UI for activating your Functional Companions. See Section 1.4.3, "Testing Functional Companions in the Run-time Oracle Configurator" on page 1-17.

1.3.2 Installation Requirements for Java Functional Companions

1.3.2.1 Requirements for Developing Functional CompanionsIn order to develop Java Functional Companions, you must install a Java development environment that enables you to compile Java classes, such as:

� Oracle JDeveloper

� Sun JDK 1.1.x or JDK 1.2.x (JDK 1.1.x is recommended for compatibility with Oracle Applications Release 11i)

� Microsoft Visual J++

You do not need JDBC drivers or database access to compile a Functional Companion, although these are required to run one.

1.3.2.2 Requirements for Running Functional CompanionsAt run time, a run-time Oracle Configurator using Functional Companions requires:

� JDBC/ODBC drivers

� An ODBC datasource

The run-time Oracle Configurator automatically sets up a JDBC database connection for use by the CIO. Custom user interfaces that take the place of the run-time Oracle Configurator must perform this task. See Section 3.3, "Initializing the CIO" for details.



In order to run Java Functional Companions, the software described in Table 1–2 must be installed and recognized by your operating system environment in the indicated locations.

See the Oracle Configurator Installation Guide and the Oracle Configurator Implementation Guide for complete details on installation and environment. For background on JDBC drivers, see the Oracle8i JDBC Developer's Guide and Reference.

1.3.2.3 Requirements for Testing Java Functional CompanionsThe class(es) that implement your Functional Companions must be included in your CLASSPATH environment variable. Otherwise, you are likely to get an error message like the following when you try to create a new configuration:

New Configuration: Cannot create configuration:oracle.apps.cz.cio.FuncCompCreationException:java.lang.ClassNotFoundException: classname

Where classname is the name of the first Functional Companion to be loaded.

1.3.3 Minimal Example of a Java Functional CompanionExample 1–1 illustrates the minimal coding required for a Functional Companion that does not perform any work.

Table 1–2 Required Software for Functional Companions

File name Location Required for Source

config.jar CLASSPATH Any use of CIO. Oracle Configurator (OC) installation.

cz3rdpty.jar CLASSPATH Use of the Java classes for collections, the XML parser, the Swing UI, and various fundamentals.

OC installation.

cz.dll

czjni.dll

PATH CIO and Functional Companion access to the Oracle Configurator logic engine.

OC installation.

jdbc111.zip CLASSPATH Functional Companions using the Oracle JDBC Thin drivers.

Oracle Technology Network download area



Example 1–1 Elementary Java Functional Companion: MyClass.java

import oracle.apps.cz.cio.*;import com.sun.java.util.collections.List; // line 2import javax.servlet.http.HttpServletResponse;import java.io.IOException;

public class MyClass extends FunctionalCompanion // line 6{

// constructorpublic MyClass(CIO cio, IRuntimeNode node) {}

public void initialize(IRuntimeNode node, String name, String description,int id) {

// implement body, if necesarysuper.initialize(node, name, description, id);

}

public void autoConfigure() throws LogicalException {// implement body as desired}

public List validate() {// implement body as desiredreturn null;}

// for thin clientpublic void generateOutput(HttpServletResponse response) throws IOException

{// implement body as desired}

// for thick clientpublic String generateOutput() {// implement body as desiredreturn null;}

public void terminate() {// implement body, if necesarysuper.terminate();

Incorporating Functional Companions in Your Configurator


}}

Line 2import com.sun.java.util.collections.List; // line 2

If you are using JDK 1.1.x, import com.sun.java.util.collections.List, which is provided in cz3rdpty.jar (see "Installation Requirements for Java Functional Companions" on page 1-7). If you are using JDK 1.2, then import java.util.List.

Line 4public class MyClass extends FunctionalCompanion // line 6

This class extends the base class for Functional Companions: oracle.apps.cz.cio.FunctionalCompanion. See the explanation under Step 3.

1.4 Incorporating Functional Companions in Your ConfiguratorTo incorporate a Functional Companion into your configurator, you must:

1. Create a Configuration Rule that associates the Functional Companion with a Component (or equivalent node). See Section 1.4.1 on page 1-10.

2. Update the User Interface to reflect the Functional Companion. See Section 1.4.2 on page 1-14.

3. Test the operation of the Functional Companion. See Section 1.4.3 on page 1-17.

1.4.1 Associating Functional Companions with your ModelTo enable your Functional Companion to work with your run-time Oracle Configurator, you must associate it with a Component (or equivalent node) in your Model. You create this association in Oracle Configurator Developer, as a type of Configuration Rule that specifies the Functional Companion method(s) that you have implemented in your executable Functional Companion, and the path to be used by the run-time Oracle Configurator to locate the file containing the executable Functional Companion.

To create an association between a Component and a Functional Companion:

1. Click on the Rules button on the main toolbar.



A list of the Configuration Rule types appears in the lower-left pane.

2. Choose New Functional Companion from the Create menu. You can also highlight the Functional Companions node, click on the right mouse button, and select New Functional Companion from the popup menu.

3. In the Name field in the right pane, type a name for the Functional Companion rule.

This name will be used to reference the rule when you create User Interface objects.

4. In the Description section, type a short explanation of the Functional Companion rule. If necessary, open the Description section by clicking on the blue arrow to the left of it.

5. If necessary, open the Definition section by clicking on the blue arrow to the left of it. In the Model view, select the Component or equivalent node that you want to include in this rule. Drag it with the left-hand mouse button to the Base Component field in the Definition section. Only one Base Component may be specified per rule.

6. Choose one or more roles for the Functional Companion. The choices are:

See Section 1.1.1, "Types of Functional Companions" and Section 3.10, "Standard Interface Methods for Functional Companions" for background. Note that you do not associate the initialize() and terminate() methods, since they are invoked automatically by the run-time Oracle Configurator.

7. Under Implementation, drop down the list and chose the language in which the Functional Companion is implemented.

� For Functional Companions written in Java, choose "Java".

8. Under Program String, type in the string that locates the executable Functional Companion:

� For Java, this is the name of the class that implements the Functional Companion, such as:

Type Associated Functional Companion method

Auto-configuration autoConfigure

Validation validate

Output generateOuput



FuncCompTest1

The Program String must enable Oracle Configurator Developer and the OC Servlet to locate the class file, using your Java class path. The standard Java rules for specifying classes in archives apply. For example, if you had placed your Functional Companion FuncCompTest1.class file in a Java archive (.jar) file named tests.jar, using this path:

com\java\tests\FuncCompTest1.class

then you would specify the Functional Companion class this way as the Program String in Configurator Developer:

com.java.tests.FuncCompTest1

See Step 8 under Section 1.3.1, "Procedure for Building Functional Companions in Java".

Figure 1–1 shows what the Rules module screen of Oracle Configurator Developer might look like after you associate a Component with a Functional Companion. Figure 1–2 shows details of the Attributes view of the screen in Figure 1–1.

9. If you have recently modified your Model structure or Rules (not including creating a Functional Companion rule), then choose Generate Active Model from the Tools menu. You can omit this step if you have only created Functional Companion rules.

10. After the Generate Active Model command completes successfully, click on the UI button on the main toolbar to switch to the User Interface module.



Figure 1–1 Associating a Component with a Functional Companion



Figure 1–2 Functional Companion Rule: Detail of the Attributes view

1.4.2 Updating the User InterfaceAfter you create a Functional Companion rule that associates your executable Functional Companion with a Component or equivalent node in your Model, you must update the User Interface, so that it includes buttons for any Auto-configuration or Output Functional Companions that you have defined.

Updating the User Interface consists of:

� Generating a new UI or refreshing an existing one. See Section 1.4.2.1.

� Optionally, modifying the default UI that is generated by Oracle Configurator Developer. See Section 1.4.2.2.

See the chapter on the User Interface in the Oracle Configurator Developer User’s Guide for full information on these larger topics, especially the modification of UIs. The information presented here is minimal.



1.4.2.1 Generating or Refreshing a User InterfaceTo generate a UI:

1. If you have not already created a User Interface for your Model, select the root node ("User Interfaces") in the lower-left pane and choose New User Interface from the Create menu.

You can generate any number of UIs, and choose the one to use in your application.

2. Wait for the notice that the creation of the User Interface was successful.

To refresh a UI:

1. If you have already created a User Interface for your Model, select the UI node for that UI and choose Refresh from the Edit menu.

You can select any existing UI to refresh.

2. Wait for the notice that the refreshing of the User Interface was successful.

1.4.2.2 Modifying the Default User InterfaceYou can customize many elements of your User Interface in many ways. There are a few that are most relevant to Functional Companions.

� If your Functional Companion rule is of the Output or Auto-Configuration type, then a Button for running the Functional Companion is automatically created as a node in the UI tree. The default label on the button is fabricated from the name of the Functional Companion rule. You will probably want to change this label to something that will give your end user a better idea of what the button will do. You do this by editing the Text field in the Label section of the attributes for the Button.



Figure 1–3 Changing the Label for a Functional Companion Button

� In the Definition section of the attributes for the Button, you may want to change one or more of the defaults shown in Figure 1–4 on page 1-16.

Figure 1–4 User Interface Definition for a Functional Companion Button

– The Companion field is set to the Functional Companion rule that the Button will run.You can change it, so that the same button triggers a different rule.



– The Action field is set to the type of Functional Companion (Output or Auto-Configuration). You can change the type if the implementation of your executable Functional Companion changes.

– The Reference field is set to the Model node that you associated with the Functional Companion rule. You can change it to attach the Button to a different Model node while keeping it on the same UI screen.

See the Oracle Configurator Developer User’s Guide for details on these procedures.

1.4.3 Testing Functional Companions in the Run-time Oracle Configurator

After you generate the Active Model and UI, you can test your Functional Companions in the run-time Oracle Configurator.

1.4.3.1 Testing with Oracle Configurator DeveloperTo start the run-time Oracle Configurator from Oracle Configurator Developer, and test your Functional Companion:

1. Start or restart Oracle Configurator Developer using a Java class path for your Oracle Configurator UI Servlet that includes the Functional Companion class file that you built.

2. Choose Tools > Options, select the Test tab, then choose "Dynamic HTML in a browser" as your test environment.

3. In the Servlet URL field, enter the URL of your Oracle Configurator OC Servlet, using this syntax:

http://host:port/configurator/oracle.apps.cz.servlet.UiServlet

Where host and port are specific to the installation of the Oracle Configurator OC Servlet at your site.

4. Close the Options dialog.

5. Click the Test button.

A web browser window opens, containing a DHTML rendering of the User Interface for your Model.

If you have previously used the Test button, the browser may not show your latest changes to the Model or User Interface, if the Model has been cached for efficient performance. You can force the UI Server to generate a new Model and User Interface by stopping and restarting the Oracle Configurator OC Servlet. A



less cumbersome way to reflect recent changes to the Model is to set the servlet property cz.uiservlet.dio_share to false, which disables caching. See the Oracle Configurator Installation Guide for details.

6. Click the button(s) that have been generated in the User Interface for your Functional Companion rules.

For more information, see the documentation indicated in the following table.

1.4.3.2 Testing with an HTML Test PageYou can test your run-time Oracle Configurator without having to run either Oracle Configurator Developer or your application. You can construct a simple HTML test page that takes the place of a host application. Opening the page in a web browser starts up the run-time Oracle Configurator in a predefined frame set, using the Model and User Interface that you specify inside that frame.

In order to use such a test page:

� You must provide an initialization message and its parameters in the page, as described in the Oracle Configurator Custom Web Deployment Guide.

� You must have installed and started the Oracle Configurator OC Servlet, as described in the Oracle Configurator Installation Guide.

Examples of HTML test pages are provided in the Oracle Configurator Custom Web Deployment Guide and the Oracle Configurator Installation Guide.

For details on ... See this section .. In this document ...

Testing in Oracle Configurator Developer

Test/Debug

Oracle Configurator Developer User’s GuideConfiguring items in run-time Oracle Configurator

Test/Debug

Modifying buttons in the User Interface

The User Interface

Setting InitServletURL in spx.ini

[Test] Oracle Configurator Implementation Guide

Installing the OC Servlet OC Servlet Considerations

Oracle Configurator Installation Guide

Setting up an HTML test page

Oracle Configurator Custom Web Deployment Guide



1.4.3.3 Test Functionality in the Run-time Oracle ConfiguratorThe Active User Interface for the run-time Oracle Configurator allows you to test your Functional Companions as appropriate:

Figure 1–5 illustrates testing a Functional Companion in an run-time Oracle Configurator generated by the Test button in Oracle Configurator Developer. The Functional Companion illustrated is the one defined in the example in Section 5.2, "Thin-Client generateOutput() Functional Companion" on page 5-2.

� The Output Functional Companion button has been relabeled "Show Model Structure", as suggested in "Modifying the Default User Interface" on page 1-15.

� Clicking the Functional Companion button produces a window that displays the structure of the Model tree, beginning at the Base Component associated with the Functional Companion rule. This output is shown in Figure 1–6 on page 1-21.

� There is no button for the Validate Functional Companion. The validate() method is run whenever there is a change in the value of an Option. If the value violates a specified range, or a configuration rule, then the application displays a Configuration Status message.

Type User Interface feature

Auto-configuration A button allows the user to run the autoConfigure() method on the associated Component instance.

Validation The validate() method is called automatically when the user selects anything.

Output A button allows the user to run the generateOuput()method on the associated Component instance.



Figure 1–5 Testing a Functional Companion in the Run-time Oracle Configurator.



Figure 1–6 Output Window Generated by Functional Companion Button



Using Functional Companions 2-1

2Using Functional Companions

This chapter describes some advanced techniques for using Functional Companions effectively in your application.

2.1 Controlling User Interface ElementsThe CIO provides a set of classes for creating Functional Companions that interact with a Dynamic HTML user interface in a browser.

Here is the class hierarchy of these classes:

IUserInterfaceIUserInterfaceNode

IUserInterfaceScreenIUserInterfaceControl

IUserInterfaceImageIUserInterfaceLabel

IUserInterfaceEventIUserInterfaceEventListener

These classes provide the following kinds of interaction:

Note: As you read this chapter, refer to the examples in Section 5.4, "User Interface Interaction" on page 5-9.

Type of interaction Examples

Access to UI session properties getting current screen or user information

Controlling User Interface Elements


ReferenceFor reference documentation, see: IUserInterface and related classes.

2.1.1 How the CIO Interacts with User InterfacesThe display of a user interface for Oracle Configurator is handled by the Oracle Configurator UI Server, which runs inside the Oracle Configurator Servlet.

As part of processing the initialization message for each configuration session, the UI Server is responsible for:

1. Creating or restoring a CIO configuration (which results in creating a runtime tree view of the configuration Model).

2. Creating the UI nodes on the runtime tree view.

3. Connecting the UI nodes with the corresponding nodes in the runtime instance of the configuration Model provided by the CIO.

As part of the configuration creation call (event 1, above), the UI Server also has to pass an argument to set a high-level UI interface reference, in the form of an IUserInterface object, such as uiSession in the following code fragment:

/*** UI SERVER code ***/

Configuration cioConfig;IUserInterface uiSession;...cioConfig = cio.createConfiguration(rootNodeId, uiSession);

Access to UI controls and some of their properties controls such as images, captions, or combo boxes

Custom UI functionality callbacks from DHTML controls

saving/restoring, navigation

Functional Companion callbacks callbacks for standard and custom events

Dynamic control over the navigation of UI screens being displayed

navigation

Dynamic control over images or labels in the screens changing images, changing captions

Direct communication channels with the user displaying message boxes, generating custom HTML content

Type of interaction Examples



...

All Functional Companions are able to get that reference back and use it to access other UI interfaces, or to register themselves to listen to UI events:

/*** FUNCTIONAL COMPANION example code ***/public void initialize(...) {...uiSession = cioConfig.getUserInterface();uiSession.addUserInterfaceEventListener(this);...

}

If Functional Companions need to perform some UI tasks, they have to register themselves in the Functional Companion’s initialize() method to listen for activation events. Such events are dispatched whenever a new UI tree branch has been built, such as when the UI tree is initially created, or when a Component instance is added.

After this point, every user interaction causes a UI event that is dispatched through the uiSession object to all interested listeners (see "Handling Interface Events" on page 2-8 for details).

As your Functional Companion code makes requests to manipulate the user interface (such as changing an image, or navigating to another screen), the UI Server caches the requests and keeps track of the current requested state of the UI.

Since it is possible that more than one Functional Companion is manipulating the user interface at the same time, the UI Server does not immediately render the results of your UI requests. The CIO checks the list of Functional Companions that are interacting with the UI; when all the Functional Companions are done with their UI requests, the results of the last Functional Companion are rendered in the client browser.

Note: User interface interaction through IUserInterface and related classes is only available when your user interface uses Dynamic HTML in a browser. It is not available with Java Applet or custom-coded interfaces.



2.1.2 Getting the Current ScreenHaving a reference to IUserInterface allows a Functional Companion to get access to various properties of the uiSession object, such as style, session ID, or user account information.

/*** FUNCTIONAL COMPANION example code ***/...style = uiSession.getType();sessionID = uiSession.getUiSessionID();...

Also available on the IUserInterface reference is the current display UI screen and UI nodes from the UI runtime tree

/*** FUNCTIONAL COMPANION example code ***/...IUserInterfaceScreen uiScreen = uiSession.getCurrentScreen();List uiCombos = uiSession.getNode("Feature-321",uiScreen);

// Now walk the list of nodes and check the types, to get the target node...IUserInterfaceControl uiCombo321 = uiCombos.get(targetNode);...

Note that because there can be many UI nodes having the same name, uiSession.getNode() returns a List. All nodes in such a list will share the same name. You must walk the list and determine which node has the desired type, then get it.

ReferenceFor reference documentation, see: IUserInterface.

2.1.3 Access to NodesUI node-specific properties are accessible through the IUserInterfaceNode interface:

/*** FUNCTIONAL COMPANION example code ***/

Note: It is not possible to guarantee the order in which multiple Functional Companions execute. Consequently, it is not possible to predict in advance which UI interaction will be rendered.



...IUserInterfaceNode myNode;...int type = myNode.getType();String name = myNode.getName();String caption = myNode.getUiCaption();...

You can check the type of the node, using the types provided by the IUserInterfaceNode interface:

...if (myNode.getType() == (IUserInterfaceNode.COMBO_BOX))...

See the documentation for IUserInterfaceNode for a list of the types.

You can also use IRuntime.getRuntimeNode() to obtain the runtime node, if any, that is associated with a UI node.

ReferenceFor reference documentation, see: IUserInterfaceNode.

2.1.4 Access to Screens and ControlsAny one of the subclass interfaces (such as IUserInterfaceScreen or IUserInterfaceControl) has UI-accessible properties:

/*** FUNCTIONAL COMPANION example code ***/...IUserInterfaceControl uiCombo321;IUserInterfaceScreen uiScreen = uiCombo.getScreen();List controls = uiScreen.getControls();...

ReferenceFor reference documentation, see: IUserInterfaceScreen and IUserInterfaceControl.



2.1.5 Access to Images and LabelsHaving a reference through IUserInterfaceImage allows access to the filename of the displayed image. An IUserInterfaceLabel reference can be used to access to the UI caption of a label (the method getUiCaption is available on all UI nodes):

/*** FUNCTIONAL COMPANION example code ***/...IUserInterfaceImage image;String filename = image.getFileName();...IUserInterfaceLabel label;String caption = label.getUiCaption();...

ReferenceFor reference documentation, see: IUserInterfaceImage and IUserInterfaceLabel.

2.1.6 Controlling NavigationAn important use of UI control through the CIO is the ability to navigate to different screens. It allows a Functional Companion to control the sequence of screens that your end user goes through, based on their selections. Based on preliminary screening selections, you can allow your end user to skip over screens that contain irrelevant choices.

Having a reference through IUserInterface allows you to navigate to any screen for which there is a given screen name. For this purpose the uiSession object will try to find a screen with the given name and navigate to it:

/*** FUNCTIONAL COMPANION example code ***/...uiSession.navigateToScreen("Screen322");...

Note that the UI Server now regards "Screen322" as the "current screen", though it may not have rendered its display yet. See "How the CIO Interacts with User Interfaces" on page 2-2.

But this navigation is more convenient if there is a reference to the screen:

/*** FUNCTIONAL COMPANION example code ***/...



IUserInterfaceControl uiCombo321;IUserInterfaceScreen uiScreen = uiCombo.getScreen();uiScreen.navigate();...

2.1.7 Controlling Images and LabelsBeing able to change the content of an image or label allows Functional Companions to control the way the end user sees the configured product based on their selections. For example, end users may want to see a different-colored image when they select from a combo box asking "Which color do you prefer?"

In order to be able to change the content of an image dynamically, it is necessary to have a reference to an image UI node, through IUserInterfaceImage:

/*** FUNCTIONAL COMPANION example code ***/...IUserInterfaceScreen uiScreen = uiSession.getCurrentScreen();List uiImages = uiSession.getNode("Image-322",uiScreen);IuserInterfaceImage uiImage322 = uiImages.get(0);...uiImage322.setFileName("Image322-1.jpg");...

For a full example, including deployment considerations, see Section 5.4.3, "Changing an Image" on page 5-14.

Similarly, the content of a label can be dynamically changed through a reference to a IUserInterfaceLabel:

/*** FUNCTIONAL COMPANION example code ***/...IUserInterfaceScreen uiScreen = uiSession.getCurrentScreen();List uiLabels = uiSession.getNode("Label-323",uiScreen);IuserInterfaceLabel uiLabel323 = uiLabels.get(0);...uiLabel323.setUiCaption("ABC");...uiLabel323.setUiCaption("DEF");

...



2.1.8 Generating Messages and Other OutputA useful capability is being able to control the result of a user click into a different frame. This allows you to enhance the look and feel of Oracle Configurator by customizing the UI into separate frames along with other information that you think might be useful to the user.

2.1.8.1 Message BoxesIn order to be able to simple create message boxes, the Functional Companion needs a IUserInterface reference:

/*** FUNCTIONAL COMPANION example code ***/...IUserInterface uiSession;...uiSession.addMessageBox(MESSAGE_BOX_MESSAGE,

"We don't have this in stock.","Warning");

...

2.1.8.2 Custom HTML OutputIf your Functional Companion needs to control the look of a separate frame you can output the custom HTML output directly, using the IUserInterface reference:

/*** FUNCTIONAL COMPANION example code ***/...IUserInterface uiSession;...uiSession.outputToFrame("Root:Frame1",

"<HTML> ... </HTML>");...

Note that the complex HTML output required for this approach is not illustrated in the code fragment shown here.

2.1.9 Handling Interface EventsIt is effective to trigger your Functional Companion in response to events taking place in the user interface.

The examples in Section 5.4, "User Interface Interaction" on page 5-9 all use event handling, by implementing IUserInterfaceEventListener.



2.1.9.1 Types of EventsAny kind of user action on the client machine is recorded and encapsulated into a UI event that the UI Server receives and dispatches to the "interested" Functional Companions.

The events that are recognized (such as POST_SAVE_CONFIGURATION or POST_CLICK) are fields of IUserInterfaceEvent.

ReferenceFor reference documentation, see: IUserInterfaceEvent.

2.1.9.2 Listener RegistrationAny "interested" Functional Companion object can be notified of a UI event. All it has to do is implement the interface IUserInterfaceEventListener and register itself as an event listener.

Note that listening is available for the Functional Companion as a whole, but not on individual UI nodes.

The following code fragment illustrates the registration of a UI event listener:

...IUserInterface uiSession;...public void initialize(IRuntimeNode node, String name, String descrip, int id) {...uiSession = this.getRuntimeNode().getConfiguration().getUserInterface();uiSession.addUserInterfaceEventListener(IUserInterfaceEvent.POST_CLICK, this);

}...

See Section 5.4, "User Interface Interaction", such as Example 5–5 on page 5-10, for fuller examples in context.

Event listeners registered on the IUserInterface reference can listen to events for all UI nodes.

The method addUserInterfaceEventListener(IUserInterfaceEventListener) is available on the IUserInterface interface and adds a listener to the specified dispatcher. Any number of listeners can be registered at any point to listen to events.

Controlling Parent and Child Windows


The complementary method, deleteUserInterfaceEventListener(IUserInterfaceEventListener) is also available, to unregister a listener in order to stop handling events.

Whenever an event is dispatched, each listener's handleUserInterfaceEvent(IUserInterfaceEvent) method is called with the event object as an argument.

It is not possible to guarantee the order in which multiple Functional Companions execute. Consequently, it is not possible to predict in advance the order in which the listeners will be invoked.

An event listener can also be registered to listen only to specific types of events. For example, if a Functional Companion needs to listen only to POST_CLICK events, then it has to register itself by using addUserInterfaceEventListener(POST_CLICK, IUserInterfaceEventListener) instead. This prevents all other types of events from being dispatched to this listener:

...uiSession.addUserInterfaceEventListener(IUserInterfaceEvent.POST_CLICK, this);...The events that are recognized are fields of IUserInterfaceEvent. See "Types of Events" on page 2-9.

2.2 Controlling Parent and Child WindowsYour application may require the ability to launch a child custom user interface from the Oracle Configurator DHTML window. This child UI might interact with the user and perform updates to the state of the configuration Model. When these interactions are finished, the child UI returns control to the parent window containing the Oracle Configurator DHTML interface.

Implementing the solution could require the features described in these sections:

� Section 2.2.1, "Locking, Unlocking and Refreshing Windows"

� Section 2.2.2, "Accessing a Shared Configuration Model"

2.2.1 Locking, Unlocking and Refreshing WindowsDuring the period of user interaction with the child UI window, you would probably wish to prevent any use of the parent window, since that might interfere with the changes to the state of the application or configuration Model being made in the child window.



You can use methods available through the source frame of the Oracle Configurator DHTML window to control the child and parent windows:

The use of these methods is illustrated in Section 5.5.1, "Locking, Unlocking and Refreshing Windows" on page 5-16.

2.2.2 Accessing a Shared Configuration ModelIf your application opens a child window in order to perform interaction with the Model that is not available in the Oracle Configurator DHTML window, other servlets that you may use in the same session should have access to the state of the configurationModel.

The example in Section 5.5.2, "Accessing a Shared Configuration Model" on page 5-18 illustrates how it is possible, during the initialization of a configuration session with the Oracle Configurator Servlet, to store the Configuration object under a new key in the HTTP session.

Method Action

lockEventManagers() locks the parent window while the child window is in use

unlockEventManagers() unlocks the parent window when the child window is closed

refreshFrames() refreshes the parent window with the results of changes made in the child window



The Configuration Interface Object (CIO) 3-1

3The Configuration Interface Object (CIO)

3.1 Background

3.1.1 What is the CIO?The Configuration Interface Object (CIO) is an API (application programming interface) that provides your programs access to the Model used by a run-time Oracle Configurator, which you construct with Oracle Configurator Developer.

The CIO is also used by Functional Companions. See Section 1.2, "Functional Companions and the CIO".

The CIO is a top-level configuration server. The CIO is responsible for creating, saving and destroying objects representing configurations, which themselves contain objects representing Products, Components, Features, Options, Totals and Resources. The runtime configuration model can be completely controlled and manipulated through these interfaces, using methods for getting and setting logical, numeric and string values, and creating optional subcomponents.

Internally, the CIO performs its tasks through interfaces to logic net objects (to get and set logic states), to runtime model subschema objects (to create the appropriate runtime Model based on the design-time model), and to configuration subschema objects (to save and restore configurations created by a user).

The Oracle Configuration Interface Object is written in Java, and implemented as a set of Java packages. The only public package, which you will need to import is:

oracle.apps.cz.cio

The CIO’s Runtime Node Interface Classes


3.1.2 The CIO and Functional CompanionsA Functional Companion is a Java client of the CIO.

Functional Companions are invoked by the CIO through the run-time Oracle Configurator, and Functional Companions call the CIO to get information from the running Model. The CIO is like a broker for the Active Model, in that it passes information both ways. Programmers writing Functional Companions need to have some knowledge of how to use the CIO.

Each Functional Companion is an object class. For every Component instance in your Model that is associated with a Functional Companion, the CIO creates an instance of this class.

3.2 The CIO’s Runtime Node Interface ClassesWhen you program against the CIO, you only create instances of the classes CIO(see Section 3.3, "Initializing the CIO") and Configuration (see Section 3.4.1, "Creating and Deleting Configurations"). You then use the public interfaces listed in Table 3–1 to access fields in the runtime node objects created by your instances ofCIO and Configuration. Apart from CIO and Configuration, your code should refer only to these public runtime node interface objects. You should not implement any of the runtime node interface classes, but only use them as references to runtime node objects.

These interfaces are all defined in the Java package oracle.apps.cz.cio.

Note: All references in this document to classes, methods, and properties refer to the package oracle.apps.cz.cio, and all code examples are in Java, unless otherwise stated.

Table 3–1 Runtime node interface classes for the CIO

Interface Role of implementing classes

IAtp Implemented by objects that can have ATP calculated.

IBomItem Implemented by all selectable BOM items.

ICompSetEventListener Implemented by objects that want to find out about added components.

The CIO’s Runtime Node Interface Classes


IConfigEventListener Implemented by objects that want to find out about added components. This listener's methods are called as the result of user interaction, after a functional companion is initialized. is class does not provided side-effecting (which is the ability to modify other nodes of the model).

ICount Implemented by objects that have an associated integer count.

IDecimal Implemented by objects that have a decimal value.

IDecimalMinMax Implemented by objects that have a decimal minimum and maximum value.

IFunctionalCompanion Implemented by Functional Companion objects attached to Components in order to provide programmatic functionality to a configuration model.

IInteger Implemented by objects that have an integer value.

IIntegerMinMax Implemented by objects that have an integer minimum and maximum.

IOption Implemented by objects that act as options. The defining characteristic of an option is that it can be selected and deselected.

IOptionFeature Implemented by objects that contain selectable options. This interface provides a mechanism for selecting and deselecting options, and for determining which options are currently selected.

IPrice Implemented by objects that can be priced.

IReadOnlyDecimal Implemented by objects that have a decimal value.

IRuntimeNode This interface implements behavior common to all nodes in the runtime configuration tree, including Components, Features, Options, Totals, and Resources.

IState Implemented by objects that have logic state. This interface contains a set of input states, used to specify a new state for an object, a set of output states, returned when querying an object for its state, and a set of methods for getting and setting the object's state.

IText Implemented by objects that have a textual value.

Table 3–1 (Cont.) Runtime node interface classes for the CIO

Interface Role of implementing classes

Initializing the CIO


The functionality underlying the CIO interfaces is implemented by other classes in oracle.apps.cz.cio, which are subject to revision by Oracle. This interface/implementer architecture protects your code from the effects of such revisions, since the interfaces will remain constant.

ReferenceFor reference documentation, see: Package oracle.apps.cz.cio.

3.3 Initializing the CIOIn order to use any of the features of the CIO, an application must initialize it, using a JDBC driver to make a connection to the Oracle Configurator schema. This connection enables the CIO to obtain and store data about Model structure, Configuration Rules, and User Interface.

If you are using the CIO in a custom user interface, you will have to initialize the CIO.

1. Import the necessary packages.

import java.sql.Connection;import java.sql.DriverManager;import java.sql.SQLException;

import oracle.apps.cz.cio.*;import oracle.apps.cz.common.*;

2. Load the database driver that you have installed. For instance, load one of the following:

Class.forName("com.ms.jdbc.odbc.JdbcOdbcDriver");Class.forName("sun.jdbc.odbc.JdbcOdbcDriver");Class.forName("oracle.jdbc.driver.OracleDriver");

Note: When you run Functional Companions through the run-time Oracle Configurator (or test them by using the Test button in Oracle Configurator Developer), this initialization and connection work is automatically handled for you by the application; you do not have to write your own code to initialize the CIO.

Initializing the CIO


3. Create a context object and pass to it the information needed to make a database connection: the database URL, the user ID and password of the current user, and the owner of the database. The context object manages the database connection; you should not create a separate connection object (e.g., with java.sql.DriverManager.getConnection).

contextObject = new ("jdbc:subprotocol:datasource", "userID", "password","schemaOwner");

4. Create a CIO object.

CIO cioObject = new CIO();

Example 3–1 shows how Steps 1 through 4 are combined together. See Section 5.1, "Initializing the CIO" for a fuller example of initializing the CIO.

Example 3–1 Initializing the CIO (short example)

import java.sql.Connection;import java.sql.DriverManager;import java.sql.SQLException;

import oracle.apps.cz.cio.*;import oracle.apps.cz.common.*;

public class InitCIO{

private void InitializeCIO() throws SQLException{CIO cio;context;

try{Class.forName("com.ms.jdbc.odbc.JdbcOdbcDriver");}catch (ClassNotFoundException c){System.out.println(c);}

context = new ("jdbc:oracle:thin:@server01:1521:sid01", "applsyspub", "pub","apps");cio = new CIO();

}}

Access to Configurations


3.4 Access to ConfigurationsThe Configuration object, oracle.apps.cz.cio.Configuration, represents a complete configuration. You can use the CIO to work with multiple configurations within the same session.

A configuration communicates through the Configuration object. It supports accessing the containing CIO, the root Component, the project ID, a collection of current validation failures, access to any runtime node based on its runtime ID, and an indication if the complete configuration is satisfied. In addition, there are methods for starting, ending, and rolling back configuration-level logic transactions; these transactions are to maintain logic consistency and are not database transactions. See Section 3.4.4, "Logic Transactions".

ReferenceFor reference documentation, see: Configuration.

3.4.1 Creating and Deleting ConfigurationsUse CIO.createConfiguration() to create a Configuration object, which is the top-level entry point to a configuration. There are different ways to create a Configuration, depending on your requirements.

� To create a Configuration using the name of a Project as specified in Oracle Configurator Developer, use this form:

createConfiguration(java.lang.String projectName,oracle.apps.fnd.common.Context ctx)

� To create a Configuration using the ID of the root node of your Model, use this form:

createConfiguration(int rootNodeID,oracle.apps.fnd.common.Context ctx)

To determine the root node ID, you would query the Oracle Configurator schema, which is described in the Oracle Configurator Technical Reference Manual. Such a query might be:

SELECT PS_NODE_ID FROM CZ_PS_NODES WHERE NAME = 'CN9744';

Both ways of creating a Configuration object require a database context object, as discussed in Step 3 of Section 3.3 on page 3-4.

For reference documentation on the database context object, see: CZContext.



� To delete all runtime structure and memory associated with a configuration, use CIO.closeConfiguration()

� To define behavior that will be executed whenever a newly-created configuration is activated, define it in an onNew() method of the class AutoFunctionalCompanion. For reference, see AutoFunctionalCompanion on page B-8.

� To get the CIO that created the configuration, useConfiguration.getCIO().

Example 3–2 Creating new Configuration objects

// create the database context objectctx = new ("jdbc:oracle:thin:@server01:1521:sid01", "applsyspub", "pub","apps");// create Configuration using Project name and Contextcfg_prj = createConfiguration(“Project 10”, ctx);

// create Configuration using ID of root node of Model and Contextcfg_id = createConfiguration(1221, ctx);

3.4.2 Saving and Restoring ConfigurationsUse Configuration.saveNew()to Save an entirely new Configuration object into the Oracle Configurator schema.

Use Configuration.save() to save subsequent changes to a Configuration object created with saveNew(), or to a Configuration object restored with CIO.restoreConfiguration().

Use CIO.restoreConfiguration() to restore a Configuration object from the Oracle Configurator schema.

Use Configuration.saveNewRev() to save a new revision of the restored Configuration object.

Use Configuration.saveAs(configHeaderID, revNumber) to save the current Configuration object over a different Configuration already saved in the database. You use the configHeaderID and revNumber to open a configuration header object and replace the configuration in it.



Use Configuration.restartConfiguration() to restart the current configuration instance without destroying the objects that are being configured. You may be able to save significant processing time by not re-validating the configuration after restarting it, since you have validated it once already.To define behavior that will be executed before a configuration is saved, or after it is restored, define it in the onSave() or onRestore() methods of the class AutoFunctionalCompanion. For reference, see AutoFunctionalCompanion on page B-8.

3.4.3 Access to Configuration ParametersIf you are using Oracle Configurator in a web deployment, you can use the CIO to allow a Functional Companion to obtain a list of the configuration inputs (initialization parameters) that were passed from your application to your configuration Model.

Create a Functional Companion that callsConfiguration.getInitParameters(), which returns a NameValuePairSet object. This object contains all the parameter values stored by the Oracle Configurator UI Server when it processed the initialization message sent by your application to the Oracle Configurator OC Servlet.

See the Oracle Configurator Custom Web Deployment Guide for more information.

ReferenceFor reference documentation, see: NameValuePairSet.

3.4.4 Logic TransactionsIn order to help you maintain consistency in interactions with the Oracle Configurator logic engine, you can use configuration-level logic transactions. A logic transaction comprises all the logical assertions that constitute a user interaction. At the end of a transaction, the CIO returns a list of all validation failures. See Section 3.8, "Validating Configurations".

Note: Do not save a Configuration object during a logic transaction (see Section 3.4.4). You may miss some validation messages that are not available until the transaction is committed.



The Configuration object, oracle.apps.cz.cio.Configuration, provides a set of methods for starting, ending, and rolling back configuration-level logic transactions. Note that logic transactions are not database transactions.

Inside a transaction, the normal course of action is to set the logical states and numeric values of runtime nodes (as described in Section 3.5.5 and Section 3.5.6).

� Use Configuration.beginConfigTransaction() to create a new transaction, returning a ConfigTransaction object. After performing the desired series of operations (e.g., setting states and values), you must end, commit, or roll back the transaction by passing the ConfigTransaction object to one of the mutually exclusive methods that finish the transaction:

endConfigTransactioncommitConfigTransactionrollbackConfigTransaction

� Configuration.endConfigTransaction(transaction) ends the transaction begun with beginConfigTransaction(), without committing it (thus skipping validation checking).

� Configuration.commitConfigTransaction(transaction) commits the given transaction or series of nested transactions, propagates the effect of user selections throughout the configuration Model, and triggers validation checking (see Section 3.8, "Validating Configurations").

� Configuration.rollbackConfigTransaction(transaction)rolls back the unfinished transaction, undoing the operations performed inside it.

You can nest intermediate transactions with beginConfigTransaction() andendConfigTransaction, delaying validation checking until you call commitConfigTransaction(). You must end or commit inner transactions before ending or committing the outer ones that contain them. When rolling back unfinished transactions, with rollbackConfigTransaction(), you can roll back outer transactions, which automatically rolls back the inner transactions.

When beginning a transaction, you can automatically commit it, by setting the optional boolean autoCommit argument to beginConfigTransaction() to TRUE. If no argument is set, then the transaction inherits the autocommit state of its parent (outer) transaction. If an outer transaction sets autoCommit to TRUE, then inner transactions can override it to either TRUE or FALSE. If an outer transaction sets autoCommit to FALSE, then inner transactions cannot override it; they will always inherit FALSE.



Transactions should also be used when you employ initial requests. See Section 3.9.3, "Initial Requests".

There are situations in which you must take care to commit a transaction at the appropriate time. The fragmentary code in Example 3–3 illustrates the need for wrapping a common operation inside a transaction to insure that the operation’s effects are reflected in other parts of the program. Example 5–3, "Setting initial requests (InitialRequestTest.java)" on page 5-5 also illustrates the use of transactions.

Example 3–3 Using a logic transaction with a deletion

Component comp;ComponentSet compSet;ConfigTransaction tr;Configuration config;

// ----------------------------------------------------------// This sequence produces unintended results:...// Add a component:comp = compSet.add();...// User selects a child of compSet (interactively)....// Delete the component:compSet.delete(comp);...// User wants to see the list of all selected nodes:collec = config.getSelectedItems();// The returned collection includes children of the deleted component,// because no transaction was commited.

// ----------------------------------------------------------// This sequence produces the intended results:...// Add a component:comp = compSet.add();...// User selects a child of compSet (interactively)....// Delete the component, inside a transaction:tr = config.beginConfigTransaction();compSet.delete(component);config.commitConfigTransaction(tr);

Access to Nodes of the Model at Runtime


...// User wants to see the list of all selected nodes:collec = config.getSelectedItems();// The returned collection does NOT include children of the deleted component,// because the deletion transaction was commited.

ReferenceFor reference documentation, see: Configuration and ConfigTransaction.

3.5 Access to Nodes of the Model at RuntimeThe root Component, and every other node in the underlying runtime Model tree, implements the IRuntimeNode interface. This interface exposes the type of the node (based on a set of node type constants), its name, the database ID, the database node of which this runtime node is an instance, a runtime ID that is unique to this node across all nodes created by this particular CIO, the parent node (which is null for the root Component), a (possibly empty) collection of children, and information about whether this part of the runtime tree has been satisfied. See Section 3.6, "Introspection through IRuntimeNode".

Use IRuntimeNode.getConfiguration() to get the configuration to which a node belongs.

ReferenceFor reference documentation, see: IRuntimeNode.getConfiguration().

3.5.1 Opportunities for Modifying the ModelThere are some restrictions on when you can modify the Model.

� Normally, you should use an Auto-configuration Functional Companion to perform such modifications. To do so, you perform the actions in the body of the IFunctionalCompanion.autoConfigure() method. Your end user invokes the Auto-configuration companion by clicking a button in the User Interface. See "The autoConfigure() Interface Method" on page 3-33.

� If you want to modify the Model automatically when a configuration instance is created, restored, or saved (for instance, to perform certain selections when the configuration session begins or ends), you must use the methods of the class AutoFunctionalCompanion. For reference, see AutoFunctionalCompanion on page B-8.



� If you want to apply a set of logic requests to a configuration when it is created, you define a set of initial requests. See "Initial Requests" on page 3-28.

� You should never modify the Model in a Initialization Functional Companion (i.e., in the IFunctionalCompanion.initialize() method). See "The initialize() Interface Method" on page 3-31.

� You should never modify the Model in a Validation Functional Companion (i.e., in the IFunctionalCompanion.validate() method). See "The validate() Interface Method" on page 3-34.

3.5.2 Accessing ComponentsUse Component.getFunctionalCompanions() to return a list of all the Functional Companions associated with this Component.

3.5.3 Adding and Deleting Optional ComponentsA ComponentSet object represents a set of similar Components that can be added and deleted dynamically. Each Component set implements the IRuntimeNode interface.

Use ComponentSet.add() to an optional Component. The add() method can throw a LogicalException exception if adding the Component causes a logical contradiction.

Use ComponentSet.delete(component) to delete an optional Component.

3.5.4 Accessing FeaturesThere are several specialized types of Features. Each Feature type supports the IRuntimeNode interface, enabling you to use its general methods for working with runtime nodes (see "Introspection through IRuntimeNode" on page 3-18). Each type also supports its own interface with appropriately specialized methods.

BooleanFeatures have a boolean (true/false) value.

CountFeatures have both a boolean value, and an associated integer-valued numeric count. The minimum value of the count must be greater than or equal to zero. The boolean value of a CountFeatures object is returned by its methodshasMax() and hasMin().

IntegerFeatures have an integer numeric value. The value can be positive, negative, or zero.



DecimalFeatures have a floating point value.

TextFeatures have a string value.

OptionFeatures have a logic value, and a set of options as children. You can use the methods getMinSelected() and getMaxSelected(), of IOptionFeature, to determine the minimum and maximum number of a Feature’s child Options that can be selected. If you do, first use hasMinSelected() or hasMaxSelected()to determine whether there is a minimum or maximum number of Options.

3.5.5 Getting and Setting Logic StatesTo interact with objects that have logic state, you implement the IState interface. This interface contains:

� a set of input states, used to specify a new state for an object

� a set of output states, returned when querying an object for its state

Note: If, in Oracle Configurator Developer, you set the minimum count of a Feature greater than or equal to zero, then the CIO treats this as a CountFeature object. If you set the minimum count less than zero, then the CIO treats this as a IntegerFeature object.

FALSE The input state used to set an object to false.

TRUE The input state used to set an object to true.

TOGGLE The input state used to turn an object state to true if it is false or unknown, and to make it unknown or false if it is true.

LFALSE The logically false output state, indicating that the state is false as a consequence of a rule.

LTRUE The logically true output state, indicating that the state is true as a consequence of a rule.

UFALSE The user false output state, indicating that a user has set this object to false.

UNKNOWN The unknown output state.

UTRUE The user true output state, indicating that a user has set this object to true.



� a set of methods for getting and setting the object's state

Example 3–4 Getting the state of a node

//get the necessary components from the configuration // line 61baseComponent = (oracle.apps.cz.cio.Component)comp_node.getChildByName("Component-1");

of = (OptionFeature)baseComponent.getChildByName("Feature-1");op = (Option)of.getChildByName("Option-1");intFeat = (IntegerFeature)baseComponent.getChildByName("IF-1");//check if the option is set to UTRUE. If so, set the Integer value

to 5if( op.getState() == IState.UTRUE )

intFeat.setIntValue(5);}

Using isUnknown() is important when a node is cast to a class such asIntegerNode or ReadOnlyDecimalNode. When the numeric value of the node is zero, a zero value can mean either UNKNOWN (if no value has been set by the user) or KNOWN (if the value has been set to zero by the user).

Example 3–5 Setting the state of a node

The following code fragment, which uses setState() with TOGGLE, toggles the state of the selected item in the Model tree.

private void toggleSelectedItem() {IState node = (IState)tree.getLastSelectedPathComponent();try {node.setState(IState.TOGGLE);

}catch (LogicalException le) {}

getState() Gets the current logic state of this object.

setState(int state) Change the current logic state of this object.

unset() Retracts any user selection made toward this node

isFalse() Tells whether this feature is in false state.

isTrue() Tells whether this feature is in true state

isUser() Tells whether this feature is in a user specified state.

isLogic() Tells whether this feature is in a logically specified state.

isUnknown() Tells whether this feature is in unknown or known state.



catch (TransactionException te) {}

tree.repaint();

You should not use the TOGGLE state unless you are working with a user interface (see Section 2.1, "Controlling User Interface Elements" on page 2-1). If you don’t need to render the result in the interface—for instance, if you are using batch validation—then it is much more efficient to set the state directly:

node.setState(IState.TRUE);...node.setState(IState.FALSE);

If you do need to use TOGGLE, do not turn off defaulting, because the CIO must turn defaulting on in order to determine the correct state to toggle to. This operation impairs performance.

3.5.6 Getting and Setting Numeric ValuesYou can use the following methods to get and set the values of objects that have numeric values.

For decimal values, use:

IDecimal.setDecimalValue()IReadOnlyDecimal.getDecimalValue()

For integer values, use:

IInteger.setIntValue()IInteger.getIntValue()

The code fragment in Example 3–6 uses setIntValue() to change the value of an Integer Feature. Note that you can use the generalized IRuntimeNode interface for flexibility in selecting a child node, and then cast the node object to a particular interface to perform the desired operation on it.

Example 3–6 Setting a numeric value

// select a node by nameIRuntimeNode limit = baseComp.getChildByName("Current Limit");

// use an interface cast to set the node’s value by the desired type((IInteger)limit).setIntValue(5);



To determine whether a numeric value has violated its Minimum or Maximum range, you may need to iterate through the collection of validation failures returned by Configuration.getValidationFailures() after setting a value, for instance with IInteger.setIntValue(). See Section 3.8, "Validating Configurations" for more background.

There is a subtlety that you should take note of. IDecimal.setDecimalValue()does not throw a LogicalException when setting the value of a decimal feature that exceeds the feature's Min/Max limits. The collection of validation failures returned by Configuration.getValidationFailures() does not include any failures that result from setting a numeric value until the logic transaction has been closed, so there is no way to roll back a transaction in which a Min/Max violation has occurred. Here is a suggested method for dealing with this situation:

1. Open a transaction.

2. Set the new value.

3. Close the transaction.

4. Get the collection of validation failures for the configuration.

5. If the last transaction caused a Min/Max violation, then call Configuration.undo(), which retracts the last transaction.

This situation illustrates why it is a good practice to perform the setting of a single value inside a logic transaction. You can always undo it if the result is unsatisfactory.

3.5.7 Accessing PropertiesYou can determine which Properties belong to a runtime node, then use methods of the class Property to obtain information about the Properties.

Use IRuntimeNode.getProperties() to get a collection of the properties associated with a node.

Use IRuntimeNode.getPropertyByName() to get a particular property of a node, based on its name.

When you have the Property, use methods of the class Property, such asgetStringValue(), to obtain specific information.



3.5.8 Access to OptionsOption features have special methods for selecting options and querying for selected options. The selectOption() method implements mutual exclusion behavior for option features with a min/max of 1/1 by deselecting a currently selected option before selecting the new option. The getSelectedOption() method throws the TooManySelectedException if more than one option is selected in the feature.

An option is a child of an option feature which supports a true/false logic state and a count. Options implement the IRuntimeNode interface.

You can use the interface class IOption to select, deselect, and determine the selection state of Options.

The code fragment in Example 3–7 displays a “check” icon if an Option of a runtime node is selected, and displays an “unsatisfied” icon if the node is logically unsatisfied:

Example 3–7 Testing whether an option is selected, or satisfied

IRuntimeNode rtNode = (IRuntimeNode)value;if (value instanceof IOption) {IOption optionNode = (IOption)value;if (optionNode.isSelected()) {setIcon(checkIcon);

}} else if (rtNode.isUnsatisfied()) {setIcon(unsatIcon);

}return this;

Table 3–2 Methods of the interface class IOption

Method Action

deselect() Deselect this Option.

isSelected() Returns true if this Option is selected, and false otherwise.

select() Select this Option.

Introspection through IRuntimeNode


3.6 Introspection through IRuntimeNodeYou can get information about a node in a Model at runtime by using methods of the interface class IRuntimeNode. This helps you to write “generic” Functional Companions, which can interact with a Model tree dynamically, without having prior knowledge of its structure.

Table 3–3 Methods of the interface class IRuntimeNode

Method Action

getChildByID(id) Gets a particular child identified by its ID.

getChildByName(name) Gets a particular child identified by its name.

getChildren() Gets the children of this runtime configuration node.

getChildrenByType(type) Gets all of the children of a particular type.

getConfiguration() Gets the configuration to which this node belongs.

getDatabaseID() Gets the database ID of the node. This is the field CZ_PS_NODES.PS_NODE_ID in the Oracle Configurator schema, described in the Oracle Configurator Technical Reference Manual.

getDescription() Returns the design-time description of the runtime node.

getName() Gets the name of the node.

getParent() Gets the parent of the node.

getProperties() Returns a collection of the properties associated with this node. The collection contains items of the type Property.

getPropertyByName(name) Returns a particular property of the node, based on its name. Returns null if a property of the given name does not exist.

getRuntimeID() Gets the runtime ID of the node.

getSelectionLineID() Returns selection line ID (configuration output database ID) for node.

getType() Gets the type of this node.

hasCount() Returns true if the node has an object count.

hasDecimalValue() Returns true if the node has a decimal value.

hasDescription() Returns true if there is a design-time description of the runtime node.

hasSelectionLineID() Returns true if node has a selection line ID (configuration output ID), false if no

Introspection through IRuntimeNode


ReferenceFor reference documentation, see the Methods summary for: IRuntimeNode.

The code fragment in Example 3–8 displays a “check” icon if an Option of a runtime node is selected, and displays an “unsatisfied” icon if the node is logically unsatisfied:

Example 3–8 Testing whether a node is selected, or satisfied

IRuntimeNode rtNode = (IRuntimeNode)value;if (value instanceof IOption) {IOption optionNode = (IOption)value;if (optionNode.isSelected()) {setIcon(checkIcon);

}} else if (rtNode.isUnsatisfied()) {setIcon(unsatIcon);

}return this;

The code fragment in Example 3–9 creates a Configuration object config, sets homeTheater to the root Component of the configuration, and sets userType to the child node with the user-visible name “User Type”.

Example 3–9 Getting a child node by name

Configuration config = m_cio.createConfiguration(m_product);IRuntimeNode homeTheater = config.getRootComponent();

hasState() Returns true if the node has a logical state.

hasTextValue() Returns true if the node has a text value

isNative() Returns true if this is a native BOM node.

isUnsatisfied() Returns true if this particular node, or any one of its children, has not been completely configured.

isUnsatisfiedNode() Returns true if this particular node has not been completely configured.

toString(description) Returns a String representation of this node, based on whether the client demands a description (if there is one) or just a name.

Table 3–3 (Cont.) Methods of the interface class IRuntimeNode

Method Action

Handling Logical Contradictions


IRuntimeNode userType = homeTheater.getChildByName("User Type");

Example 3–10 Collecting all child nodes by type

//get all the text features // line 167textFeatList = comp.getChildrenByType(comp.TEXT_FEATURE);traverseTree(comp.getChildren(),

comp.TEXT_FEATURE,textFeatList);

iter = textFeatList.iterator();

3.7 Handling Logical ContradictionsWhen you make a logic request to modify the state of a logic network, for instance by using IState.setState(state), the result may be a failure of the request because of a logical contradiction. Such a failure will create and throw a logical exception, accessed through either the LogicalException or LogicalOverridableException objects. A LogicalException cannot be overriden.

See "Overriding Contradictions" for details on using LogicalOverridableException to override the contradiction.

Use LogicalException.isOverridable() to determine whether the exception is an instance of LogicalOverridableException, which can be overriden with its override() method.

Use LogicalException.getCause() to get the runtime node that caused the failure.

Use LogicalException.getReasons()to get a list of reason strings for the failure.

Use LogicalException.getMessage() to provide a message containing either the cause or the reasons.

ReferenceFor reference documentation, see: LogicalException.



3.7.1 Generating Error Messages from ContradictionsYou can use the Reason object to wrap the information returned by a contradiction, in order to include information about internal error messages.

Reason(int type,IRuntimeNode node,java.lang.String msg)

Constructs a Reason given all of its information:

Use Reason.getMsg()to get the message associated with this reason.

Use Reason.getNode()to get the node associated with this reason.

Use Reason.getType()to get the type of reason held in this object.

Use Reason.toString()to convert this object to a string.

ReferenceFor reference documentation, see: Reason.

3.7.2 Overriding ContradictionsYour run-time Oracle Configurator or Functional Companion can provide a message to your user, and ask whether the contradiction should be overridden.

If a logical contraction can be overriden, then a LogicalOverridableException is signalled, instead of a LogicalException.LogicalOverridableException is a subclass of LogicalException that adds an override() method. Use LogicalOverridableException.override()to override the contradiction.

Both types of exceptions (LogicalException andLogicalOverridableException) may be thrown back from any of the "set" methods (like setState()) or from Configuration.commitConfigTransaction(transaction). If you want to override the overridable exception you have to call its override() method, which can also throw a LogicalException. This means that even when you try to override the exception you still trigger a contradiction and cannot continue. If the

type What type of reason this is.

node The node that caused the problem.

msg The message returned.



override succeeds then you still need to call commitConfigTransaction() to close the transaction. If you don't want to override or if you get a LogicalException you need to call rollbackConfigTransaction(transaction) to purge it. Example 3–11 is a code fragment that illustrates this point. Note that the operations represented with <ASK “text”> and <SHOW “text”> are not part of the CIO but suggest where your own Functional Companion should try to handle the situation.

Example 3–11 Handling and overriding Logical Exceptions

try {// begin a transaction

ConfigTransaction tr = config.beginConfigTransaction();

// call the "set" methodopt1.setState(IState.TRUE);// commit the transaction

config.commitConfigTransaction(tr);}catch(LogicalOverridableException loe) {proceed = <ASK "Do you want to override?">;if (! proceed) {rollbackConfigTransaction();

}else {try {

// override the contradiction and ...loe.override();// ... finish the transaction

commitConfigTransaction();}catch (LogicalException le) {

// we cannot do anything<SHOW "Cannot be overriden">config.rollbackConfigTransaction(tr);

}}

}catch (LogicalException le) {

// we cannot do anything<SHOW "Cannot be overriden">config.rollbackConfigTransaction(tr);

}



ReferenceFor reference documentation, see: LogicalOverridableException.

3.7.3 Raising ExceptionsWhen a Functional Companion is invoked, the Oracle Configurator UI Server wraps a transaction around this invocation.

If a contradiction occurs, and it is not handled in your code, and is not rolled back inside the Functional Companion, this may result in a fatal exception. If there is a fatal exception, the UI Server kills the configuration session (dropping any open transactions), and throws a FunctionalCompanionException, which displays a message to the end user. The user’s configuration is ended.

If your Functional Companion handles an error by throwing a FuncCompErrorException, the UI Server displays the message that you specify to the end user, and rolls back the transaction. The user ’s configuration session is allowed to continue.

If the error throws a LogicalException, the UI Server displays a message to the end user, and rolls back the transaction. The user’s configuration session is allowed to continue.

If the error throws a RuntimeException, the UI Server kills the user’s configuration session. The UI Server continues to operate, and your end user can begin a new configuration session.

In the previous version of the CIO, you could throw aFuncCompMessageException, which is now deprecated, but is retained for backward compatibility with existing code. A FuncCompMessageException allowed you to present a dialog box displaying a specified message, and the name of the Functional Companion that raised the exception. When the end user dismissed the dialog box, the UI Server committed the open CIO transaction, and allowed the end user to proceed with the configuration session. It was possible that the Model could be left in an uncertain state. This situation could be a particular problem for auto-configuration Functional Companions.

Warning: The class FuncCompMessageException is now deprecated, but is retained for backward compatibility with existing code.

Validating Configurations


ReferenceFor reference documentation, see: FuncCompErrorException.

3.8 Validating ConfigurationsYou want to be able to check whether a Configuration is valid (that is, does not violate the rules associated with it).

The CIO validates a Configuration after all logical assertions that constitute a user interaction are performed. This corresponds exactly to the length of a logical transaction. See Section 3.4.4, "Logic Transactions".

Validation checking and reporting occur when a logical transaction is ended by using Configuration.commitConfigTransaction(transaction) or Configuration.rollbackConfigTransaction(transaction).

After a committal or rollback, the CIO traverses the nodes of the Model, checking for validation failures, selected items and unsatisfied items. These are kept in a set of collections maintained on the Configuration.

At this point, you can call the following methods of oracle.apps.cz.cio.Configuration:

As nodes become selected they have a status of STATUS_NEW. If they continue to be selected since the last transaction their status is STATUS_EXISTING. If they become unselected, their status becomes STATUS_DELETED until the next transaction at which time they will be removed from the collection.

If you are writing a Functional Companion, the validate() method should return a list of CompanionValidationFailure objects in the event of a validation

getValidationFailures() Actually returns a collection of "ValidationFailure" objects. Call this after committing or rolling back a transaction, in order to inspect the list of validation failures.

getSelectedItems() Returns a collection of selected items as a StatusInfo structure indicating the set of selected (true) items in the Configuration.

getUnsatisfiedItems() Returns a collection of unsatisfied items as a StatusInfo structure indicating the set of unsatisfied items in the Configuration.

Validating Configurations


failure. This allows you to return more than one failure. Your validate() method can include several tests; you can track which ones failed, and why. (See Section 3.10.3 on page 3-34 for information about the validate() method.)

If the validation fails, then information about the failure is gathered by the CIO in a List of CompanionValidationFailure objects. In general, if a Functional Companion needs to return a violation message about a particular runtime node, you have to create a CompanionValidationFailure object and pass it the runtime node and the message.

Example 3–12 Returning a list of validation failures

public class Test extends FunctionalCompanion implements IFunctionalCompanion{...IRuntimeNode node;ArrayList failures = new ArrayList();...//check to see if the value in the config is not at least the min valueif( !(val >= min) )

failures.add( new CompanionValidationFailure("Value less than minimum",node,this) );

if(failures.isEmpty())return null;

elsereturn failures;

...}

If, though, the violation persists after the next user action, the Functional Companion shouldn't need to create a new CompanionValidationFailure, but should instead return the same object. This prevents the CIO from returning the already known violation message as a new violation message, which might be annoying for the user.

ReferenceFor reference documentation, see: ValidationFailure and Configuration.

Using Requests


3.9 Using RequestsA logic request is an attempt to modify a configuration by setting the logical state or numeric value of a node in the configuration Model (such as an Option or BOM Item), using methods such as:

� Requests that set a state or value, such as those listed in Table 3–4, are called user requests. See "User Requests" on page 3-27.

� You can code a set of user requests that are applied to a new configuration when it is created. These are called initial requests. See "Initial Requests" on page 3-28.

� When user requests fail, due to an override, the CIO generates a list of these failed requests. See "Failed Requests" on page 3-30.

� You can get information about a request, by interrogating an instance of the Request object. See "Getting Information about Requests" on page 3-26.

3.9.1 Getting Information about RequestsThe class oracle.apps.cz.cio.Request exposes logic requests. A Requestobject can be used to represent several kinds of requests, as described in "Using Requests" on page 3-26.

You can create a Request object and pass its constructor the runtime node on which the request has been made, and a string that is the value of the request.

Request req = new Request(node, value);

The Request object provides a set of methods for determining the value of the request, and the runtime node on which the request has been made:

� getNumericValue()

� getValue()

Table 3–4 Typical methods used to make requests

Method Described In ...

IState.setState(state) Getting and Setting Logic States on page 3-13

ICount.setCount(count) Getting and Setting Numeric Values on page 3-15

IOPtion.select() Access to Options on page 3-17

Using Requests


...

3.9.3 Initial RequestsYou can specify a set of logic requests to be applied to every new configuration as the configuration is created. Such requests are called initial requests.

You apply initial requests automatically on the creation of a configuration, following the practice illustrated in Example 3–13 on page 3-29 and in the following steps:

1. Define a Functional Companion that extends the classAutoFunctionalCompanion.

public class compInitReq extends AutoFunctionalCompanion { ... }

For reference, see AutoFunctionalCompanion on page B-8.

2. In the class, invoke the onNew() method of AutoFunctionalCompanion, which is called right after the activation of a newly-created configuration.

public void onNew() throws LogicalException { ... }

3. In the onNew() method, begin a configuration transaction, using Configuration.beginConfigTransaction(), with or without theautoCommit argument.

IRuntimeNode node = getRuntimeNode();ConfigTransaction tr = node.getConfiguration().beginConfigTransaction();

See "Logic Transactions" on page 3-8 for details about transactions.

4. Specify that the transaction will contain initial requests, usingConfigTransaction.useInitialRequests().

tr.useInitialRequests();

5. Specify the desired user requests using the appropriate methods.

BooleanFeature feat = (BooleanFeature)node.getChildByName("Feature_1234");feat.setState(IState.TRUE);

See "Using Requests" on page 3-26 for details about setting logic requests.

6. When you have set all the desired initial requests, commit the logic transaction.

Using Requests


node.getConfiguration().commitConfigTransaction(tr);

These steps are combined in Example 3–13. For a fuller example of using initial requests, see Example 5–3, "Setting initial requests (InitialRequestTest.java)" on page 5-5.

Example 3–13 Using initial requests

import oracle.apps.cz.cio.*;

public class compInitReq extends AutoFunctionalCompanion{public void onNew() throws LogicalException {try {IRuntimeNode node = getRuntimeNode();ConfigTransaction tr = node.getConfiguration().beginConfigTransaction();tr.useInitialRequests();BooleanFeature feat = (BooleanFeature)node.getChildByName("Feature_1234");feat.setState(IState.TRUE);node.getConfiguration().commitConfigTransaction(tr);

} catch (Exception e) {e.printStackTrace();

}}

}

3.9.3.1 Usage Notes on Initial Requests� You can think of a transaction that includes

ConfigTransaction.useInitialRequests() (as illustrated in steps 3 on page 3-28 and 4 on page 3-28) as putting the CIO in "initial request mode". You can nest any number of subtransactions within this transaction; the requests in these subtransactions all inherit this mode of being initial requests. You can perform overrides and rollbacks as you would with ordinary user requests. You must commit or roll back the initial-request transaction, as in step 6, to indicate the conclusion of the initial requests. You can then specify other user requests in your Functional Companion.

� When you save a configuration that includes initial requests, the initial requests are saved as part of the configuration. When you restore such a configuration, with CIO.restoreConfiguration(), the initial requests are reapplied to the configuration.

Standard Interface Methods for Functional Companions


3.9.3.2 Limitations on Initial Requests� Initial requests can only be specified when a new configuration is activated, by

using the onNew() method of AutoFunctionalCompanion.

� After you apply initial requests to a configuration, you cannot override any of the initial requests with user requests. Attempting to override an initial request will result in a LogicException.

� You must specify all initial requests before specifying any user requests. Attempting to open a transaction with initial requests after specifying an ordinary user request will result in an InitialRequestException.

� If you use the onRestore() method of AutoFunctionalCompanion, which is called after a configuration is restored, you cannot specify any additional initial requests. The existing set of initial requests on the saved configuration is restored.

� You cannot use initial requests to add or delete Components.

3.9.4 Failed RequestsWhen you use LogicalOverridableException.override() to override a logical contradiction (see Section 3.7.2, "Overriding Contradictions" on page 3-21), the override() method returns a List of Request objects. These Request objects represent all the previously asserted user requests that failed due to the override that you are performing.

See Section 5.3.2, "Getting a List of Failed Requests" on page 5-7 for an example.

3.10 Standard Interface Methods for Functional CompanionsYou provide functionality for your Functional Companion by implementing body code for the methods described in this section. For particulars that apply to the languages currently supported by the CIO, and examples, see Section 1.3, "Building Functional Companions in Java".

These methods are invoked by the run-time Oracle Configurator, through the CIO, in response to program events or the actions of end users. The type of method invoked for each Component is determined when you associate the Component with a Functional Companion in Oracle Configurator Developer. See Section 1.4, "Incorporating Functional Companions in Your Configurator" for details.

These methods are invoked by the CIO for each Functional Companion object that it creates for the Components in your Model. Note that your code does not invoke



these methods directly; that is done by the CIO. Rather, you implement the body of each method, using the API provided by the CIO to communicate with your Model.

The body of any or all of these methods can be empty. Your Functional Companion object has to implement only those methods indicated in Oracle Configurator Developer.

The interface class that defines these methods is:

oracle.apps.cz.cio.IFunctionalCompanion

ReferenceFor reference documentation, see: IFunctionalCompanion.

3.10.1 The initialize() Interface MethodThe IFunctionalCompanion.initialize() method is called when the companion is created. It connects a Functional Companion object to its configuration modeling environment (for example, a running instance of the run-time Oracle Configurator). Be aware that Functional Companions are created and initialized after all subcomponent instances are created for the current Component instance.

Your implementation of initialize() can include tasks that you wish to perform when the Functional Companion is first created. For example, you might wish to

Table 3–6 Standard methods of the IFunctionalCompanion interface

Method Purpose Details in

initialize Saves information about the Model and performs any actions needed to initialize the Functional Companion.

Section 3.10.1

autoConfigure Performs a programmatic configuration step. Section 3.10.2

validate Programmatically checks that a configuration is valid and throws a LogicalException object if the Model is not valid.

Section 3.10.3

generateOutput Generates output for this Component, for either a thick or thin client.

Section 3.10.4

terminate Performs any cleanup on this Functional Companion that needs to occur before the Companion is destroyed.

Section 3.10.5



start writing audit messages to a log file, tracking the actions performed by your end users.

When a run-time Oracle Configurator runs, it creates runtime instances of all the Components in the Model and their associated Functional Companions. When a Functional Companion object is created, the CIO calls initialize() and passes the following input parameters:

Your Functional Companion should ordinarily never directly call FunctionalCompanion.initialize(), since the CIO does that for you automatically. However, if your Functional Companion extendsFunctionalCompanion as its base class, and you wish to perform some specialized initialization tasks, then the overriding initialize() method in your class should call super.initialize(). This passes some necessary variables to the superclass (oracle.apps.cz.cio.FunctionalCompanion) so that its methods will work.

It is not normally necessary to implement your own initialize() method in your Functional Companion. If you need to obtain the values of the input parameters of FunctionalCompanion.initialize() for use elsewhere in your Functional Companion, you can use the set of accessor methods of FunctionalCompanion already provided in the

Name Type Description

node IRuntimeNode The node instance associated with the Functional Companion being created. Specified in Configurator Developer. Currently, only Components can be specified in Configurator Developer.

name String The name of the Functional Companion. Specified in Configurator Developer.

description String A description of the Functional Companion. Specified in Configurator Developer.

id int The database ID of the Functional Companion. Created internally.

Note: It is worth emphasizing that the node passed as the first input parameter to initialize() is specified in Oracle Configurator Developer, when you create the Functional Companion rule that associates a Model node with your Functional Companion.



oracle.apps.cz.cio.FunctionalCompanion base class. Each of these methods returns the value of the corresponding input parameter:

ReferenceFor reference documentation, see: initialize(IRuntimeNode, String,String, int).

3.10.2 The autoConfigure() Interface MethodThe IFunctionalCompanion.autoConfigure() method is called at the request of the controlling User Interface, and can set states in the Model, add optional Components, and other tasks that modify the Model.

This method performs an automatic configuration on the Model. This action can include changing the logical state of Options, or adding nodes underneath the selected Component instance in the Model tree.

Your implementation of autoConfigure() can include configuration actions that you wish to be performed before your end users arrive at a certain point in a configuration session, or as the result of certain choices that they make.

getRuntimeNode() Returns the runtime node to which this functional is associated.

getName() Returns the name of the functional companion.

getDescription() Returns the description of the functional companion.

getID() Returns the database ID of the functional companion.

Note: Currently, in Configurator Developer, you can only associate a Functional Companion with a Component (which corresponds to the node parameter of initialize(). However, to accommodate possible future enhancement of Configurator Developer, the IFunctionalCompanion interface allows any runtime node to be associated with your Functional Companion.



ReferenceFor reference documentation, see: autoConfigure().

3.10.3 The validate() Interface MethodThe IFunctionalCompanion.validate() method is called automatically when a logical transaction takes place, and should return a List of CompanionValidationFailure objects if the Model is not valid.

This method performs a functional validation for the selected Component instance each time the end user selects a node in the Model.

You should not modify the Model in a validation function. Doing so can cause unexpected application failures.

Your implementation of validate() can include tasks that you wish to perform whenever your end users make any selection. For example, you might wish to perform a calculation based on the object count of the selected Component, and present the end user with a notification if the result is outside a range that you define.

Note: In the current version of Release 11i, a contradiction that is not handled in your code, and is not rolled back, may result in a fatal exception, since the Oracle Configurator UI Server may not be able to commit the overarching transaction, or provide adequate feedback. This can be an issue for auto-configuration Functional Companions.

For reference documentation, see: FuncCompMessageException.

Warning: Ordinarily, you cannot use an external program to modify an open configuration asynchronously. Doing so circumvents the Oracle Configurator UI Server, which can result in problems with multi-threading and updating of the display in the user interface. The key exception to this restriction is the execution of the body of the autoConfigure() method. When you useautoConfigure() to modify the Model, you must finish all modifications before returning from the method. This allows the UI Server to update the display to reflect any modifications.



If the validation fails, then information about the failure is gathered by the CIO in a List of CompanionValidationFailure objects. See Section 3.8, "Validating Configurations" on page 3-24 for details.

The general structure of your implementation of validate() should be:

1. Collect inputs from the Model.

2. Call a generic validation function that you define outside the body of validate().

3. Propagate the result back as the value of the function, either null or a List of CompanionValidationFailure objects.

ReferenceFor reference documentation, see: validate().

3.10.4 The generateOutput() Interface MethodThe generateOutput() method is invoked at the request of the controlling User Interface.

Your implementation of generateOutput() might include tasks such as writing to a database, creating a report, or producing a visualization of the end user ’s configuration choices.

There are two versions of generateOutput():

� “thick client” version

public String generateOutput();

A thick client architecture is one in which the configuration Model, and the user interface for manipulating it, both reside on the same client machine. The thick client architecture allows your Functional Companion’s Output method to produce output windows directly on the client machine.

� “thin client” version

public void generateOutput(HttpServletResponse response) throws IOException

A thin client, browser-based architecture is one in which the configuration Model resides on a server, and the user interface resides on a client machine's web browser. The thin-client architecture allows your Functional Companion’s Output method to produce output in web-browser windows.



This version is invoked when your Functional Companion operates in a web deployment, such as Dynamic HTML in a browser.

See Section 5.2, "Thin-Client generateOutput() Functional Companion" for an example.

Currently, there is no mechanism for output generated through generateOutput() to provide feedback to the User Interface or the runtime Model.

ReferenceFor reference documentation, see: generateOutput() and generateOutput(HttpServletResponse).

3.10.5 The terminate() Interface MethodThe IFunctionalCompanion.terminate() method is called automatically by the CIO when the Component that the Functional Companion is attached to is deleted from the running Model.

Your implementation of this method can include tasks that you wish to perform when the Functional Companion is deleted. For example, if initialize() opens a file and reads some data, terminate() would close the file.

Your Functional Companion should ordinarily never directly call FunctionalCompanion.terminate(), since the CIO does that for you automatically. However, if your Functional Companion extendsFunctionalCompanion as its base class, and you wish to perform some specialized termination tasks, then the overriding terminate() method in your class should call super.terminate().

ReferenceFor reference documentation, see: terminate().

Reference Documentation for the CIO 4-1

4Reference Documentation for the CIO

Reference documentation for the Oracle Configuration Interface Object is provided in the form of pages generated by the Javadoc tool from the source code for the CIO.

For the main entry point to these pages, follow this link:

� CIO Package and Related Classes

TipsHere are some tips on using the generated reference documentation:

� Use the Bookmarks pane to navigate through the reference.

� Use the Contents and Index to look up items alphabetically.

� Reminder: Constants are referred to in Java as “static variables,” and are listed under the heading “Fields” in the class in which they are defined.


Examples 5-1

5Examples

This chapter contains code examples illustrating the use of Functional Companions and the CIO. These examples are fuller and longer than the examples provided in the rest of this document, which are often fragments. See the cited background sections for details.

5.1 Initializing the CIOFor background, see Section 3.3, "Initializing the CIO". This example is intended for custom user interfaces that use the CIO.

Example 5–1 Initializing the CIO (long example)

import java.io.*;import java.sql.*;import oracle.apps.cz.cio.*;import oracle.apps.cz.common.*;

class cioExample

{private CIO InitializeCIO(){

CIO cio = null;CZContext context = null;

String jdbcDriver = "oracle.jdbc.driver.OracleDriver"; // Class name of the JDBCdriver

String dbURL = "jdbc:oracle:thin:@server01:1521:sid01";String dbOwner = "apps";String dbUsername = "applsyspub";String dbPassword = "pub";

Thin-Client generateOutput() Functional Companion


try {// Load the JDBC driverClass.forName(jdbcDriver);

// Establish a connection to the databasecontext = new CZContext(dbURL, dbUsername, dbPassword, dbOwner);

}catch (ClassNotFoundException cnfe) {

System.out.println("Error loading class " + jdbcDriver);System.exit(0);

}catch (SQLException sqle) {

System.out.println("Error in creating Context");System.exit(0);

}

try {// Initialize the CIOcio = new CIO();

}catch (Exception e) {

System.out.println("Exception in InitializeCIO");cio = null;

}

return cio;}

}

5.2 Thin-Client generateOutput() Functional CompanionThis Functional Companion uses the "thin-client" version of generateOutput()(see Section 3.10.4 on page 3-35). When you invoke the Functional Companion from a web browser, it produces an HTML representation of the runtime Model tree, beginning at the node to which the companion is attached.

In order to use this type of Functional Companion, you must use Oracle Configurator in a web deployment. See the Oracle Configurator Custom Web Deployment Guide for details not covered in this document. Here is a summary of the tasks:

� Compile the Java source code into a class file.


Examples 5-3

� In Configurator Developer, define a Functional Companion rule with these options:

� In Oracle Configurator Developer’s User Interface module, define a button for the Component that invokes the Functional Companion.

� With your internet server, create an Oracle Configurator OC Servlet. See the Oracle Configurator Installation Guide for details.

� Add the new class file for the Functional Companion to the CLASSPATH environment variable for the servlet.

� You can test the Functional Companion from Configurator Developer, by specifying the URL of the servlet (in Tools>Options>Test>Servlet URL, where you also must select the Dynamic HTML in a browser option) and clicking the Test button. This opens a web browser, passing it a URL that includes an XMLmsg parameter containing the necessary OC initialization message. This message contains database connection and login strings, and specifies the Model to display, by means of the ui_def_id parameter that identifies the User Interface definition you created in Configurator Developer.

� You can test the Functional Companion outside Configurator Developer, by creating an HTML test page that substitutes for your host application. (Examples are provided in the Oracle Configurator Custom Web Deployment Guide.) This page sends an OC initialization message that specifies database connection and login information, and the Model containing the Component. You can copy these parameters from the temporary file C:\temp\dhtmlhtm.htm that is generated by the Test button. Test the Functional Companion by opening the HTML test page.

The example first calls the response.setContentType() method of the HttpServletResponse class, passing "text/html" as the output type. Then it calls

Option Choice

Type Output

Base Component the Component to which you want to attach the Functional Companion

Implementation language

Java

Program String the name of the class file



response.getWriter() to get an output stream to which the Functional Companion can write HTML.

You can also write non-HTML output by setting a different content type (a MIME type) and writing appropriate data to the output stream.

Example 5–2 Thin-client Output Functional Companion

import java.io.IOException;import java.io.PrintWriter;import javax.servlet.http.HttpServletResponse;import com.sun.java.util.collections.Iterator;import oracle.apps.cz.cio.FunctionalCompanion;import oracle.apps.cz.cio.IRuntimeNode;

public class ShowStructure extends FunctionalCompanion {

public void generateOutput(HttpServletResponse response) throws IOException {response.setContentType("text/html");PrintWriter out = response.getWriter();out.println("<html>");out.println("<head>");out.println("<title>Runtime Model Structure</title>");out.println("</head>");out.println("<body>");out.println("<h3>Runtime Model Structure</h3>");IRuntimeNode rootNode = getRuntimeNode();generateNode(out, rootNode, 0);out.println("</body>");out.println("</html>");

}

private static void generateNode(PrintWriter out, IRuntimeNode node, int level) throwsIOException {

for (int i = 0; i < level; ++i) {out.print("--");

}out.println(node.getName() + " <br> ");for (Iterator i = node.getChildren().iterator(); i.hasNext(); ) {IRuntimeNode childNode = (IRuntimeNode)i.next();generateNode(out, childNode, (level + 1));

}}

}

Using Requests

Examples 5-5

5.3 Using RequestsFor background, see Section 3.9, "Using Requests" on page 3-26.

5.3.1 Setting Initial RequestsThis example shows how to designate a group of requests as initial requests, by using ConfigTransaction.useInitialRequests().

For background, see Section 3.9.3, "Initial Requests" on page 3-28.

Example 5–3 Setting initial requests (InitialRequestTest.java)

import oracle.apps.cz.cio.*;import com.sun.java.util.collections.Iterator;

public class InitialRequestTest extends AutoFunctionalCompanion{public void onNew() throws LogicalException {IRuntimeNode comp = getRuntimeNode();Configuration config = comp.getConfiguration();ConfigTransaction itr = null;try {

// Begin transaction that uses initial requestsitr = config.beginConfigTransaction();itr.useInitialRequests();

// Try setting an Option Feature with mutually exclusive Options.IRuntimeNode of1 = comp.getChildByName("option_feature_1");// Select option_1ConfigTransaction tr = config.beginConfigTransaction();((IOption)of1.getChildByName("option_1")).select();config.commitConfigTransaction(tr);// Select option_2tr = config.beginConfigTransaction();((IOption)of1.getChildByName("option_2")).select();config.commitConfigTransaction(tr);

// Try setting a value for an Integer Feature.tr = config.beginConfigTransaction();((IInteger)comp.getChildByName("integer_feature_1")).setIntValue(33);config.commitConfigTransaction(tr);

// Try overriding a Boolean value.

Using Requests


// boolean_feature_1 negates boolean_feature_2. This should produce a contradiction.tr = config.beginConfigTransaction();try {((BooleanFeature)comp.getChildByName("boolean_feature_1")).setState(IState.TRUE);((BooleanFeature)comp.getChildByName("boolean_feature_2")).setState(IState.TRUE);

} catch (LogicalOverridableException loe) {loe.override();

}config.commitConfigTransaction(tr);

// Get next Component in Component set.ComponentSet cset = (ComponentSet)comp.getParent().getChildByName("component_set_1");Component cset_comp_1 = null;Iterator iter = cset.getChildren().iterator();if (iter.hasNext()) {cset_comp_1 = ((Component)iter.next());

}

// Try deleting a Component from a Component set.// This is not allowed, and should produce a contradiction.try {tr = config.beginConfigTransaction();cset.delete(cset_comp_1);config.commitConfigTransaction(tr);

} catch (Exception e) {config.rollbackConfigTransaction(tr);System.out.println("Expected exception in deleting component " + e);

}

// Try adding a Component to a Component set.// This is not allowed, and should produce a contradiction.try {tr = config.beginConfigTransaction();cset.add();config.commitConfigTransaction(tr);

} catch (Exception e) {config.rollbackConfigTransaction(tr);System.out.println("Expected exception in adding component " + e);

}

// Try setting value of a Text Feature of Component in Component settr = config.beginConfigTransaction();IRuntimeNode featText = cset_comp_1.getChildByName("text_feature_1");((IText)featText).setTextValue("any_text");config.commitConfigTransaction(tr);

Using Requests

Examples 5-7

// Try overriding default value of an Integer Feature of Component in Component setIRuntimeNode intFeatDef = comp.getParent().getChildByName("integer_feature_default");tr = config.beginConfigTransaction();((IInteger)intFeatDef).setIntValue(50); // Default value was 25config.commitConfigTransaction(tr);

// Commit the transaction that used initial requestsconfig.commitConfigTransaction(itr);

// Try setting an initial request after a user request// Make an ordinary user request:tr = config.beginConfigTransaction();((IState)comp.getChildByName("boolean_feature_3")).setState(IState.TRUE);config.commitConfigTransaction(tr);try {// Attempt to use initial requests after an ordinary user request:// This is not allowed, and should produce a contradiction.tr = config.beginConfigTransaction();tr.useInitialRequests();((IState)comp.getChildByName("boolean_feature_4")).setState(IState.TRUE);config.commitConfigTransaction(tr);

} catch (InitialRequestException ire) {System.out.println("InitialRequestException: " + ire);config.rollbackConfigTransaction(tr);System.out.println("Expected exception in attempting initial requests " + ire);

}} catch (Exception e) {e.printStackTrace();

} catch (Throwable t) {t.printStackTrace();

}}

}

5.3.2 Getting a List of Failed RequestsThis example shows how to use LogicalOverridableException.override() to override a logical contradiction and return a List of Request objects that represent all the previously asserted user requests that failed due to the override that you are performing.

For background, see Section 3.9.4, "Failed Requests" on page 3-30.

Using Requests


Example 5–4 Getting a list of failed requests (OverrideTest.java)

import oracle.apps.cz.cio.*;import oracle.apps.cz.common.*;import oracle.apps.fnd.common.*;import java.util.*;import com.sun.java.util.collections.List;import com.sun.java.util.collections.Iterator;

public class OverrideTest{public static void main(String[] args){ConfigTransaction tr = null;Configuration config = null;try {Class.forName("oracle.jdbc.driver.OracleDriver");WebAppsContext ctx = new WebAppsContext("server01_sid02"); // Use DBC file for contextCIO cio = new CIO();config = cio.createConfiguration("overrideTest", ctx, null, Calendar.getInstance(),

Calendar.getInstance(), null, null);OptionFeature of = (OptionFeature)config.getRootComponent().getChildByName("Feature1");Option o1 = (Option) of.getChildByName("Option1");Option o2 = (Option) of.getChildByName("Option2");

try {tr = config.beginConfigTransaction();o1.select();o2.deselect();config.commitConfigTransaction(tr);

} catch (LogicalOverridableException loe) {try {// Get list of failed requests, if anyList list = loe.override();System.out.println("Option1: " + o1+ " State: " + o1.getState());System.out.println("Option2: " + o2+ " State: " + o2.getState());printList(list);config.commitConfigTransaction(tr);

} catch (Exception re) {re.printStackTrace();config.rollbackConfigTransaction(tr);

}} catch (LogicalException le) {

le.printStackTrace();config.rollbackConfigTransaction(tr);

}

User Interface Interaction

Examples 5-9

} catch (Exception e) {e.printStackTrace();

}}

public static void printList(List list) {Iterator iter = list.iterator();while (iter.hasNext()) {System.out.println("Node: " + iter.next());

}System.out.println("***************\n");

}}

5.4 User Interface InteractionIn order to use Functional Companions that interact with the User Interface, you must use Oracle Configurator in a web deployment. See the Oracle Configurator Custom Web Deployment Guide for details not covered in this document.

For a summary of the tasks required to implement a Functional Companion in a web deployment, see the description under Thin-Client generateOutput() Functional Companion on page 5-2, with these differences:

� Define each Functional Companion rule as a Validation rule, so that it is invoked each time the end user selects a node associated with the rule.

� Do not create a button in the User Interface for these Functional Companions, since Validation rules are not invoked by buttons.

For details, see the descriptions below for each example.

5.4.1 Navigating to a ScreenThis Functional Companion demonstrates the use of these methods to programmatically navigate from one Model tree node to another:

� IUserInterface.navigateToScreen(String)

� IUserInterface.getCurrentScreen()

� IUserInterface.getOriginalScreen()

To use this example, substitute these variables (highlighted in the example code) with names of nodes in your own Model tree:



Example 5–5 Navigation to a screen (ScreenNav.java)

import javax.servlet.http.HttpServletResponse;import java.io.PrintWriter;import java.io.*;import oracle.apps.cz.cio.FunctionalCompanion;import oracle.apps.cz.cio.AutoFunctionalCompanion;import oracle.apps.cz.cio.IUserInterface;import oracle.apps.cz.cio.*;import com.sun.java.util.collections.List;import com.sun.java.util.collections.Iterator;import oracle.apps.cz.utilities.CheckedToUncheckedException ;import java.awt.Toolkit;

public class ScreenNav extends FunctionalCompanion implements IUserInterfaceEventListener {

IUserInterface mUi;Component rootnode;PrintWriter p = null;String optsel = "O4";String screenname = "C21";

public void initialize(IRuntimeNode node, String name, String description, int id) {try{p = new PrintWriter(new FileWriter("D:\\servlets\\screennav.txt",true));}catch(Exception e){e.printStackTrace();

}super.initialize(node, name, description, id);

mUi = this.getRuntimeNode().getConfiguration().getUserInterface();mUi.addUserInterfaceEventListener(IUserInterfaceEvent.POST_CLICK, this);mUi.getCurrentScreen();

Variable Usage

optsel = "O4" Name of an option, which when selected navigates to a particular screen

screenname = "C21" Component screen name to which one wants to navigate when optsel is selected.


Examples 5-11

rootnode = (Component)this.getRuntimeNode();}

public void handleUserInterfaceEvent(IUserInterfaceEvent event) {try{

IUserInterfaceScreen currscreen = mUi.getCurrentScreen();if (event.getUiNode() == null) return;if ((event.getUiNode().getType() == IUserInterfaceNode.OPTION) &&

(event.getUiNode().getName().equalsIgnoreCase(optsel))){

p.println("Screen before navigating is " + mUi.getCurrentScreen().getName());IOption optf = (IOption)event.getUiNode().getRuntimeNode();if (optf.isTrue()){p.println("Navigating to screen " + screenname);mUi.navigateToScreen(screenname);p.println("Current screen is " + mUi.getCurrentScreen().getName());p.println("Original screen was " + mUi.getOriginalScreen().getName());

}}

p.flush();}catch(Exception e){e.printStackTrace();}

}

public IRuntimeNode treetrav (IRuntimeNode rtnode,String nodename){List children = rtnode.getChildren();Iterator iter = (Iterator)children.iterator();

while (iter.hasNext()){IRuntimeNode currchild = (IRuntimeNode)iter.next();if (currchild.getName().equalsIgnoreCase(nodename))return currchild;

if ((treetrav (currchild,nodename)) != null)return currchild;

}return null;

}}



5.4.2 Changing the Caption of a NodeThis Functional Companion demonstrates how to change the caption on a node in the Model tree view (of type TREELINK), using these classes and methods:

� IUserInterfaceNode

� IUserInterfaceLabel.setUiCaption(String)

To use this example, attach this Functional Companion to the root node of your Model tree, and substitute these variables (highlighted in the example code) with names of nodes in your own Model tree:

Example 5–6 Changing the caption of a node (CaptionChng.java)

import javax.servlet.http.HttpServletResponse;import java.io.PrintWriter;import java.io.*;import oracle.apps.cz.cio.FunctionalCompanion;import oracle.apps.cz.cio.AutoFunctionalCompanion;import oracle.apps.cz.cio.IUserInterface;import oracle.apps.cz.cio.*;import com.sun.java.util.collections.List;import oracle.apps.cz.uiserver.engine.*;import com.sun.java.util.collections.Iterator;import oracle.apps.cz.utilities.CheckedToUncheckedException ;import oracle.apps.fnd.common.Context;import java.awt.Toolkit;import java.util.*;

public class CaptionChng extends FunctionalCompanion implementsIUserInterfaceEventListener,IUserInterfaceNode{IUserInterface mUi;Component rootnode;String ChangeCapOf="C11";String ChangeCapTo="Comp11";

public void initialize(IRuntimeNode node, String name, String description, int id) {super.initialize(node, name, description, id);

Variable Usage

ChangeCapOf="C11" Name of the TREELINK caption that you want to change.

ChangeCapTo="Comp11" Name that you want to change the TREELINK caption to.


Examples 5-13

mUi = this.getRuntimeNode().getConfiguration().getUserInterface();mUi.addUserInterfaceEventListener(IUserInterfaceEvent.POST_CLICK, this);rootnode = (Component)this.getRuntimeNode();}

public void handleUserInterfaceEvent(IUserInterfaceEvent event) {try{

rootnode = (Component)this.getRuntimeNode();if (event.getUiNode() == null) return;if (mUi.getCurrentScreen().getName().equals(ChangeCapOf)){IRuntimeNode nodefound = (IRuntimeNode)treetrav (rootnode,ChangeCapOf);Iterator iternode = mUi.getNode(nodefound).iterator();while (iternode.hasNext()){IUserInterfaceNode unode = (IUserInterfaceNode)iternode.next();if (unode.getType()== (IUserInterfaceNode.TREELINK)){((IUserInterfaceLabel)unode).setUiCaption(ChangeCapTo);break;

}}

} }catch(Exception e){e.printStackTrace();}

}

public IRuntimeNode treetrav (IRuntimeNode rootnode,String nodename){IRuntimeNode retNode = null;List children = rootnode.getChildren();Iterator iter = (Iterator)children.iterator();

while (iter.hasNext()){IRuntimeNode currchild = (IRuntimeNode)iter.next();

if (currchild.getName().equalsIgnoreCase(nodename))return currchild;

if (( retNode=treetrav (currchild,nodename)) != null)return retNode;

}return null;

}

public int getType(){return 0;};public String getUiCaption(){return null;};



public IUserInterfaceScreen getScreen(){return null;};}

5.4.3 Changing an ImageThis Functional Companion demonstrates how to change the image associated with a particular Option, using these classes:

� IUserInterfaceImage

� IUserInterfaceScreen

To use this example, in Oracle Configurator Developer:

1. In the Model module, create or use a Component C1.

2. In C1, create Feature F1.

3. In F1, create Options O1, O2, O3

Presume that you have the following GIF files, all the same size:

4. In O1 and O3, add Properties named "img1", each with the value "rightarr.gif"

5. In O2, add a Property named "img1", with the value "lefttarr.gif"

6. In the Rules module, define a Functional Companion rule referring to this example, and associate it with Component C1.

7. Choose Tools > Generate Active Model.

8. In the UI module, Refresh or create a User Interface for the Model.

9. In the UI node for C1, add a Picture object, and name the Picture object "placeholder". Refer to the Picture by providing its image path (e.g., D:\orant\OC\Shared\ActiveMedia\blank.gif.)

10. Adjust the position and size of the Picture object to fit the image files.

11. Place these GIF files in the ActiveMedia folder in your Developer installation, and also in the OA_MEDIA directory of your Oracle Configurator OC Servlet.

12. Select the User Interface and choose Edit > Refresh.

rightarr.gif An image of a right-pointing arrow

lefttarr.gif An image of a left-pointing arrow

blank.gif A blank placeholder image


Examples 5-15

13. Use the Test button to view the Dynamic HTML in a browser, and click on C1.

14. When you click on O1 or O3 (of F1), a right-pointing arrow appears on the screen.

15. When you click on O2, a left-pointing arrow appears on the screen.

Example 5–7 Changing an image (ImageChange.java)

import javax.servlet.http.HttpServletResponse;import java.io.PrintWriter;import java.io.*;import oracle.apps.cz.cio.FunctionalCompanion;import oracle.apps.cz.cio.AutoFunctionalCompanion;import oracle.apps.cz.cio.IUserInterface;import oracle.apps.cz.cio.*;import com.sun.java.util.collections.List;import com.sun.java.util.collections.Iterator;import oracle.apps.cz.utilities.CheckedToUncheckedException ;import java.awt.Toolkit;

public class ImageChange extends FunctionalCompanion implements IUserInterfaceEventListener {

IUserInterface mUi;Component rootnode;PrintWriter p = null;

public void initialize(IRuntimeNode node, String name, String description, int id) {super.initialize(node, name, description, id);

mUi = this.getRuntimeNode().getConfiguration().getUserInterface();mUi.addUserInterfaceEventListener(IUserInterfaceEvent.POST_CLICK, this);rootnode = (Component)this.getRuntimeNode();}

public void handleUserInterfaceEvent(IUserInterfaceEvent event) {try{if (event.getUiNode().getType() == IUserInterfaceNode.OPTION);{Option optsel = (Option)event.getUiNode().getRuntimeNode();String imagename = optsel.getPropertyByName("img1").getStringValue();IUserInterfaceScreen currscr = mUi.getCurrentScreen();

List images = currscr.getNode("placeholder");



IUserInterfaceImage placeholder = (IUserInterfaceImage)images.get(0);placeholder.setFileName(imagename);

}} catch(Exception e){e.printStackTrace();}

}

}

5.5 Controlling Parent and Child WindowsIn order to use Functional Companions that control parent and child windows, you must use Oracle Configurator in a web deployment. See the Oracle Configurator Custom Web Deployment Guide for details not covered in this document.

For a summary of the tasks required to implement a Functional Companion in a web deployment, see the description under "Thin-Client generateOutput() Functional Companion" on page 5-2.

5.5.1 Locking, Unlocking and Refreshing WindowsFor background on this example, see Section 2.2.1, "Locking, Unlocking and Refreshing Windows" on page 2-10.

When you define your Functional Companion rule, associate it with the compiled code from Example 5–8.

The values for the host name and port number shown in the example must be tailored to your own site:

http://server01:8800/configurator/Replace

The methods that lock, unlock, and refresh the windows are highlighted.

The code for the servlet that implements the "update" function is the subject of Example 5–9 under "Accessing a Shared Configuration Model" on page 5-18.

Example 5–8 Launching a Child Window (Launch.java)

import javax.servlet.http.HttpServletResponse;import java.io.PrintWriter;import oracle.apps.cz.cio.FunctionalCompanion;


Examples 5-17

import oracle.apps.cz.cio.AutoFunctionalCompanion;

public class Launch extends AutoFunctionalCompanion{

/*** Constructor:* Can be used for any necessary setup.*/public Launch(){}

public void generateOutput(HttpServletResponse response){try{

response.setContentType("text/html");PrintWriter out = response.getWriter();out.println("<html>");out.println("<head>");out.println("<script language=\"javascript\">");out.println("var winHandle = opener;");// The "opener" is the czSource.htm frame.// The methods are made public here.out.println("function lock() { opener.lockEventManagers();}");out.println("function unlock() { opener.unlockEventManagers();}");out.println("function refresh() { opener.refreshFrames();}");out.println("function update() { lock(); document.form1.submit();}");out.println("</script></head>");out.println("<body><form name='form1'

action='http://server01:8800/configurator/Replace'>");out.println("<input type='button' value='lock' onClick='lock();'>");out.println("<input type='button' value='unlock' onClick='unlock();'>");out.println("<input type='button' value='refresh' onClick='refresh();'>");out.println("<input type='button' value='update' onClick='update();'>");out.println("</form></body>");out.println("</html>");

}catch(Exception e){e.printStackTrace();}

}

public void onNew(){

}



}

5.5.2 Accessing a Shared Configuration ModelFor background on this example, see Section 2.2.2, "Accessing a Shared Configuration Model" on page 2-11.

This servlet code implements the "update" function in Example 5–8 under "Controlling Parent and Child Windows" on page 5-16.

The names of the Model nodes shown in the example must be tailored to your own Model:

Component-11820Feature-11821Option-11822Option-11825

Example 5–9 Accessing a Shared Configuration Model (Replace.java)

import javax.servlet.*;import javax.servlet.http.*;import java.io.*;import java.util.Iterator;import java.util.ArrayList;import oracle.apps.cz.cio.Configuration;import oracle.apps.cz.cio.Component;import oracle.apps.cz.cio.IRuntimeNode;import oracle.apps.cz.cio.RuntimeNode;import oracle.apps.cz.cio.ComponentNode;import oracle.apps.cz.cio.OptionFeature;import oracle.apps.cz.cio.Option;import oracle.apps.cz.cio.NoSuchChildException;import oracle.apps.cz.cio.LogicalException;import oracle.apps.cz.cio.TransactionException;import oracle.apps.cz.cio.IState;import oracle.apps.cz.cio.ConfigTransaction;

public class Replace extends HttpServlet {

//Initialize global variablespublic void init(ServletConfig config) throws ServletException {super.init(config);

}

//Process the HTTP Get request


Examples 5-19

public void doGet(HttpServletRequest request, HttpServletResponse response) throwsServletException, IOException {

response.setContentType("text/html");ArrayList list = new ArrayList();// Here we are updating the Model.try{

HttpSession ses = request.getSession(true);// Here we are getting the configuration Object stored in the http session.Configuration conf = (Configuration)ses.getValue("configurationObject");Component root = conf.getRootComponent();IRuntimeNode node = root.getChildByName("Component-11820");OptionFeature child = (OptionFeature)node.getChildByName("Feature-11821");Option opt1 = (Option)child.getChildByName("Option-11822");Option opt2 = (Option)child.getChildByName("Option-11825");ConfigTransaction ct = conf.beginConfigTransaction();try{

try{opt1.setState(IState.UTRUE);opt2.setState(IState.UTRUE);conf.commitConfigTransaction(ct);

}catch(LogicalException le){}}catch(TransactionException le){}

}catch(NoSuchChildException e){}

PrintWriter out = new PrintWriter (response.getOutputStream());out.println("<html>");out.println("<head>");out.println("<script language=\"javascript\">");out.println("var winHandle = opener;");out.println("function init() { winHandle.unlockEventManagers(); winHandle.refreshFrames();

}");out.println("</script></head>");out.println("<body onLoad='init();'>We have just updated and refreshed the model.</body>");out.println("</html>");out.close();

}

//Process the HTTP Post requestpublic void doPost(HttpServletRequest request, HttpServletResponse response) throws

ServletException, IOException {response.setContentType("text/html");PrintWriter out = new PrintWriter (response.getOutputStream());out.println("<html>");out.println("<head><title>Replace</title></head>");



out.println("<body>");out.println("</body></html>");out.close();

}//Get Servlet information

public String getServletInfo() {return "Information about Replace";

}}

Glossary of Terms-1

Glossary of Terms

This glossary for Oracle Configurator is followed by a Glossary of Acronyms

Active Model

The part of Oracle Configurator runtime architecture that processes model structure and rules to create configurations. Interfaces dynamically with the end user Active UI and data.

Active User Interface

The part of Oracle Configurator runtime architecture that provides the graphical views necessary to create configurations interactively. Interfaces with the Active Model and data to give users access to customer requirements gathering, product selection, and customer-centric extensions.

Applet

A Java application running inside a web browser. See also Java and Servlet.

Application Architecture

The software structure of an application at runtime. Architecture affects how an application is used, maintained, extended, and changed.

Architecture

The software structure of a system. Architecture affects how a system is used, maintained, extended, and changed. See also Application Architecture.

Glossary of Terms-2

Beta

An external release, delivered as an installable application, and subject to system, validation, and acceptance testing. Specially selected and prepared end users may participate in beta testing.

Bill of Material

A list of component items associated with a parent item (assembly) and information about how each item relates to the parent item.

BOM

See Bill of Material.

BOM Item

The nodes imported into the Oracle Configurator Developer Model that correspond to an Oracle BOM.

BOM Model

The imported Model node in the Oracle Configurator Developer that corresponds to Standard Model in an Oracle BOM.

BOM OptionClass

The imported Model node in the Oracle Configurator Developer that corresponds to Option Class in an Oracle BOM.

BOM StandardItem

The imported Model node in the Oracle Configurator Developer that corresponds to Standard Item in an Oracle BOM.

Boolean Expression

An element of a component in the Model that has two options: true or false.

Bug

See Defect.

Build

A specific instance of an application during its construction. A build must have an install early in the project so that application implementers can unit test their latest work in the context of the entire available application.

Glossary of Terms-3

CIO

See Oracle Configuration Interface Object.

Client

A runtime program using a server to access functionality shared with other clients.

Comparison Rule

An Oracle Configurator Developer rule type to establish a relationship that determines the selection state of a logical item (option, boolean feature, or list-of-options feature) based on a comparison of two numeric values (numeric features, totals, resources, option counts, or numeric constants). The numeric values being compared can be computed or they can be discrete intervals in a continuous numeric input.

Compatibility Rule

An Oracle Configurator Developer rule type to establish a relationship among features in the Model that specifies the allowable combinations of options. See also, Property-based Compatibility Rule.

Compatibility Table

A type of compatibility relationship where the allowable combination of options are explicitly enumerated.

Component

Represents a configurable element in a product. An element of the Model structure, typically containing features. May correspond to one screen of selections in an Oracle runtime configurator.

Component Set

An element of the Model that contains a number of components of the same type, where each component of the set is independently configured.

Concurrent Manager

A process manager that coordinates the concurrent processes generated by users’ concurrent requests. An Oracle Applications product group can have several concurrent managers.

Glossary of Terms-4

Concurrent Process

A task that can be scheduled and is run by a concurrent manager. A concurrent process runs simultaneously with interactive functions and other concurrent processes.

Concurrent Processing Facility

An Oracle Applications facility that runs time-consuming, non-interactive tasks in the background.

Concurrent Program

Executable code (usually written in SQL*Plus or Pro*C) that performs the function(s) of a requested task.

Concurrent Request

A user-initiated request issued to the concurrent processing facility to submit a non-interactive task, such as running a report.

Configuration

A specific set of specifications for a product, resulting from selections made in an Oracle runtime configurator.

Configuration Model

The model structure and rules-based content of an Oracle runtime configurator. The configuration model is constructed and maintained using Oracle Configurator Developer, and is interpreted at runtime by the Active Model.

Configuration Rules

The Oracle Configurator Developer logic rules and numeric rules available for defining configurations.

Configurator

The part of an application that provides custom configuration capabilities.

Constraint Rule

An Oracle Configurator Developer rule type to create a logical relationship among features and options. See also Rules.

Glossary of Terms-5

Contributes to

An Oracle Configurator Developer numeric rule type for accumulating a total value.

Consumes from

An Oracle Configurator Developer numeric rule type for specifying the quantity of a resource used.

CRM

Customer Relationship Management. The aspect of the enterprise that involves contact with customers, from lead generation to support services.

Customer

The person or persons for whom products are configured by end users of the Oracle Configurator or other ERP and CRM applications.

Customer-centric Extensions

See Customer-centric Views.

Customer-centric Views

Optional extensions to core functionality that supplement product selection with rules for pre-selection, validation, and intelligent views. View capabilities include generative geometry, drawings, sketches and schematics, charts, performance analyses, and ROI calculations.

Customer Requirements

The needs of the customer that serve as the basis for determining the configuration of products, systems, and/or services. Also called Needs Assessment.

Data Import

Populating the Oracle Configurator schema with enterprise data from ERP or legacy systems via import tables.

Data Integration Object

Data Integration Object. A server in the runtime application that creates and manages the interface between the client (usually a user interface like the Active User Interface) and the Oracle Configurator schema.

Glossary of Terms-6

Data Maintenance Environment

The environment in which the Oracle runtime configurator data is maintained.

Data Replication

The activity of downloading and uploading configuration, quote, and order data between the Oracle Configurator schema on the enterprise server and Oracle Configurator Mobile Database on end-user mobile laptop PCs. See also Data Synchronization.

Datasource

A programmatic reference to a database. Referred to by a datasource name, or DSN.

Data Synchronization

A process for matching the data in the Oracle Configurator schema and the data available to client processes such as the Oracle SellingPoint application. See also Data Replication.

Default

The automatic selection of an option based on the pre-selection rules or the selection of another option.

Defaults

An Oracle Configurator Developer logic rule to determine the logic state of features or options in a default relation to other features and options. For instance, if you set A to True by selecting it, B becomes true (selected) if it is available (not false) and can be set to True without contradicting a non-default rule or a previous default setting for B.

Defect

A failure in a product to satisfy the users' requirements. Defects are prioritized as critical, major, or minor, and fixes range from corrections or workarounds to enhancements. Also known as a “bug”.

Defect Tracking

A system of identifying defects for managing additional tests, testing, and approval for release to users.

Deliverable

A work product that is specified for review and delivery.

Glossary of Terms-7

Demonstration

A presentation of the tested application, showing a particular usage scenario.

Design Chart

An Oracle Configurator Developer rule type for defining advanced Explicit Compatibilities interactively in a chart view.

Design Review

A technical review that focuses on application or system design.

Developer

The tool (Oracle Configurator Developer) used to create configuration models. The person who uses Oracle Configurator Developer to create a configurator. See also Implementer.

DIO

See Data Integration Object.

End User

The ultimate user of the Oracle runtime configurator. The types of end users vary by project but may include salespeople or distributors, administrative office staff, marketing personnel, order entry personnel, product engineers, or customers directly accessing the application via web or kiosk.

Enterprise

The systems and resources of a business.

Environment

The arena in which software tools are used, such as operating system, applications, and server processes.

ERP

Enterprise Resource Planning. A software system and process that provides automation for the customer's back-room operations, including order processing.

Excludes

An Oracle Configurator Developer rule type for determining the logic state of features or options in an excluding relation to other features and options. For instance, if you set A to True, B becomes false, since it is not allowed when A is true.

Glossary of Terms-8

If you set A to False, there is no effect on B, meaning it could be true, false, or unknown.

Extended Functionality

A release after delivery of core functionality that extends that core functionality with customer-centric views, more complex proposal generation, discounting, quoting, and expanded integration with ERP, CRM, and third-party software.

Feature

An element of the Model structure. A configurable parameter of a component. Features can either have a value (numeric or boolean) or enumerated options.

Functional Companion

An object associated with a component that supplies methods that can be used to initialize, validate and generate customer-centric views and outputs for the configuration.

Functional Specification

Document describing the functionality of the application based on user requirements.

Incremental Construction

The process of organizing the construction of the application into builds, where each build is designed to meet a specified portion of the overall requirements and is unit tested.

Implementation

The stage in a project between defining the problem by selecting a configuration technology vendor, such as Oracle, and deploying the completed sales configuration application. The Implementation stage includes gathering requirements, defining test cases, designing the application, constructing and testing the application, and delivering it to users.

Implementer

The person who uses Oracle Configurator Developer to build the model structure, rules, and UI customizations that make up an Oracle runtime configurator.

Implies

An Oracle Configurator Developer logic rule type that determines the logic state of features or options in an implied relation to other features and options. For instance,

Glossary of Terms-9

if you set A to True by selecting it, B becomes true, since selecting A implies that B is also selected. If you set A to False by deselecting it, there is no effect on B, meaning it could be true false or unknown based on other relations B participates in. And if you set B to True by selecting it, there is no effect on A, meaning it could be true false or unknown based on other relations A participates in. But if you set B to False by deselecting it, the relation of A implies B is preserved only by having A be false (deselected) as well.

Import Tables

Tables mirroring the Oracle Configurator schema Item Master structure, but without integrity constraints. Import Tables allow batch population of the Oracle Configurator schema Item Master. Import Tables are used in conjunction with extractions from Oracle Applications or legacy data to create, update, or delete records in the Oracle Configurator schema Item Master.

Install

A program that sets up the local machine and installs the application for testing and use.

Integration

The process of combining multiple software components and making them work together.

Integration Testing

Testing the interaction among software programs that have been integrated into an application or system.

Intelligent Views

Configuration output, such as reports, graphs, schematics, and diagrams, that help to illustrate the value proposition of what is being sold.

Item Master

A table in the Oracle Configurator schema containing data used to structure the product. Data in the item master is either entered manually or imported from Oracle Applications or legacy data.

Item Type

A table in the Oracle Configurator schema containing data used to classify the product data in the item master table.

Glossary of Terms-10

Java

An object-oriented programming language commonly used in internet applications, where Java applications run inside web browsers and servers. See also Applet and Servlet.

Log File

A file containing errors, warnings and other information output by the running application.

Logic Rules

Logic rules directly or indirectly set the logical state (true, false, or unknown) of features and options in the Model.

There are four (4) primary logic rules: Implies, Requires, Excludes, and Negates. Each of these rules takes a list of features or options as operands. See also Logic, Implies, Requires, Excludes, and Negates.

Maintainability

The characteristic of a product or process to allow straightforward maintenance, alteration, and extension. Maintainability must be built into the product or process from inception.

Maintenance

The effort of keeping a system running once it has been deployed, through bug fixes, procedure changes, infrastructure adjustments, data replication schedules, etc.

Maintenance Guide

A guide for maintaining a specific application or system. The maintenance guide covers all aspects of maintenance described in the generic Maintenance Plan.

Maintenance Plan

A document that outlines what is required for successful maintenance, and who is responsible for all the actions and deliverables of carrying out maintenance on a system.

MDUI

See Model-driven UI.

Mobile Database

See Oracle Configurator Mobile Database.


Model

The entire hierarchical “tree” view of all the data required for configurations, including model structure, variables such as resources and totals, and elements in support of intermediary rules. May consist of BOM Items.

Model-driven UI

The graphical views of the model structure and rules generated by the Active UI to present end users with interactive product selection based on configuration models.

Model Structure

Hierarchical, “tree” view of data in terms of product elements (Models, Products Components, Features, Options, BOM Models, BOM OptionClasses, BOM StandardItems, Resources, and Totals). May include reusable components.

MRP

Manufacturing Resource Planning. A software system and process for monitoring and maintaining the customer's manufacturing systems.

Negates

An Oracle Configurator Developer logic rule type that determines the logic state of features or options in a negating relation to other features and options. For instance, if you set one item in the relationship to True, the other item must be false. And if you set one item to False, the other item must be true.

Node

The place in a Model occupied by a component, feature, option or variable, BOM Model, BOM OptionClass, or BOM StandardItem.

Numeric Rules

Rules that are used to set the global parameters specified in product structuring. See also, Contributes to and Consumes from.

OC

See Oracle Configurator.

Opportunity

The workspace in the Oracle SellingPoint application and Oracle Sales Online in which products, systems, and/or services are configured, quotes and proposals are generated, and orders are submitted.


implementation schema includes all the data required for the runtime system as well as specific tables used during the construction of the configurator.

Oracle SellingPoint Application

The test application generated by Oracle Configurator Developer. Also a full configuration environment with opportunity management, quotes, and proposals for networked or mobile deployments.

Output

The output generated by a configurator, such as quotes, proposals, bills of material (BOM), and customer-centric views.

PDM

Product Data Management. A software system that manages the version control of product data.

Populator

An entity in the Oracle Configurator Developer that defines how to create a Model from information in the item master.

Pre-selection

The default state in a configurator that defines an initial selection of components, features, and options for configuration.

A process that is implemented to select the initial element(s) of the configuration.

Principal Design Consultant

Member of the project team responsible for architecting the design of the application.

Product

Whatever is subjected to configuration and is the output of the application.

The root element of the Model.

Product Family

A collection of products or product lines, which are organized as a group by a provider or manufacturer.


Project

The workspace in Oracle Configurator Developer in which configurators are constructed

Project Manager

A member of the project team who is responsible for directing the project during implementation.

Project Plan

A document that outlines the logistics of successfully implementing the project, including the schedule.

Property

A named value associated with an object in the Model or the item master. A set of properties may be associated with an item type.

Property-based Compatibility Rule

A kind of compatibility relationship where the allowable combinations of options are specified implicitly by relationships among property values of the options.

Prototype

A construction technique in which a preliminary version of the application, or part of the application, is built to facilitate user feedback, to prove feasibility or examine other implementation issues.

Reference

The use of a reusable component within the Model. Not implemented in Release 11i or before.

Regression Test

An automated test that ensures the newest build still meets previously tested requirements and functionality.

Requires

An Oracle Configurator Developer logic rule type that determines the logic state of features or options in a requirement relation to other features and options. For instance, if you set one item in the relationship to True, the other item is required to be true as well. And if you set one item to False, the other item must be false as well.


Resource

Staff or materials available or needed within an enterprise.

A variable in the Model used to maintain the balance of features not consuming more of a specific resource than has been provided by other features.

Reusable Component

A component that is referenced from multiple locations in the Model. Not implemented in Release 11i or before.

Reusability

The extent to and ease with which parts of a system can be put to use in other systems.

Rules

Also called business rules or configuration rules. Constraints applied among elements of the product to ensure that defined relationships are preserved during configuration. Elements of the product are components, features, and options. Rules express logic, numeric parameters, implicit compatibility, or explicit compatibility. Rules are used to provide pre-selection and validation capability in an application.

See also Logic Rules and Numeric Rules.

Runtime

The environment and context in which applications are run or used, rather than developed.

Sales Configuration

A part of the sales process to which configuration technology has been applied in order to increase sales effectiveness and decrease order errors. Commonly identifies needs assessment and product configuration.

Server

Centrally located software processes or hardware, shared by clients.

Servlet

A Java application running inside a web server. See also Java and Applet.

Solution

The deployed system as a response to a problem or problems.


System

The hardware and software components and infrastructure integrated to satisfy functional and performance requirements.

Test Case

A description of inputs, execution instructions, and expected results, which are created for the purpose of determining whether a specific software feature works correctly or a specific requirement has been met.

Total

A variable in the Model used to accumulate a numeric total, such as total price or total weight.

Undetermined

The logic state that is neither true nor false, but unknown at the time a logic rule is executed. This logic state is also referred to as Available, especially when considered from the point of view of the Oracle runtime configurator end user.

Unit Test

Execution of individual routines and modules by the application implementer or by an independent test consultant for the purposes of finding defects.

Update

Moving a production configurator to a new version of configuration model.

Upgrade

Moving the configurator to a new release of Oracle Configurator.

User

The person using the Oracle Configurator Developer tools and methods to build an Oracle runtime configurator. See also end user.

User Interface

The visible part of the application, including menus, dialog boxes, and other on-screen elements. The part of a system where the user interacts with the software.

User Requirements

A description of what the Oracle Configurator or Oracle SellingPoint application is expected to do from the end user's perspective.


User's Guide

Documentation on using the application or configurator to solve the intended problem.

Validation

Tests that ensure that the configured components will meet specific performance or acceptance criteria.

A type of functional companion that is implemented to ensure that the configured components will meet specific performance or acceptance criteria.

Variable

Parts of the Model that are represented by Totals, Resources, or numeric Features.

Verification

Tests that check whether the result agrees with the specification.


Glossary of Acronyms-1

Glossary of Acronyms

API

Application Programming Interface

ATP

Available to Promise

BOM

Bill of Material

CIO

Configuration Interface Object

CM

Configuration Management

COM

Component Object Model

CRM

Customer Relationship Management

DBMS

Database Management System

DCOM

Distributed Component Object Modeling


DHTML

Dynamic Hypertext Markup Language

DIO

Data Integration Object

DLL

Dynamically Linked Library

DXF

Drawing Exchange Format (AutoCAD drawings)

ECO

Engineering Change Order

ERM

Enterprise Relationship Management

ERP

Enterprise Resource Planning

ESD

Electronic Software Distribution

ESP

External Service Provider

ESS

Enterprise Selling System

HT

High Tech

HTML

Hypertext Markup Language

IP

Industrial Products


IS

Information Services

ISS

Interactive Selling System

ISV

Independent Software Vendor

LAN

Local Area Network

MAPI

Messaging Application Programming Interface

MC/S

Mobile Client/Server System

MDUI

Model-Driven User Interface

MES

Marketing Encyclopedia System (Catalog)

MIS

Management Information Systems

MRP

Manufacturing Resource Planning

MS

Microsoft

OC

Oracle Configurator

OCX

Object Control File, OLE custom controls


ODBC

Open Database Connectivity

OLE

Object linking and embedding

OMS

Opportunity Management System

OOD

Object-Oriented Design

ORB

Object Request Broker

PDM

Product Data Management

PIA

Project Impact Assessment

POS

Point of Sale

QA

Quality Assurance

RAD

Rapid Application Development

RDBMS

Relational Database Management System

RFQ

Request for Quote

ROI

Return on Investment


SAS

Sales Analysis System

SCM

Supply Chain Management

SCS

Sales Configuration System

SE

Sales Engineer

SFA

Sales Force Automation

SI

System Integrator

SOT

Strategic Options Theory

SQA

Software Quality Assurance

SQL

Structured Query Language

TERM

Technology-Enabled Relationship Management

TES

Technology-Enabled Selling

UI

User Interface

VAR

Value-Added Reseller


VB

Microsoft Visual Basic

WAN

Wide Area Network

WIP

Work In Progress

CIO Package and Related Classes A-1

ACIO Package and Related Classes

Package Summary

Packages

Package oracle.apps.cz.cio Provides classes used to create, save and restore configurations.

Package oracle.apps.cz.common

Package oracle.apps.cz.utilities

A-2 Oracle Configuration Interface Object (CIO) Developer’s Guide

Package oracle.apps.cz.cio B-1

BPackage oracle.apps.cz.cio

DescriptionProvides classes used to create, save and restore configurations. The top-level entry point to this package is the configuration integration object, which provides methods for creating, saving, restoring and deleting configurations. The configuration can be manipulated by calling methods on the configuration object and its tree of runtime objects.

Class Summary

Interfaces

Component Interface for components.

ComponentNode

IAtp Implemented by objects that can have ATP calculated.

IBomItem Implemented by all selectable BOM items.

ICompSetEventListener Implemented by objects that want to find out about added components.

IConfigEventListener Implemented by objects that want to be notified about added or deleted components.

ICount Implemented by objects that have an associated integer count.

IDecimal Implemented by objects that can both get and set a decimal value.

IDecimalMinMax Implemented by objects that have a decimal minimum and maximum value.

IFunctionalCompanion Implemented by functional companion objects attached to components in order to provide programatic functionality to a configuration model.

IInteger Implemented by objects that have an integer value.

B-2 Oracle Configuration Interface Object (CIO) Developer’s Guide

IIntegerMinMax Implemented by objects that have an integer minimum and maximum.

IOption Implemented by objects that act as options.

IOptionFeature Implemented by objects that contain selectable options.

IPrice Implemented by objects that can be priced.

IReadOnlyDecimal Implemented by objects that have a decimal value.

IRuntimeNode Implemented by all objects in the runtime configuration tree.

IState Implemented by objects that have logic state.

IText Implemented by objects that have a textual value.

IUserInterface Implemented by applications that want to provide access to the user interface in functional companions.

IUserInterfaceControl Implemented by user interface objects that represent controls that are displayed to the end user Oracle Configurator Runtime Behavior:

IUserInterfaceEvent

IUserInterfaceEventListener

IUserInterfaceImage Implemented by user interface objects that provide capabilities needed by functional companions to interact with images.

IUserInterfaceLabel Implemented by user interface objects that provide capabilities needed by functional companions to interact with labels.

IUserInterfaceNode Implemented by user interface object that allow interaction with functional companions.

IUserInterfaceScreen Implemented by user interface objects that provide capabilities needed by functional companions to interact with screens.

Classes

AutoFunctionalCompanion Base object on which user functional companions can be based.

BomModel Represents configurable BOM Models.

BomNode Represents configurable BOM option classes.

BomOptionClass Represents configurable BOM option classes.

BomStdItem Represents configurable BOM models.

BooleanFeature Represents a feature with a boolean value.

Class Summary


CIO Implements a configuration integration object that can be used to create, save, restore and delete configurations.

CompanionNode Provides methods for extracting values from a model based on property annotations.

CompanionRoot Provides functional companion implementors with property-based feature extraction.

CompanionValidationFailure Failure produced by a functional companion object.

ComponentSet Represents a set of configurable components.

ConfigTransaction Represents a configuration transaction.

Configuration The top-level entry point to a configuration.

CountFeature Represents a countable integer feature.

DecimalFeature Represents a feature with a decimal value.

DecimalNode An abstract class implementing behavior common to objects with a decimal value.

Factory Provides a class factory for the CIO to clients that do not support arguments to constructors.

FunctionalCompanion Base object on which user functional companions can be based.

FunctionalCompanionException This exception is used to indicate that an error occured somewhere inside the functional companion.

IntegerFeature Represents a feature with an integer value.

IntegerNode Represents a feature with an integer value.

ModifiedConfigOverwriteException This exception is thrown if a user tries to overwrite a configuration revision that has been modified since the user accessed it.

Option Represents an option of an option feature.

OptionFeature Represents a feature with selectable options.

OptionFeatureNode An abstract class implementing behavior commont to all features with options.

OptionNode An abstract class implementing behavior common to all option-like objects.

PricedNode Abstract class implementing common behavior across all runtime nodes that can be priced.

Property Represents name/value properties associated with runtime nodes.

ReadOnlyDecimalNode An abstract class implementing behavior common to objects with a decimal value.

Class Summary


Reason This class wraps the information returned by a contradiction in order to include information about internal error messages.

Request This class is the used for input and output of requests into the system.

Resource Represents a consumable resource.

RestoreValidationFailure Failure produced when restoring a configuration over a changed model.

RuntimeNode Abstract class implementing common behavior across all runtime nodes.

StateCountNode Abstract class implementing common behavior for nodes with a logic state and count.

StateNode Abstract class implementing common behavior across nodes with logic state.

StatusInfo Contains information about a status change for a particular runtime node.

TextFeature Represents a feature that has a textual value.

TextNode Represents a feature that has a textual value.

Total Represents a total that has a decimal numeric value.

ValidationFailure Implements behavior common to all validation failures.

Exceptions

AtpUnavailableException Signals that the CIO ATP calculation functionality is not available.

BomExplosionException Exception which is thrown when a client tries to create a configuration directly from an Apps bill of material and there is a problem with the explosion of the bill.

EffectivityUsageException OBSOLETE.

FuncCompCreationException Signalled if a functional companion cannot be created.

FuncCompErrorException FuncCompMessageException is designed to be thrown from a functional companion's autoConfigure() method code when the author of the companion wants to display an ERROR message in a dialog box to the end user.

FuncCompMessageException FuncCompMessageException is designed to be thrown from a functional companion's autoConfigure() method code when the author of the companion wants to display a BENIGN message in a dialog box to the end user.

IncompatibleInputException Signalled if a particular input is of different type than the node it is trying to restore over.

IneffectiveUiNodeException

InitialRequestException Signalled if a problem occurs during the setting of Initial Requests.

Class Summary

AtpUnavailableException


oracle.apps.cz.cioAtpUnavailableException

Syntaxpublic class AtpUnavailableException extends java.lang.Exception

java.lang.Object|+--java.lang.Throwable

|+--java.lang.Exception

|+--oracle.apps.cz.cio.AtpUnavailableException

All Implemented Interfaces: java.io.Serializable

DescriptionSignals that the CIO ATP calculation functionality is not available.

Member Summary

Constructors

AtpUnavailableException(String)

AtpUnavailableException(String, Object, Log)

Inherited Member Summary

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

AtpUnavailableException


Constructors

AtpUnavailableException(String)public AtpUnavailableException(java.lang.String reason)

AtpUnavailableException(String, Object, Log)public AtpUnavailableException(java.lang.String reason, java.lang.Objectsource, oracle.apps.fnd.common.Log log)

AutoFunctionalCompanion


oracle.apps.cz.cioAutoFunctionalCompanion

Syntaxpublic class AutoFunctionalCompanion extends FunctionalCompanion

java.lang.Object|+--FunctionalCompanion

|+--oracle.apps.cz.cio.AutoFunctionalCompanion

All Implemented Interfaces: IFunctionalCompanion

DescriptionBase object on which user functional companions can be based.

Member Summary

Constructors

AutoFunctionalCompanion()

Methods

onNew() Does nothing.

onRestore() Does nothing.

onSave() Does nothing.


Fields inherited from interface IFunctionalCompanion

FC_ON_AUTO_CONFIGURE, FC_ON_GENERATE_OUTPUT, FC_ON_NEW, FC_ON_RESTORE, FC_ON_SAVE, FC_ON_VALIDATE

Methods inherited from class FunctionalCompanion

AutoFunctionalCompanion


Constructors

AutoFunctionalCompanion()public AutoFunctionalCompanion()

Methods

onNew()public void onNew()

Does nothing.

onRestore()public void onRestore()

Does nothing.

onSave()public void onSave()

Does nothing.

autoConfigure(), generateOutput(), generateOutput(HttpServletResponse), getDescription(), getID(), getName(), getRuntimeNode(), initialize(IRuntimeNode, String, String, int), terminate(), toString(), validate()



Methods inherited from interface IFunctionalCompanion

autoConfigure(), generateOutput(), generateOutput(HttpServletResponse), getDescription(), getID(), getName(), getRuntimeNode(), initialize(IRuntimeNode, String, String, int), terminate(), validate()


BomExplosionException


oracle.apps.cz.cioBomExplosionException

Syntaxpublic class BomExplosionException extends java.lang.Exception



|+--oracle.apps.cz.cio.BomExplosionException


DescriptionException which is thrown when a client tries to create a configuration directly from an Apps bill of material and there is a problem with the explosion of the bill.

Member Summary

Methods

getExplosionDate()

getInventoryItemId()

getOrganizationId()





BomExplosionException


Methods

getExplosionDate()public java.util.Date getExplosionDate()

getInventoryItemId()public int getInventoryItemId()

getOrganizationId()public int getOrganizationId()



BomModel


oracle.apps.cz.cioBomModel

Syntaxpublic class BomModel

oracle.apps.cz.cio.BomModel

DescriptionRepresents configurable BOM Models.

Methods

getType()public int getType()

Member Summary

Methods

getType()

BomNode


oracle.apps.cz.cioBomNode

Syntaxpublic abstract class BomNode extends OptionFeatureNode implements IBomItem

java.lang.Object|+--RuntimeNode

|+--PricedNode

|+--StateNode

|+--StateCountNode

|+--OptionFeatureNode

|+--oracle.apps.cz.cio.BomNode

Direct Known Subclasses: BomOptionClass, BomStdItem

All Implemented Interfaces: IAtp, IBomItem, ICount, IOption, IOptionFeature, IPrice, IRuntimeNode, IState

DescriptionRepresents configurable BOM option classes.

Member Summary

Methods

addAtpNotification(String)

areOptionsCounted()

calculateAtpDate()

clearAtpDate()

BomNode


clearAtpNotifications()

deselect()

getAtpDate()

getAtpNotifications()

getComponentCode()

getDecimalDefaultQuantity()

getDecimalMaxQuantity()

getDecimalMinQuantity()

getDefaultQuantity()

getDiscountedPrice()

getInventoryItemId()

getItemKey()

getListPrice()

getMaxQuantity()

getMinQuantity()

getOrganizationId()

getPrimaryUomCode()

getState()

getUomCode()

hasDefaultQuantity()

hasMaxQuantity()

hasMinQuantity()

isOptionMutexed()

isRequired()

isSelected()

isSelectionMutexed()

Member Summary

BomNode


select()

select(IOption)

setAtpDate(Date)

setState(int)


Fields inherited from interface IState

FALSE, LFALSE, LTRUE, TOGGLE, TRUE, UFALSE, UNKNOWN, UTRUE

Fields inherited from interface IRuntimeNode

ALL_FEATURES, BOM_MODEL, BOM_OPTION_CLASS, BOM_STD_ITEM, BOOLEAN_FEATURE, COMPONENT, COMPONENT_SET, COUNT_FEATURE, DECIMAL_FEATURE, INTEGER_FEATURE, OPTION, OPTION_FEATURE, RESOURCE, TEXT_FEATURE, TOTAL

Methods inherited from class OptionFeatureNode

deselect(IOption), getAvailableOptions(), getMaxSelected(), getMinSelected(), getSelectableChildren(), getSelectedOption(), getSelectedOptions(), hasMaxSelected(), hasMinSelected()

Methods inherited from class StateCountNode

getCount(), getDecimalCount(), setCount(int), setDecimalCount(double), toString()

Methods inherited from class StateNode

isDefaultState(int), isFalse(), isFalseState(int), isLogic(), isLogicState(int), isTrue(), isTrueState(int), isUnknown(), isUnknownState(int), isUser(), isUserState(int), statesMatch(int, int), unset()

Methods inherited from class PricedNode

addDiscountedPricingNotification(String), addListPricingNotification(String), cacheCurrentDiscountedPrice(), clearDiscountedPrice(), clearDiscountedPricingNotifications(), clearListPricingNotifications(), getDiscountedPricingNotifications(), getExtendedPrice(), getListPricingNotifications(), getOldDiscountedPrice(), getPricingNotifications(), getPricingValue(), hasDiscountedPrice(), hasListPrice(), setDiscountedPrice(double), setListPrice(double)

Methods inherited from class RuntimeNode

Member Summary

BomNode


Methods

addAtpNotification(String)public void addAtpNotification(java.lang.String message)

areOptionsCounted()public boolean areOptionsCounted()

getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getFuncCompByID(int), getFuncCompByName(String), getFunctionalCompanions(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), getType(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasIntegerValue(), hasSelectionLineID(), hasState(), hasTextValue(), isDefaultAffected(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), lookupNodeID(Object), toString(boolean), typeToString(int)



Methods inherited from interface IOptionFeature

deselect(IOption), getMaxSelected(), getMinSelected(), getSelectableChildren(), getSelectedOption(), getSelectedOptions(), hasMaxSelected(), hasMinSelected()

Methods inherited from interface IState

isFalse(), isLogic(), isTrue(), isUnknown(), isUser(), unset()

Methods inherited from interface ICount

getCount(), getDecimalCount(), setCount(int), setDecimalCount(double)

Methods inherited from interface IPrice

getDatabaseID(), getDiscountedPricingNotifications(), getExtendedPrice(), getListPricingNotifications(), getPricingNotifications()

Methods inherited from interface IAtp

getDatabaseID()

Methods inherited from interface IRuntimeNode

getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), getType(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasSelectionLineID(), hasState(), hasTextValue(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), toString(boolean)


BomNode


Specified By: areOptionsCounted() in interface IOptionFeature

Specified By: areOptionsCounted() in interface IOptionFeature

calculateAtpDate()public void calculateAtpDate()

clearAtpDate()public void clearAtpDate()

clearAtpNotifications()public void clearAtpNotifications()

deselect()public void deselect()

Specified By: deselect() in interface IOption

getAtpDate()public java.util.Date getAtpDate()

Specified By: getAtpDate() in interface IAtp

getAtpNotifications()public java.lang.String getAtpNotifications()

Specified By: getAtpNotifications() in interface IAtp

getComponentCode()public java.lang.String getComponentCode()

BomNode


Specified By: getComponentCode() in interface IBomItem

getDecimalDefaultQuantity()public double getDecimalDefaultQuantity()

getDecimalMaxQuantity()public double getDecimalMaxQuantity()

Specified By: getDecimalMaxQuantity() in interface IBomItem

getDecimalMinQuantity()public double getDecimalMinQuantity()

Specified By: getDecimalMinQuantity() in interface IBomItem

getDefaultQuantity()public int getDefaultQuantity()

getDiscountedPrice()public double getDiscountedPrice()

Specified By: getDiscountedPrice() in interface IPrice



Overrides:getDiscountedPrice() in class PricedNode

BomNode


getInventoryItemId()public int getInventoryItemId()

Specified By: getInventoryItemId() in interface IBomItem

getItemKey()public java.lang.String getItemKey()

Specified By: getItemKey() in interface IPrice

Specified By: getItemKey() in interface IAtp



Overrides:getItemKey() in class PricedNode

getListPrice()public double getListPrice()

Specified By: getListPrice() in interface IPrice



BomNode


Overrides:getListPrice() in class PricedNode

getMaxQuantity()public int getMaxQuantity()

Specified By: getMaxQuantity() in interface IBomItem

getMinQuantity()public int getMinQuantity()

Specified By: getMinQuantity() in interface IBomItem

getOrganizationId()public int getOrganizationId()

Specified By: getOrganizationId() in interface IBomItem

getPrimaryUomCode()public java.lang.String getPrimaryUomCode()

Specified By: getPrimaryUomCode() in interface IBomItem

getState()public int getState()

Specified By: getState() in interface IState


BomNode




Overrides:getState() in class StateNode

getUomCode()public java.lang.String getUomCode()

Specified By: getUomCode() in interface IPrice

Specified By: getUomCode() in interface IAtp



Overrides:getUomCode() in class PricedNode

hasDefaultQuantity()public boolean hasDefaultQuantity()

hasMaxQuantity()public boolean hasMaxQuantity()

Specified By: hasMaxQuantity() in interface IBomItem

BomNode


hasMinQuantity()public boolean hasMinQuantity()

Specified By: hasMinQuantity() in interface IBomItem

isOptionMutexed()public boolean isOptionMutexed()

Specified By: isOptionMutexed() in interface IOption

isRequired()public boolean isRequired()

Specified By: isRequired() in interface IBomItem

isSelected()public boolean isSelected()

Specified By: isSelected() in interface IOption

isSelectionMutexed()public boolean isSelectionMutexed()

Specified By: isSelectionMutexed() in interface IOptionFeature


Overrides:isSelectionMutexed() in class OptionFeatureNode

BomNode


select()public void select()

Specified By: select() in interface IOption

select(IOption)public void select(IOption option)

Specified By: select(IOption) in interface IOptionFeature


Overrides:select(IOption) in class OptionFeatureNode

setAtpDate(Date)public void setAtpDate(java.util.Date atpDate)

setState(int)public void setState(int newState)

Specified By: setState(int) in interface IState




BomNode


Overrides:setState(int) in class StateNode

BomOptionClass


oracle.apps.cz.cioBomOptionClass

Syntaxpublic class BomOptionClass extends BomNode


|+--PricedNode

|+--StateNode

|+--StateCountNode


|+--BomNode

|+--oracle.apps.cz.cio.BomOptionClass


DescriptionRepresents configurable BOM option classes.

Member Summary

Methods

getType()



BomOptionClass





Methods inherited from class BomNode

addAtpNotification(String), areOptionsCounted(), calculateAtpDate(), clearAtpDate(), clearAtpNotifications(), deselect(), getAtpDate(), getAtpNotifications(), getComponentCode(), getDecimalDefaultQuantity(), getDecimalMaxQuantity(), getDecimalMinQuantity(), getDefaultQuantity(), getDiscountedPrice(), getInventoryItemId(), getItemKey(), getListPrice(), getMaxQuantity(), getMinQuantity(), getOrganizationId(), getPrimaryUomCode(), getState(), getUomCode(), hasDefaultQuantity(), hasMaxQuantity(), hasMinQuantity(), isOptionMutexed(), isRequired(), isSelected(), isSelectionMutexed(), select(), select(IOption), setAtpDate(Date), setState(int)










getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getFuncCompByID(int), getFuncCompByName(String), getFunctionalCompanions(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasIntegerValue(), hasSelectionLineID(), hasState(), hasTextValue(), isDefaultAffected(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), lookupNodeID(Object), toString(boolean), typeToString(int)



Methods inherited from interface IBomItem


BomOptionClass


Methods


Overrides:getType() in class RuntimeNode

getComponentCode(), getDecimalMaxQuantity(), getDecimalMinQuantity(), getInventoryItemId(), getMaxQuantity(), getMinQuantity(), getOrganizationId(), getPrimaryUomCode(), hasMaxQuantity(), hasMinQuantity(), isRequired()


areOptionsCounted(), deselect(IOption), getMaxSelected(), getMinSelected(), getSelectableChildren(), getSelectedOption(), getSelectedOptions(), hasMaxSelected(), hasMinSelected(), isSelectionMutexed(), select(IOption)


getState(), isFalse(), isLogic(), isTrue(), isUnknown(), isUser(), setState(int), unset()



Methods inherited from interface IOption

deselect(), isOptionMutexed(), isSelected(), select()


getDatabaseID(), getDiscountedPrice(), getDiscountedPricingNotifications(), getExtendedPrice(), getItemKey(), getListPrice(), getListPricingNotifications(), getPricingNotifications(), getUomCode()


getAtpDate(), getAtpNotifications(), getDatabaseID(), getItemKey(), getUomCode()


getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasSelectionLineID(), hasState(), hasTextValue(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), toString(boolean)


BomStdItem


oracle.apps.cz.cioBomStdItem

Syntaxpublic class BomStdItem extends BomNode


|+--PricedNode

|+--StateNode

|+--StateCountNode


|+--BomNode

|+--oracle.apps.cz.cio.BomStdItem


DescriptionRepresents configurable BOM models.

Member Summary

Methods

getType()



BomStdItem





Methods inherited from class BomNode

addAtpNotification(String), areOptionsCounted(), calculateAtpDate(), clearAtpDate(), clearAtpNotifications(), deselect(), getAtpDate(), getAtpNotifications(), getComponentCode(), getDecimalDefaultQuantity(), getDecimalMaxQuantity(), getDecimalMinQuantity(), getDefaultQuantity(), getDiscountedPrice(), getInventoryItemId(), getItemKey(), getListPrice(), getMaxQuantity(), getMinQuantity(), getOrganizationId(), getPrimaryUomCode(), getState(), getUomCode(), hasDefaultQuantity(), hasMaxQuantity(), hasMinQuantity(), isOptionMutexed(), isRequired(), isSelected(), isSelectionMutexed(), select(), select(IOption), setAtpDate(Date), setState(int)













Methods inherited from interface IBomItem


BomStdItem


Methods



getComponentCode(), getDecimalMaxQuantity(), getDecimalMinQuantity(), getInventoryItemId(), getMaxQuantity(), getMinQuantity(), getOrganizationId(), getPrimaryUomCode(), hasMaxQuantity(), hasMinQuantity(), isRequired()
















BooleanFeature


oracle.apps.cz.cioBooleanFeature

Syntaxpublic class BooleanFeature extends StateNode


|+--PricedNode

|+--StateNode

|+--oracle.apps.cz.cio.BooleanFeature

All Implemented Interfaces: IPrice, IRuntimeNode, IState

DescriptionRepresents a feature with a boolean value.

Member Summary

Methods

getType()






BooleanFeature


Methods



getState(), isDefaultState(int), isFalse(), isFalseState(int), isLogic(), isLogicState(int), isTrue(), isTrueState(int), isUnknown(), isUnknownState(int), isUser(), isUserState(int), setState(int), statesMatch(int, int), unset()


addDiscountedPricingNotification(String), addListPricingNotification(String), cacheCurrentDiscountedPrice(), clearDiscountedPrice(), clearDiscountedPricingNotifications(), clearListPricingNotifications(), getDiscountedPrice(), getDiscountedPricingNotifications(), getExtendedPrice(), getItemKey(), getListPrice(), getListPricingNotifications(), getOldDiscountedPrice(), getPricingNotifications(), getPricingValue(), getUomCode(), hasDiscountedPrice(), hasListPrice(), setDiscountedPrice(double), setListPrice(double)


getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getFuncCompByID(int), getFuncCompByName(String), getFunctionalCompanions(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasIntegerValue(), hasSelectionLineID(), hasState(), hasTextValue(), isDefaultAffected(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), lookupNodeID(Object), toString(), toString(boolean), typeToString(int)








getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDescription(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasSelectionLineID(), hasState(), hasTextValue(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), toString(boolean)


BooleanFeature



CIO


oracle.apps.cz.cioCIO

Syntaxpublic class CIO extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.CIO

DescriptionImplements a configuration integration object that can be used to create, save, restore and delete configurations.

Member Summary

Constructors

CIO() Constructs a newly allocated configuration integration object.

Methods

clearLogicFile(Object) Clears only the key specified file from the LCE file cache

clearLogicFileCache() Clears all LogicFile objects from the logic file cache.

close() Closes the CIO object and all associated runtime objects.

closeConfiguration(Configuration) Deletes all runtime structure and memory associated with a configuration.

createConfiguration(int, Context) Creates a new configuration based on a root model node ID representing a configurable product or component.

createConfiguration(int, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int)

Creates a new configuration based on a root model node ID representing a configurable product or component.

createConfiguration(int, int, Date, Context)

Creates a new BOM explosion configuration based on inventoryItemId, organizationId, and explosionDate representing a configurable product or component.

CIO


Constructors

CIO()public CIO()

createConfiguration(int, int, Date, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int)


createConfiguration(String, Context) Creates a new configuration based on a project name representing a configurable product or component.

createConfiguration(String, Context, IUserInterface, Calendar, Calendar, String, String)

Creates a new configuration based on a project name representing a configurable product or component.

getActiveModelPath() Gets the current active model path.

initTraceFile(Configuration, String)

openTraceFile(Configuration)

restoreConfiguration(int, int, Context) Restores a configuration from the database.

restoreConfiguration(int, int, int, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int)

Restores a configuration from the database.

setActiveModelPath(String) Sets the path to the directory where the CIO will look for logic files, and where it will store logic files when generating them out of the database.

trace(Configuration, String)

traceNoLine(Configuration, String)

tracing()



equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Member Summary

CIO


Constructs a newly allocated configuration integration object.

Methods

clearLogicFile(Object)public void clearLogicFile(java.lang.Object key)Clears only the key specified file from the LCE file cache

clearLogicFileCache()public void clearLogicFileCache()Clears all LogicFile objects from the logic file cache.

close()public void close()Closes the CIO object and all associated runtime objects.

closeConfiguration(Configuration)public void closeConfiguration(Configuration config)Deletes all runtime structure and memory associated with a configuration.

Parameters: config - the configuration to be deleted.

See Also: Configuration

createConfiguration(int, Context)public Configuration createConfiguration(int rootNodeID,oracle.apps.fnd.common.Context ctx)

Deprecated.Use createConfiguration(int, Context,IUserInterface, Calendar, String, String)

Creates a new configuration based on a root model node ID representing a configurable product or component.

CIO


Parameters: rootNodeID - the ID of the DIO model node representing the product or configuration to be configured.

ctx - the Context object representing the application context

Returns: a new configuration.

Throws: LogicalException - if a logic failure is encountered when initializing the configuration.

MissingFileException - if a logic file cannot be found in the active model path


createConfiguration(int, Context, IUserInterface, Calendar, Calendar, String, String, NameValue-PairSet, int)

public Configuration createConfiguration(int rootNodeID,oracle.apps.fnd.common.Context ctx, IUserInterface userInterface,java.util.Calendar modelLookupDate, java.util.Calendar eff_date,java.lang.String eff_usage_name, java.lang.String sessionId, NameValuePairSetinitParameters, int bomInitialQuantity)Creates a new configuration based on a root model node ID representing a configurable product or component.

Parameters: rootNodeID - the ID of the DIO model node representing the product or configuration to be configured.


userInterface - the User Interface reference

modelLookupDate - is the publication date to be saved with any future save

eff_date - the Effectivity date

eff_usage_name - the Effectivity Usage Name

sessionId - the name of the user interface session

CIO


initParameters - the session parameters

bomInitialQuantity - the initial quantity of the root BOM Model. Pass 0 if not a BOM Model.




ModelLookupException - if the modelLookupDate is null

EffectivityUsageException - if the effectivity is not valid


createConfiguration(int, int, Date, Context)public Configuration createConfiguration(int inventoryItemId, intorganizationId, java.util.Date explosionDate, oracle.apps.fnd.common.Contextctx)

Deprecated.Use createConfiguration(int, int, Date, Context, UI, Date, String, String)


Parameters: inventoryItemId - the inventory item id of the BOM explosion model

organizationId - the organization id of the BOM explosion model

explosionDate - the effective date of the BOM explosion model


CIO





createConfiguration(int, int, Date, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int)

public Configuration createConfiguration(int inventoryItemId, intorganizationId, java.util.Date explosionDate, oracle.apps.fnd.common.Contextctx, IUserInterface userInterface, java.util.Calendar modelLookupDate,java.util.Calendar eff_date, java.lang.String eff_usage_name, java.lang.StringsessionId, NameValuePairSet initParameters, int bomInitialQuantity)


Parameters: inventoryItemId - the inventory item id of the BOM explosion model

organizationId - the organization id of the BOM explosion model

explosionDate - the effective date of the BOM explosion model








bomInitialQuantity - the initial quantity of the root BOM Model. Pass 0 if not a BOM Model.

CIO







createConfiguration(String, Context)public Configuration createConfiguration(java.lang.String projectName,oracle.apps.fnd.common.Context ctx)

Deprecated.Use createConfiguration(String, Context, IUserInterface, Calendar, String, String)


Parameters: projectName - the name of the DIO project representing the product or configuration to be configured.





CIO



createConfiguration(String, Context, IUserInterface, Calendar, Calendar, String, String)public Configuration createConfiguration(java.lang.String projectName,oracle.apps.fnd.common.Context ctx, IUserInterface userInterface,java.util.Calendar modelLookupDate, java.util.Calendar eff_date,java.lang.String eff_usage_name, java.lang.String sessionId)


Parameters: projectName - the name of the DIO project representing the product or configuration to be configured.













CIO


getActiveModelPath()public java.lang.String getActiveModelPath()Gets the current active model path.

Returns: the active model path.

initTraceFile(Configuration, String)public void initTraceFile(Configuration config, java.lang.String filename)

openTraceFile(Configuration)public void openTraceFile(Configuration config)

restoreConfiguration(int, int, Context)public Configuration restoreConfiguration(int configHeaderID, int revNumber,oracle.apps.fnd.common.Context ctx)

Deprecated.Use restoreConfiguration(int, int, Context, IUserInterface, Date, String, String)


Parameters: configHeaderID - the ID of the header containing information identifying the configuration to be restored.

revNumber - the revision number of the header containing information identifying the configuration to be restored.


Returns: the restored configuration.



CIO



restoreConfiguration(int, int, int, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int)

public Configuration restoreConfiguration(int configHeaderID, int revNumber, introotNodeID, oracle.apps.fnd.common.Context ctx, IUserInterface userInterface,java.util.Calendar modelLookupDate, java.util.Calendar eff_date,java.lang.String eff_usage_name, java.lang.String sessionId, NameValuePairSetinitParameters, int bomInitialQuantity)


Parameters: configHeaderID - the ID of the header containing information identifying the configuration to be restored.

revNumber - the revision number of the header containing information identifying the configuration to be restored.

rootNodeID - the ID of the root model node that the configuration will be restored against. Pass -1 to restore the default.



modelLookupDate - the publication date to be saved with any future save





bomInitialQuantity - the initial quantity of the root BOM Model. Pass 0 to restore the default or if not a BOM Model.

Returns: the restored configuration.

CIO







setActiveModelPath(String)public void setActiveModelPath(java.lang.String path)

Sets the path to the directory where the CIO will look for logic files, and where it will store logic files when generating them out of the database.

Parameters: path - the path to the active model directory which should include the trailing path separator.

trace(Configuration, String)public void trace(Configuration config, java.lang.String cmd)

traceNoLine(Configuration, String)public void traceNoLine(Configuration config, java.lang.String cmd)

tracing()public boolean tracing()

CompanionNode


oracle.apps.cz.cioCompanionNode

Syntaxpublic class CompanionNode extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.CompanionNode

DescriptionProvides methods for extracting values from a model based on property annotations.

Created by a parent CompanionRoot from a functional companion and used to get property-mapped feature information.

Member Summary

Methods

getBoolean(String) Returns the value of a boolean feature.

getBoolean(String, boolean) Returns the value of a boolean feature, or the default if features is not present.

getChildren() Returns all of the CompanionNode children of this CompanionNode.

getDouble(String) Returns the value of a double feature.

getDouble(String, double) Returns the value of a double feature, or the default if features is not present.

getFeature(String) Get the runtime node representing a particular feature based on its property annotation.

getInteger(String) Returns the value of an integer feature.

getInteger(String, int) Returns the value of an integer feature, or the default if features is not present.

getString(String) Returns the value of a string feature.

getString(String, String) Returns the value of a string feature, or the default if the feature is not present.

CompanionNode


Methods

getBoolean(String)public boolean getBoolean(java.lang.String name)Returns the value of a boolean feature.

getBoolean(String, boolean)public boolean getBoolean(java.lang.String name, boolean dflt)Returns the value of a boolean feature, or the default if features is not present.

getChildren()public java.util.List getChildren()Returns all of the CompanionNode children of this CompanionNode.

getDouble(String)public double getDouble(java.lang.String name)Returns the value of a double feature.

getDouble(String, double)public double getDouble(java.lang.String name, double dflt)Returns the value of a double feature, or the default if features is not present.

getFeature(String)public IRuntimeNode getFeature(java.lang.String name)Get the runtime node representing a particular feature based on its property annotation.

hasFeature(String) Returns true if this CompanionNode contains the named feature.




Member Summary

CompanionNode


getInteger(String)public int getInteger(java.lang.String name)Returns the value of an integer feature.

getInteger(String, int)public int getInteger(java.lang.String name, int dflt)Returns the value of an integer feature, or the default if features is not present.

getString(String)public java.lang.String getString(java.lang.String name)Returns the value of a string feature.

getString(String, String)public java.lang.String getString(java.lang.String name, java.lang.String dflt)Returns the value of a string feature, or the default if the feature is not present.

hasFeature(String)public boolean hasFeature(java.lang.String name)Returns true if this CompanionNode contains the named feature.

CompanionRoot


oracle.apps.cz.cioCompanionRoot

Syntaxpublic abstract class CompanionRoot extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.CompanionRoot

DescriptionProvides functional companion implementors with property-based feature extraction.

An abstract class to be extended by functional companion implementors which attaches CompanionNode objects to runtime nodes and makes model features available to the function companion through a flexible system of property-based annotations.

In order to use this class, the implementor should provide implementations of getNodeIdentifier() , which returns the name of the property used to identify runtime nodes to which CompanionNodes will be attached, getFeatureIdentifier() which returns the name of the property used to identify features of the CompanionNode, and getNodeClass(String) which maps the value of the getNodeIdentifier property to the subclass of CompanionNode that should be instantiated to represent a particular node.

Member Summary

Constructors

CompanionRoot(IRuntimeNode) Creates a tree of companion node objects based on property annotations.

Methods

getFeatureIdentifier() Returns the name of the property used to identify companion features.

getNodeClass(String) Maps a node type to the class used to represent the node.

CompanionRoot


Constructors

CompanionRoot(IRuntimeNode)public CompanionRoot(IRuntimeNode root)Creates a tree of companion node objects based on property annotations.

Methods

getFeatureIdentifier()public abstract java.lang.String getFeatureIdentifier()

Returns the name of the property used to identify companion features.

getNodeClass(String)public abstract java.lang.String getNodeClass(java.lang.String nodeType)

Maps a node type to the class used to represent the node.

getNodeIdentifier()public abstract java.lang.String getNodeIdentifier()

Returns the name of the property used to identify companion nodes. Runtime nodes that have a property of this name will be mapped to CompanionNode objects. The value of the property will be mapped through the getNodeClass(String) method to determine which subclass of CompanionNode to instantiate.

getNodeIdentifier() Returns the name of the property used to identify companion nodes.

getRootNodes() Returns the root CompanionNode objects.




Member Summary

CompanionRoot


getRootNodes()public java.util.List getRootNodes()Returns the root CompanionNode objects.

CompanionValidationFailure


oracle.apps.cz.cioCompanionValidationFailure

Syntaxpublic class CompanionValidationFailure extends ValidationFailure

java.lang.Object|+--StatusInfo

|+--ValidationFailure

|+--oracle.apps.cz.cio.CompanionValidationFailure

DescriptionFailure produced by a functional companion object.

Member Summary

Constructors

CompanionValidationFailure(String, IRuntimeNode, IFunctionalCompanion)

Methods

equals(Object)

getCompanion() Returns the companion in which this validation failure occurred.

hashCode()


Fields inherited from class ValidationFailure

COMPANION_FAILURE, CUSTOM_FAILURE, MAX_FAILURE, MIN_FAILURE, MIN0_FAILURE, MINMAX_FAILURE, RESOURCE_FAILURE, RESTORE_FAILURE

CompanionValidationFailure


Constructors

Component


oracle.apps.cz.cioComponent

Syntaxpublic interface Component extends ComponentNode

All Superinterfaces: ComponentNode, IRuntimeNode

DescriptionInterface for components.

Member Summary

Fields

INSTANCE_TYPE_ADDED

INSTANCE_TYPE_DELETED

INSTANCE_TYPE_INITIAL

Methods

getFuncCompByID(int) Returns a particular functional companion based on its ID, null if no match.

getFuncCompByName(String) Returns a particular functional companion based on its name, null if no match.

getFunctionalCompanions() Returns a list of all functional companions associated with this node.

getInstanceNumber() Returns the instance number of this component (1 if not in a component set).

getInstanceType() Returns the instance typr of this component (INSTANCE_TYPE_INITIAL if virtual).

getPosition() returns the position of the this component in the component set or -1 if not a member of a component set

isVirtual() Returns true if this component is a virtual component.

setName(String) Sets a new name to the node.

Component


Fields

INSTANCE_TYPE_ADDEDpublic static final int INSTANCE_TYPE_ADDED

INSTANCE_TYPE_DELETEDpublic static final int INSTANCE_TYPE_DELETED

INSTANCE_TYPE_INITIALpublic static final int INSTANCE_TYPE_INITIAL

Methods

getFuncCompByID(int)public IFunctionalCompanion getFuncCompByID(int id)

Returns a particular functional companion based on its ID, null if no match.

getFuncCompByName(String)public IFunctionalCompanion getFuncCompByName(java.lang.String name)

Returns a particular functional companion based on its name, null if no match.




Methods inherited from interface ComponentNode

getChildComponentNodes(), getReferringOrDatabaseID(), getReferringOrPersistentID()



Component


getFunctionalCompanions()public java.util.List getFunctionalCompanions()Returns a list of all functional companions associated with this node.

getInstanceNumber()public int getInstanceNumber()Returns the instance number of this component (1 if not in a component set).

getInstanceType()public int getInstanceType()Returns the instance typr of this component (INSTANCE_TYPE_INITIAL if virtual).

getPosition()public int getPosition()returns the position of the this component in the component set or -1 if not a member of a component set

isVirtual()public boolean isVirtual()Returns true if this component is a virtual component.

setName(String)public void setName(java.lang.String newName)Sets a new name to the node.

ComponentNode


oracle.apps.cz.cioComponentNode

Syntaxpublic interface ComponentNode extends IRuntimeNode

All Known Subinterfaces: Component

All Superinterfaces: IRuntimeNode

All Known Implementing Classes: ComponentSet

Description

Deprecated.This interface is just for backward compatibility. Represents a set node that is a component or a component set.

Member Summary

Methods

getChildComponentNodes() Returns only the ComponentNode children.

getReferringOrDatabaseID() Returns the database ID of the referring node if it is a reference or the database ID of the RuntimeNode itself.

getReferringOrPersistentID() Returns the persistent ID of the referring node if it is a reference or the persistent ID of the RuntimeNode itself.



ComponentNode


Methods

getChildComponentNodes()public java.util.List getChildComponentNodes()Returns only the ComponentNode children.

getReferringOrDatabaseID()public int getReferringOrDatabaseID()Returns the database ID of the referring node if it is a reference or the database ID of the RuntimeNode itself.

getReferringOrPersistentID()public int getReferringOrPersistentID()Returns the persistent ID of the referring node if it is a reference or the persistent ID of the RuntimeNode itself.





ComponentSet


oracle.apps.cz.cioComponentSet

Syntaxpublic class ComponentSet extends RuntimeNode implements ComponentNode,IIntegerMinMax


|+--oracle.apps.cz.cio.ComponentSet

All Implemented Interfaces: ComponentNode, IIntegerMinMax, IRuntimeNode

DescriptionRepresents a set of configurable components.

Member Summary

Methods

add()

addCompSetEventListener(ICompSetEventListener)

Add a listener that is notified when a component is added or deleted.

addConfigEventListener(ICompSetEventListener)

delete(Component)

getChildByInstanceNumber(int)

getChildComponentNodes()

getCount()

getMax()

getMin()

ComponentSet


getReferringOrDatabaseID() Returns the database ID of the referring node if it is a reference or the database ID of the RuntimeNode itself.

getReferringOrPersistentID() Returns the persistent ID of the referring node if it is a reference or the persistent ID of the RuntimeNode itself.

getType()

hasMax()

hasMin()

removeCompSetEventListener(ICompSetEventListener)

Remove a listener that is notified when a component is added or deleted.

removeConfigEventListener(ICompSetEventListener)










Member Summary

ComponentSet


Methods

add()public Component add()

addCompSetEventListener(ICompSetEventListener)public void addCompSetEventListener(ICompSetEventListener listener)


addConfigEventListener(ICompSetEventListener)public void addConfigEventListener(ICompSetEventListener listener)

Deprecated.Use addCompSetEventListener instead Add a listener that is notified when a component is added or deleted.

delete(Component)public void delete(Component component)

getChildByInstanceNumber(int)public Component getChildByInstanceNumber(int instNum)

getChildComponentNodes()public java.util.List getChildComponentNodes()

Specified By: getChildComponentNodes() in interface ComponentNode

getCount()public int getCount()

getMax()public int getMax()

Specified By: getMax() in interface IIntegerMinMax

ComponentSet


getMin()public int getMin()

Specified By: getMin() in interface IIntegerMinMax

getReferringOrDatabaseID()public int getReferringOrDatabaseID()Returns the database ID of the referring node if it is a reference or the database ID of the RuntimeNode itself.

Specified By: getReferringOrDatabaseID() in interface ComponentNode

getReferringOrPersistentID()public int getReferringOrPersistentID()

Returns the persistent ID of the referring node if it is a reference or the persistent ID of the RuntimeNode itself.

Specified By: getReferringOrPersistentID() in interface ComponentNode


Specified By: getType() in interface IRuntimeNode



hasMax()public boolean hasMax()

ComponentSet


Specified By: hasMax() in interface IIntegerMinMax

hasMin()public boolean hasMin()

Specified By: hasMin() in interface IIntegerMinMax

removeCompSetEventListener(ICompSetEventListener)public void removeCompSetEventListener(ICompSetEventListener listener)


removeConfigEventListener(ICompSetEventListener)public void removeConfigEventListener(ICompSetEventListener listener)

Deprecated.Use removeCompSetEventListener instead Remove a listener that is notified when a component is added or deleted.

ConfigTransaction


oracle.apps.cz.cioConfigTransaction

Syntaxpublic class ConfigTransaction extends oracle.apps.cz.cio.BasicConfigAction

java.lang.Object|+--oracle.apps.cz.cio.BasicConfigAction

|+--oracle.apps.cz.cio.ConfigTransaction

DescriptionRepresents a configuration transaction.

Methods

useInitialRequests()public void useInitialRequests()

Member Summary

Methods

useInitialRequests()


Methods inherited from class oracle.apps.cz.cio.BasicConfigAction

setTracing



Configuration


oracle.apps.cz.cioConfiguration

Syntaxpublic class Configuration

oracle.apps.cz.cio.Configuration

DescriptionThe top-level entry point to a configuration.

Member Summary

Fields

ATP_APPS_107_110 Represents Oracle Apps 10.7/11.0 ATP mode.

ATP_CALLBACK Represents callback ATP mode.

ATP_DISABLED For the case when no valid ATP parameter combination is found.

m_sequence

PRICE_APPS_107_110 Represents Oracle Apps 10.7/11.0 pricing mode.

PRICE_MULT_ITEMS Represents multiple item callback pricing mode.

PRICE_MULT_ITEMS_MLS Represents multiple item MLS callback pricing mode.

PRICE_SINGLE_ITEM Represents single item callback pricing mode.

PRICING_DISABLED For the case when no valid pricing parameter combination is found.

Methods

addConfigEventListener(IConfigEventListener)


addConfigMessage(String, String) Adds a configuration message to be saved to the cz_config_messages table.

beginConfigTransaction() Creates a new transaction.

beginConfigTransaction(boolean) Creates a new transaction and specifies the auto commit mode.

calculateAtpDates() Calculates ATP dates for all IAtp nodes in the tree.

Configuration


calculateListPrices() Calculates list prices of all IPrice nodes within configuration.

calculateListPrices(List) Calculates list prices of the given IPrice nodes within configuration.

canPerform() Returns true if there is at least one undone or not commited transaction that can be performed.

canUndo() Returns true if there are performed transactions that can be undone.

clearConfigMessages() Removes all configuration messages added by addConfigMessage.

close() Close the Configuration object and all associated runtime objects.

commitConfigTransaction(ConfigTransaction)

Commits the given transaction if it matches with current one in the configuration.

endConfigTransaction(ConfigTransaction)

Ends the given transaction if it matches with current one in the configuration.

finalizeWorkaround()

getAltPricingAtpContext() Returns context that was added to the configuration through setAltPricingAtpContext, or null if no alternate pricing/ATP context exists.

getAtpMode() Will return the ATP mode that will be used by the configuration (ATP_APPS_107_110 or ATP_CALLBACK).

getAvailableNodes(List)

getCIO() Gets the CIO that created this configuration.

getConfigHeaderCheckoutUser() Gets the user who has the config header checked out.

getConfigHeaderDateCreated() Gets the date when the config header was creaed.

getConfigHeaderDescription() Gets the description of the config header.

getConfigHeaderEffectiveFrom()

getConfigHeaderEffectiveTo()

getConfigHeaderId() Gets the id of the config header.

getConfigHeaderLastUpdateDate() Gets the date when the config header was last updated.

getConfigHeaderName() Gets the name of the config header.

getConfigHeaderNote() Gets the note of the config header.

getConfigHeaderNumberQuotesUsedIn()

Gets the config header number quotes used in.

Member Summary

Configuration


getConfigHeaderOpportunityHeaderId()

Gets the opportunity header id of the config header .

getConfigHeaderRevision() Gets the revision of the config header.

getConfigHeaderStatus() Gets the status of the config header.

getConfigHeaderUiDefinitionId() Gets the UI definition id in the config header.

getConfigHeaderUserIdCreated() Gets the id of the user who created the config header.

getContext() Returns the Context object associated with this configuration

getCurrencyFormat() Returns the currency format object.

getDefaultAffectedNodes()

getDeltaListIterator()

getEffectiveDate() Gets the Effectivity Date of the config.

getEffectiveUsageID() Gets the Effectivity Usage ID of the config.

getInitParameters() Gets initialization parameters, which are stored in a NameValuePairSet object.

getLastContradiction() Returns the most recent contradiction.

getNodeFromPath(String)

getPathForNode(IRuntimeNode)

getPricingMode() Will return the pricing mode that will be used by the configuration (PRICE_APPS_107_110, PRICE_MULT_ITEMS, or PRICE_SINGLE_ITEM).

getProjectID() Gets the database ID of the project from which this configuration was created.

getRootBomModel() Returns the root BOM Model node, if there is associated with this configuration.

getRootBomModel(int, int) Returns the root BOM Model node with the given inventory item ID and organization ID

getRootComponent() Gets the root product or component of the configuration.

getRootComponentDbId() Gets the database id of the root component.

getRootComponentPersistentId() Gets the persistent id of the root component.

getRuntimeNode(int) Fetches a runtime node based on a runtime ID.

getRuntimeNodes() Fetches all runtime nodes in this configuration.

Member Summary

Configuration


getSelectedItems() Gets a collection of status info objects describing all selected items in the configuration.

getStringDeltaList()

getTotalDiscountedPrice() Returns rolled up discounted price of the configuration.

getTotalListPrice() Returns rolled up list price of the configuration.

getTransactionDepth() Returns the number of nested transactions (depth).

getUnsatisfiedItems() Gets a collection of status info objects describing all unsatisfied items in the configuration.

getUserInterface() Gets the IUserInterface reference assigned to this configuration.

getUserRequests()

getValidationFailures() Gets a collection of validation failures describing current problems with the configuration.

isUnsatisfied() Returns true if the configuration is incomplete.

perform() Perform the next pending transaction.

removeConfigEventListener(IConfigEventListener)


restartConfiguration() Restart the current configuration instance without destroying the objects

rollbackConfigTransaction(ConfigTransaction)

Rolls back the given transaction if it matches with current one in the configuration.

save() Saves the restored configuration.

saveAs(int, int) Saves over the current configuration.

saveNew() Saves a whole new configuration.

saveNewRev() Saves a new revision of the restored configuration.

setAltPricingAtpContext(Context) If pricing and ATP information should be retrieved from an alternate Apps database, the setAltPricingAtpContext method should be called immediately after the Configuration is created.

setConfigHeaderCheckoutUser(String)

Sets the user who has checked out the config header.

setConfigHeaderDescription(String) Sets the config header description.

Member Summary

Configuration


Fields

ATP_APPS_107_110public static final int ATP_APPS_107_110

Represents Oracle Apps 10.7/11.0 ATP mode.

ATP_CALLBACKpublic static final int ATP_CALLBACK

Represents callback ATP mode.

ATP_DISABLEDpublic static final int ATP_DISABLED

For the case when no valid ATP parameter combination is found.

m_sequencepublic final int m_sequence

setConfigHeaderEffectiveFrom(Timestamp)

setConfigHeaderEffectiveTo(Timestamp)

setConfigHeaderName(String) Sets the config header name.

setConfigHeaderNote(String) Sets the config header note.

setConfigHeaderOpportunityHeaderId(int)

Sets the config header opportunity header id.

setConfigHeaderUiDefinitionId(int) Sets the config header UI definition id.

setInitParameters(NameValuePairSet)

Sets configuration initialization parameters, e.g.

setTimeEvent(TimeEvent) Sets the timing object this session is to work with

undo() Undo the previous transaction.

updateDefaultNodes()

Member Summary

Configuration


PRICE_APPS_107_110public static final int PRICE_APPS_107_110Represents Oracle Apps 10.7/11.0 pricing mode.

PRICE_MULT_ITEMSpublic static final int PRICE_MULT_ITEMSRepresents multiple item callback pricing mode.

PRICE_MULT_ITEMS_MLSpublic static final int PRICE_MULT_ITEMS_MLSRepresents multiple item MLS callback pricing mode.

PRICE_SINGLE_ITEMpublic static final int PRICE_SINGLE_ITEMRepresents single item callback pricing mode.

PRICING_DISABLEDpublic static final int PRICING_DISABLEDFor the case when no valid pricing parameter combination is found.

Methods

addConfigEventListener(IConfigEventListener)public void addConfigEventListener(IConfigEventListener listener)


addConfigMessage(String, String)public void addConfigMessage(java.lang.String keyword, java.lang.String message)

Adds a configuration message to be saved to the cz_config_messages table. Messages are cleared from the Configuration object when the configuration and messages are saved.

Parameters: keyword - keyword describing the type of message, e.g. "CONTRADICTION"

message - message string

Configuration


beginConfigTransaction()public ConfigTransaction beginConfigTransaction()Creates a new transaction.

Returns: a reference to the newly created transaction.

beginConfigTransaction(boolean)public ConfigTransaction beginConfigTransaction(boolean autoCommit)Creates a new transaction and specifies the auto commit mode.

Returns: a reference to the newly created transaction.

calculateAtpDates()public java.util.Date calculateAtpDates()

Calculates ATP dates for all IAtp nodes in the tree. ATP values can then be retrieved using IAtp.getAtpDate().

Returns: configuration level ATP date if calculated, null if not

Throws: AtpUnavailableException - thrown if configuration initialization parameters required to run ATP check have not all been provided

calculateListPrices()public void calculateListPrices()

Calculates list prices of all IPrice nodes within configuration. Prices are retrieved through IPrice.getListPrice.

calculateListPrices(List)public void calculateListPrices(java.util.List nodeList)

Calculates list prices of the given IPrice nodes within configuration. Prices are retrieved through IPrice.getListPrice.

Configuration


canPerform()public boolean canPerform()Returns true if there is at least one undone or not commited transaction that can be performed.

canUndo()public boolean canUndo()Returns true if there are performed transactions that can be undone.

clearConfigMessages()public void clearConfigMessages()Removes all configuration messages added by addConfigMessage.

close()public void close()Close the Configuration object and all associated runtime objects.

commitConfigTransaction(ConfigTransaction)public void commitConfigTransaction(ConfigTransaction transaction)Commits the given transaction if it matches with current one in the configuration.

Parameters: transaction - A transaction reference.

endConfigTransaction(ConfigTransaction)public void endConfigTransaction(ConfigTransaction transaction)Ends the given transaction if it matches with current one in the configuration.


finalizeWorkaround()public void finalizeWorkaround()

getAltPricingAtpContext()public oracle.apps.fnd.common.Context getAltPricingAtpContext()

Configuration


Returns context that was added to the configuration through setAltPricingAtpContext, or null if no alternate pricing/ATP context exists.

getAtpMode()public int getAtpMode()

Will return the ATP mode that will be used by the configuration (ATP_APPS_107_110 or ATP_CALLBACK).

Throws: AtpUnavailableException - thrown if a complete set of ATP parameters has not been provided through setInitParameters.

getAvailableNodes(List)public java.util.Map getAvailableNodes(java.util.List watchedNodes)

getCIO()public CIO getCIO()

Gets the CIO that created this configuration.

Returns: the CIO that created this configuration.

See Also: CIO

getConfigHeaderCheckoutUser()public java.lang.String getConfigHeaderCheckoutUser()Gets the user who has the config header checked out.

Returns: the config header checkout user.

getConfigHeaderDateCreated()public java.sql.Timestamp getConfigHeaderDateCreated()Gets the date when the config header was creaed.

Configuration


Returns: the config header creation date.

getConfigHeaderDescription()public java.lang.String getConfigHeaderDescription()Gets the description of the config header.

Returns: the config header description.

getConfigHeaderEffectiveFrom()public java.sql.Timestamp getConfigHeaderEffectiveFrom()

Deprecated.Gets the date from which the config header is effective.

Returns: the config header 'Effective From' date.

getConfigHeaderEffectiveTo()public java.sql.Timestamp getConfigHeaderEffectiveTo()

Deprecated.Gets the date towhich the config header is effective.

Returns: the config header 'Effective To' date.

getConfigHeaderId()public int getConfigHeaderId()Gets the id of the config header.

Returns: the config header id.

Configuration


getConfigHeaderLastUpdateDate()public java.sql.Timestamp getConfigHeaderLastUpdateDate()Gets the date when the config header was last updated.

Returns: the config header last update date.

getConfigHeaderName()public java.lang.String getConfigHeaderName()Gets the name of the config header.

Returns: the config header name.

getConfigHeaderNote()public java.lang.String getConfigHeaderNote()

Gets the note of the config header.

Returns: the config header note.

getConfigHeaderNumberQuotesUsedIn()public int getConfigHeaderNumberQuotesUsedIn()

Gets the config header number quotes used in.

Returns: the config header number quotes used in.

getConfigHeaderOpportunityHeaderId()public int getConfigHeaderOpportunityHeaderId()

Gets the opportunity header id of the config header .

Returns: the config header opportunity header id.

Configuration


getConfigHeaderRevision()public int getConfigHeaderRevision()Gets the revision of the config header.

Returns: the config header revision.

getConfigHeaderStatus()public java.lang.String getConfigHeaderStatus()Gets the status of the config header.

Returns: the config header status.

getConfigHeaderUiDefinitionId()public int getConfigHeaderUiDefinitionId()

Gets the UI definition id in the config header.

Returns: the config header UI definition id.

getConfigHeaderUserIdCreated()public int getConfigHeaderUserIdCreated()

Gets the id of the user who created the config header.

Returns: the config header user id created.

getContext()public oracle.apps.fnd.common.Context getContext()

Returns the Context object associated with this configuration

getCurrencyFormat()public java.text.DecimalFormat getCurrencyFormat()

Returns the currency format object. Caller can call this method to get the format object to format prices for display after asking discounted Price or list price from

Configuration


configuration. Will return null if no price format info is returned from the pricing callback.

getDefaultAffectedNodes()public java.util.Map getDefaultAffectedNodes()

getDeltaListIterator()public oracle.apps.cz.cio.DeltaListIterator getDeltaListIterator()

getEffectiveDate()public java.util.Calendar getEffectiveDate()

Gets the Effectivity Date of the config.

Returns: the Effectivity Date of the config.

getEffectiveUsageID()public int getEffectiveUsageID()

Gets the Effectivity Usage ID of the config.

Returns: the Effectivity Usage ID of the config.

getInitParameters()public NameValuePairSet getInitParameters()Gets initialization parameters, which are stored in a NameValuePairSet object.

Returns: initParameters object

getLastContradiction()public LogicalException getLastContradiction()Returns the most recent contradiction.

getNodeFromPath(String)public IRuntimeNode getNodeFromPath(java.lang.String path)

Configuration


getPathForNode(IRuntimeNode)public java.lang.String getPathForNode(IRuntimeNode node)

getPricingMode()public int getPricingMode()Will return the pricing mode that will be used by the configuration (PRICE_APPS_107_110, PRICE_MULT_ITEMS, or PRICE_SINGLE_ITEM).

Throws: PricingUnavailableException - thrown if a complete set of pricing parameters has not been provided through setInitParameters.

getProjectID()public int getProjectID()Gets the database ID of the project from which this configuration was created.

Returns: the project ID.

getRootBomModel()public BomModel getRootBomModel()

Returns the root BOM Model node, if there is associated with this configuration.

getRootBomModel(int, int)public BomModel getRootBomModel(int inventoryItemId, int organizationId)

Returns the root BOM Model node with the given inventory item ID and organization ID

getRootComponent()public Component getRootComponent()

Gets the root product or component of the configuration.

Returns: the root product or component.

See Also: Component, RuntimeNode

Configuration


getRootComponentDbId()public int getRootComponentDbId()Gets the database id of the root component.

Returns: the root component db id.

getRootComponentPersistentId()public int getRootComponentPersistentId()Gets the persistent id of the root component.

Returns: the root component db id.

getRuntimeNode(int)public IRuntimeNode getRuntimeNode(int runtimeID)

Fetches a runtime node based on a runtime ID.

Parameters: runtimeID - the runtime ID of the desired node.

Returns: the corresponding runtime node.

See Also: IRuntimeNode

getRuntimeNodes()public java.util.List getRuntimeNodes()

Fetches all runtime nodes in this configuration.

Returns: A List of runtime nodes.

getSelectedItems()public java.util.Collection getSelectedItems()

Configuration


Gets a collection of status info objects describing all selected items in the configuration.

Returns: the collection of status info objects.

getStringDeltaList()public java.lang.String getStringDeltaList()

getTotalDiscountedPrice()public double getTotalDiscountedPrice()

Returns rolled up discounted price of the configuration. Discounted prices on selected items are available after this call through IPrice.getDiscountedPrice.

getTotalListPrice()public double getTotalListPrice()

Returns rolled up list price of the configuration. Gets the list price of all the selected item and then rolls it up to give a running total list price.

getTransactionDepth()public int getTransactionDepth()

Returns the number of nested transactions (depth).

Returns: the transaction depth.

getUnsatisfiedItems()public java.util.Collection getUnsatisfiedItems()Gets a collection of status info objects describing all unsatisfied items in the configuration.

Returns: the collection of status info objects.

getUserInterface()public IUserInterface getUserInterface()Gets the IUserInterface reference assigned to this configuration.

Configuration


Returns: the IUserInterface reference assigned to this configuration.

See Also: IUserInterface

getUserRequests()public java.util.List getUserRequests()

getValidationFailures()public java.util.Collection getValidationFailures()

Gets a collection of validation failures describing current problems with the configuration.

Returns: the collection of validation failures.

isUnsatisfied()public boolean isUnsatisfied()

Returns true if the configuration is incomplete.

Returns: a boolean indicating whether the configuration is unsatisfied.

perform()public void perform()

Perform the next pending transaction.

removeConfigEventListener(IConfigEventListener)public void removeConfigEventListener(IConfigEventListener listener)


restartConfiguration()public void restartConfiguration()

Restart the current configuration instance without destroying the objects

Configuration


rollbackConfigTransaction(ConfigTransaction)public void rollbackConfigTransaction(ConfigTransaction transaction)Rolls back the given transaction if it matches with current one in the configuration.


save()public void save()Saves the restored configuration.

Throws: NoConfigHeaderException - when this configuration hasn't been previously saved. Consider calling SaveNew().

ModifiedConfigOverwriteException - when this configuration has been saved by "another user". Consider calling SaveNewRev() or SaveNew().

saveAs(int, int)public void saveAs(int configHeaderID, int revNumber)

Saves over the current configuration. It uses the passed ID and revision number to open a ConfigHeader object and to save the configuration int it

Throws: ModifiedConfigOverwriteException - when this configuration has been saved by "another user". Consider calling SaveNewRev() or SaveNew().

saveNew()public void saveNew()

Saves a whole new configuration.

saveNewRev()public void saveNewRev()

Saves a new revision of the restored configuration.

Throws: NoConfigHeaderException - when this configuration hasn't been previously saved. Consider calling SaveNew().

Configuration


setAltPricingAtpContext(Context)public void setAltPricingAtpContext(oracle.apps.fnd.common.Context ctx)If pricing and ATP information should be retrieved from an alternate Apps database, the setAltPricingAtpContext method should be called immediately after the Configuration is created.

Parameters: ctx - Context which represents session on database from which pricing and ATP information is retrieved

setConfigHeaderCheckoutUser(String)public void setConfigHeaderCheckoutUser(java.lang.String user)Sets the user who has checked out the config header.

setConfigHeaderDescription(String)public void setConfigHeaderDescription(java.lang.String description)Sets the config header description.

setConfigHeaderEffectiveFrom(Timestamp)public void setConfigHeaderEffectiveFrom(java.sql.Timestamp effFrom)

Deprecated.Sets the date from which the config header is effective.

setConfigHeaderEffectiveTo(Timestamp)public void setConfigHeaderEffectiveTo(java.sql.Timestamp effTo)

Deprecated.Sets the date to which the config header is effective.

setConfigHeaderName(String)public void setConfigHeaderName(java.lang.String name)

Sets the config header name.

setConfigHeaderNote(String)public void setConfigHeaderNote(java.lang.String note)

Sets the config header note.

Configuration


setConfigHeaderOpportunityHeaderId(int)public void setConfigHeaderOpportunityHeaderId(int id)Sets the config header opportunity header id.

setConfigHeaderUiDefinitionId(int)public void setConfigHeaderUiDefinitionId(int id)Sets the config header UI definition id.

setInitParameters(NameValuePairSet)public void setInitParameters(NameValuePairSet initParameters)Sets configuration initialization parameters, e.g. order header information. All parameter values should be provided as String objects.

To use the callback pricing mechanism, the following parameters must be provided: "pricing_package_name" (required), "price_mult_items_proc" or "price_single_item_proc" (one is required), "configurator_session_key" (required)

To use Apps 10.7/11.0 pricing for BomNodes ("AMNT" pricing method only), the following parameters must be provided: "price_list_id" (required), "pricing_attribute1" (optional), "pricing_attribute2" (optional), "pricing_attribute3" (optional), "pricing_attribute4" (optional), "pricing_attribute5" (optional), "pricing_attribute6" (optional), "pricing_attribute7" (optional), "pricing_attribute8" (optional), "pricing_attribute9" (optional), "pricing_attribute10" (optional), "pricing_attribute11" (optional), "pricing_attribute12" (optional), "pricing_attribute13" (optional), "pricing_attribute14" (optional), "pricing_attribute15" (optional), "ship_to_site_use_id" (optional), "customer_id" (optional), "invoice_to_site_use_id" (optional), "po_number" (optional), "agreement_id" (optional), "agreement_type_code" (optional), "order_type_id" (optional), "gsa" (optional).

NOTE: If the callback parameters and price_list_id are both provided, then the pricing callback will be run to determine prices.

To use the callback ATP mechanism, the following parameters must be provided: "atp_package_name" (required), "get_atp_dates_proc" (required), "configurator_session_key" (required), "warehouse_id" (required), "requested_date" (optional), and either "ship_to_org_id" (required) or "customer_id" and "customer_site_id" (required),

To use Apps 10.7/11.0 ATP calculation methods, the following parameters must be provided: "user_id" (required), "application_id" (required), "responsibility_id" (required), "atp_timeout" (required)

Configuration


setTimeEvent(TimeEvent)public void setTimeEvent(oracle.apps.cz.utilities.TimeEvent timer)Sets the timing object this session is to work with

Parameters: timer - - A TimeEvent object

undo()public void undo()Undo the previous transaction.

updateDefaultNodes()public void updateDefaultNodes()

CountFeature


oracle.apps.cz.cioCountFeature

Syntaxpublic class CountFeature extends StateCountNode implements IInteger,IIntegerMinMax


|+--PricedNode

|+--StateNode

|+--StateCountNode

|+--oracle.apps.cz.cio.CountFeature

All Implemented Interfaces: ICount, IInteger, IIntegerMinMax, IPrice, IRuntimeNode, IState

DescriptionRepresents a countable integer feature. A count feature is similar to an integer feature except that its minimum value must be greater than or equal to zero.

Member Summary

Methods

getIntValue()

getMax()

getMin()

getType()

hasMax()

hasMin()

CountFeature


Methods

getIntValue()public int getIntValue()

Specified By: getIntValue() in interface IInteger









getState(), isFalse(), isLogic(), isTrue(), isUser(), setState(int)




CountFeature









setIntValue(int)public void setIntValue(int newValue)

Specified By: setIntValue(int) in interface IInteger

DecimalFeature


oracle.apps.cz.cioDecimalFeature

Syntaxpublic class DecimalFeature extends DecimalNode implements IDecimalMinMax


|+--PricedNode

|+--ReadOnlyDecimalNode

|+--DecimalNode

|+--oracle.apps.cz.cio.DecimalFeature

All Implemented Interfaces: IDecimal, IDecimalMinMax, IPrice, IReadOnlyDecimal, IRuntimeNode

DescriptionRepresents a feature with a decimal value.

Member Summary

Methods

getMax()

getMin()

getType()

hasMax()

hasMin()

DecimalFeature





Methods inherited from class DecimalNode

setDecimalValue(double), toString(), unset()

Methods inherited from class ReadOnlyDecimalNode

getDecimalValue(), isUnknown()







Methods inherited from interface IDecimal

setDecimalValue(double), unset()

Methods inherited from interface IReadOnlyDecimal





DecimalFeature


Methods

getMax()public double getMax()

Specified By: getMax() in interface IDecimalMinMax

getMin()public double getMin()

Specified By: getMin() in interface IDecimalMinMax





Specified By: hasMax() in interface IDecimalMinMax



DecimalFeature



Specified By: hasMin() in interface IDecimalMinMax

DecimalNode


oracle.apps.cz.cioDecimalNode

Syntaxpublic abstract class DecimalNode extends ReadOnlyDecimalNode implementsIDecimal


|+--PricedNode


|+--oracle.apps.cz.cio.DecimalNode

Direct Known Subclasses: DecimalFeature, Resource, Total

All Implemented Interfaces: IDecimal, IPrice, IReadOnlyDecimal, IRuntimeNode

DescriptionAn abstract class implementing behavior common to objects with a decimal value.

Member Summary

Methods

setDecimalValue(double)

toString()

unset()

DecimalNode


















getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDescription(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), getType(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasSelectionLineID(), hasState(), hasTextValue(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), toString(boolean)

DecimalNode


Methods

setDecimalValue(double)public void setDecimalValue(double newValue)

Specified By: setDecimalValue(double) in interface IDecimal

toString()public java.lang.String toString()

Overrides:toString() in class ReadOnlyDecimalNode

unset()public void unset()

Specified By: unset() in interface IDecimal

EffectivityUsageException


oracle.apps.cz.cioEffectivityUsageException

Syntaxpublic class EffectivityUsageException extends java.lang.Exception



|+--oracle.apps.cz.cio.EffectivityUsageException


DescriptionOBSOLETE. See oracle.apps.cz.utilities.EffectivityUsageException Signals that that the specified effectivity id could not be found.

Member Summary

Constructors

EffectivityUsageException(String)






EffectivityUsageException


Constructors

EffectivityUsageException(String)public EffectivityUsageException(java.lang.String message)

Factory


oracle.apps.cz.cioFactory

Syntaxpublic class Factory extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.Factory

DescriptionProvides a class factory for the CIO to clients that do not support arguments to constructors.

Member Summary

Constructors

Factory()

Methods

createCIO() Creates an instance of the CIO.

createContext(String, String, String, String)

Creates the database context object which is required by most CIO methods.

createContext(String, String, String, String, String, String, String)

Creates the database context object which is required by most CIO methods.

loadDriver(String) Loads the JDBC driver named by the argument.




Factory


Constructors

Factory()public Factory()

Methods

createCIO()public CIO createCIO()

Creates an instance of the CIO.

createContext(String, String, String, String)public oracle.apps.fnd.common.Context createContext(java.lang.String url,java.lang.String uname, java.lang.String pwd, java.lang.String owner)

Creates the database context object which is required by most CIO methods. This method requires a database user and password.

Parameters: url - database connection URL that specifies JDBC driver and datasource

uname - database username

pwd - database password

owner - Oracle Configurator schema owner

createContext(String, String, String, String, String, String, String)public oracle.apps.fnd.common.Context createContext(java.lang.String url,java.lang.String appsUsername, java.lang.String appsPassword, java.lang.StringgatewayUsername, java.lang.String gatewayPassword, java.lang.String fndNam,java.lang.String applServerId)

Creates the database context object which is required by most CIO methods. This method uses Apps FND authentication to validate the user.

Parameters: url - database connection URL, identifies JDBC driver and data source

appsUsername - Oracle Applications user name

appsPassword - Oracle Applications password for appsUsername

Factory


gatewayUsername - gateway user name

gatewayPassword - password for gatewayUsername

fndNam - Apps schema owner

applServerId - application server ID, only used if its security feature is ON (OFF by default)

loadDriver(String)public void loadDriver(java.lang.String driver)

Loads the JDBC driver named by the argument.

Throws: ClassNotFoundException - if the driver cannot be loaded.

FuncCompCreationException


oracle.apps.cz.cioFuncCompCreationException

Syntaxpublic class FuncCompCreationException extends java.lang.RuntimeException



|+--java.lang.RuntimeException

|+--oracle.apps.cz.cio.FuncCompCreationException


DescriptionSignalled if a functional companion cannot be created.

Member Summary

Methods

getDescrption() Returns the description of the failed companion.

getID() Returns the database ID of the failed companion.

getName() Returns the name of the failed companion.

getProgString() Returns the program string used when trying to create the companion.




FuncCompCreationException


Methods

getDescrption()public java.lang.String getDescrption()

Returns the description of the failed companion.

getID()public int getID()

Returns the database ID of the failed companion.

getName()public java.lang.String getName()

Returns the name of the failed companion.

getProgString()public java.lang.String getProgString()

Returns the program string used when trying to create the companion.




FuncCompErrorException


oracle.apps.cz.cioFuncCompErrorException

Syntaxpublic class FuncCompErrorException extends java.lang.RuntimeException




|+--oracle.apps.cz.cio.FuncCompErrorException


DescriptionFuncCompMessageException is designed to be thrown from a functional companion's autoConfigure() method code when the author of the companion wants to display an ERROR message in a dialog box to the end user. Throwing this will cause the UI Server to rollback the outermost transaction. To produce a fatal error message throw RuntimeException

Member Summary

Constructors

FuncCompErrorException(IFunctionalCompanion, String)

Constructs the exception object.



FuncCompErrorException


Constructors

FuncCompErrorException(IFunctionalCompanion, String)public FuncCompErrorException(IFunctionalCompanion fc, java.lang.Stringmessage)Constructs the exception object.

Parameters: fc - the FunctionalCompanion from which exception is thrown, not null

message - the message to be shown to the end user





FuncCompMessageException


oracle.apps.cz.cioFuncCompMessageException

Syntaxpublic class FuncCompMessageException extends java.lang.RuntimeException




|+--oracle.apps.cz.cio.FuncCompMessageException


Description

Deprecated.FuncCompMessageException is designed to be thrown from a functional companion's autoConfigure() method code when the author of the companion wants to display a BENIGN message in a dialog box to the end user. Throwing this will cause the UI Server to commit the outermost transaction. To produce a fatal error message throw RuntimeException

Member Summary

Constructors

FuncCompMessageException(IFunctionalCompanion, String)


FuncCompMessageException


Constructors

FuncCompMessageException(IFunctionalCompanion, String)public FuncCompMessageException(IFunctionalCompanion fc, java.lang.Stringmessage)


Parameters: fc - the FunctionalCompanion from which exception is thrown, not null

message - the message to be shown to the end user






FunctionalCompanion


oracle.apps.cz.cioFunctionalCompanion

Syntaxpublic class FunctionalCompanion extends java.lang.Object implementsIFunctionalCompanion

java.lang.Object|+--oracle.apps.cz.cio.FunctionalCompanion

Direct Known Subclasses: AutoFunctionalCompanion

All Implemented Interfaces: IFunctionalCompanion

DescriptionBase object on which user functional companions can be based.

Member Summary

Constructors

FunctionalCompanion()

Methods

autoConfigure() Does nothing.

generateOutput() Does nothing.

generateOutput(HttpServletResponse)

Does nothing.




getRuntimeNode() Returns the runtime node to which this functional is associated.

FunctionalCompanion


Specified By: generateOutput() in interface IFunctionalCompanion

generateOutput(HttpServletResponse)public void generateOutput(javax.servlet.http.HttpServletResponse response)Does nothing.

Specified By: generateOutput(HttpServletResponse) in interface IFunctionalCompanion

getDescription()public java.lang.String getDescription()

Returns the description of the functional companion.

Specified By: getDescription() in interface IFunctionalCompanion


Returns the database ID of the functional companion.

Specified By: getID() in interface IFunctionalCompanion


Returns the name of the functional companion.

Specified By: getName() in interface IFunctionalCompanion

getRuntimeNode()public IRuntimeNode getRuntimeNode()

Returns the runtime node to which this functional is associated.

FunctionalCompanion


Specified By: getRuntimeNode() in interface IFunctionalCompanion

initialize(IRuntimeNode, String, String, int)public void initialize(IRuntimeNode node, java.lang.String name,java.lang.String description, int id)

Saves the parameters in member variables.

Specified By: initialize(IRuntimeNode, String, String, int) in interface IFunctionalCompanion

terminate()public void terminate()

Does nothing.

Specified By: terminate() in interface IFunctionalCompanion


Overrides:java.lang.Object.toString() in class java.lang.Object

validate()public java.util.List validate()

Does nothing.

Specified By: validate() in interface IFunctionalCompanion

FunctionalCompanionException


oracle.apps.cz.cioFunctionalCompanionException

Syntaxpublic class FunctionalCompanionException

oracle.apps.cz.cio.FunctionalCompanionException

DescriptionThis exception is used to indicate that an error occured somewhere inside the functional companion.

Constructors

FunctionalCompanionException(Throwable)public FunctionalCompanionException(java.lang.Throwable ex)The message of the original exception will be the message of this exception.

FunctionalCompanionException(Throwable, String)public FunctionalCompanionException(java.lang.Throwable ex, java.lang.Stringmessage)

Parameters: message - the message of the exception

Member Summary

Constructors

FunctionalCompanionException(Throwable)

The message of the original exception will be the message of this exception.

FunctionalCompanionException(Throwable, String)

IAtp


oracle.apps.cz.cioIAtp

Syntaxpublic interface IAtp extends ICount

All Known Subinterfaces: IBomItem

All Superinterfaces: ICount

DescriptionImplemented by objects that can have ATP calculated. This interface contains methods for getting available-to-promise (ATP) information, and methods to retrieve ATP errors/warnings/messages.

Member Summary

Methods

getAtpDate() Retrieves last ATP date calculated by Configuration.calculateAtpDates for this item.

getAtpNotifications() Returns string containing any ATP messages, warnings or errors generated for this node by the latest Configuration.calculateAtpDates call.

getDatabaseID() Returns the database ID of the runtime node.

getItemKey() Returns item key for items imported from Oracle Inventory / BOM.

getUomCode() Returns unit of measure code for items imported from Oracle Inventory/ BOM.




IAtp


Methods

getAtpDate()public java.util.Date getAtpDate()

Retrieves last ATP date calculated by Configuration.calculateAtpDates for this item.

Returns: ATP date

Throws: AtpUnavailableException - thrown if ATP initialization parameters were not provided

NoAtpCalculatedException - thrown if ATP was never demanded or if the ATP procedure did not calculate an ATP date for this node

getAtpNotifications()public java.lang.String getAtpNotifications()

Returns string containing any ATP messages, warnings or errors generated for this node by the latest Configuration.calculateAtpDates call.

getDatabaseID()public int getDatabaseID()

Returns the database ID of the runtime node.


Returns item key for items imported from Oracle Inventory / BOM. Item key is constructed from BOM_EXPLOSIONS field values: "[COMPONENT_CODE]:[EXPLOSION_TYPE]:[ORGANIZATION_ID]:[TOP_ITEM_ID]" Item key may be used by PL/SQL ATP procedures to calculate ATP for nodes. Returns null if node was not imported from Oracle Inventory / BOM.


Returns unit of measure code for items imported from Oracle Inventory/ BOM. The unit of measure may be used by PL/SQL pricing procedures to calculate ATP for nodes. Returns null if node was not imported from Oracle Inventory / BOM.

IBomItem


oracle.apps.cz.cioIBomItem

Syntaxpublic interface IBomItem extends IOptionFeature, IOption, IPrice, IAtp

All Superinterfaces: IAtp, ICount, IOption, IOptionFeature, IPrice, IState

All Known Implementing Classes: BomNode

DescriptionImplemented by all selectable BOM items.

Member Summary

Methods

getComponentCode() Returns component code of item.

getDecimalMaxQuantity() Gets the maximum quantity.

getDecimalMinQuantity() Gets the minimum quantity.

getInventoryItemId() Returns Oracle Applications inventory_item_id of item.

getMaxQuantity() Gets the maximum quantity.

getMinQuantity() Gets the minimum quantity.

getOrganizationId() Returns Oracle Applications organization_id of item.

getPrimaryUomCode() Gets primary unit of measure code for item.

hasMaxQuantity() Reuturns true if the BOM item has maximum quantity

hasMinQuantity() Returns true if the BOM item has minimum quantity

isRequired() Returns true if this is a required BOM item.

IBomItem


Methods

getComponentCode()public java.lang.String getComponentCode()

Returns component code of item. Component code is used to identify the item within an exploded bill of materials.

getDecimalMaxQuantity()public double getDecimalMaxQuantity()

Gets the maximum quantity.
















IBomItem


getDecimalMinQuantity()public double getDecimalMinQuantity()Gets the minimum quantity.

getInventoryItemId()public int getInventoryItemId()Returns Oracle Applications inventory_item_id of item.

getMaxQuantity()public int getMaxQuantity()Gets the maximum quantity.

getMinQuantity()public int getMinQuantity()Gets the minimum quantity.

getOrganizationId()public int getOrganizationId()Returns Oracle Applications organization_id of item.

getPrimaryUomCode()public java.lang.String getPrimaryUomCode()Gets primary unit of measure code for item.

hasMaxQuantity()public boolean hasMaxQuantity()Reuturns true if the BOM item has maximum quantity

hasMinQuantity()public boolean hasMinQuantity()Returns true if the BOM item has minimum quantity

isRequired()public boolean isRequired()Returns true if this is a required BOM item.

ICompSetEventListener


oracle.apps.cz.cioICompSetEventListener

Syntaxpublic interface ICompSetEventListener extends java.util.EventListener

All Superinterfaces: java.util.EventListener

DescriptionImplemented by objects that want to find out about added components.

Methods

notifyComponentAdded(Component)public void notifyComponentAdded(Component component)

Called when a component is added to the component set.

notifyComponentDeleted(Component)public void notifyComponentDeleted(Component component)

Called when a component is deleted from the component set.

Member Summary

Methods

notifyComponentAdded(Component) Called when a component is added to the component set.

notifyComponentDeleted(Component)

Called when a component is deleted from the component set.

IConfigEventListener


oracle.apps.cz.cio

ICount


oracle.apps.cz.cioICount

Syntaxpublic interface ICount

All Known Subinterfaces: IAtp, IBomItem, IOption, IOptionFeature

All Known Implementing Classes: StateCountNode

DescriptionImplemented by objects that have an associated integer count.

Methods


Gets the current count of this object.

Returns: the current count of this object.

Member Summary

Methods

getCount() Gets the current count of this object.

getDecimalCount() Gets the current decimal count of this object.

setCount(int) Sets the count of this object.

setDecimalCount(double) Sets the decimal count of this object.

ICount


getDecimalCount()public double getDecimalCount()Gets the current decimal count of this object.

Returns: the current decimal count of this object.

setCount(int)public void setCount(int newCount)Sets the count of this object.

setDecimalCount(double)public void setDecimalCount(double newCount)Sets the decimal count of this object.

IDecimal


oracle.apps.cz.cioIDecimal

Syntaxpublic interface IDecimal extends IReadOnlyDecimal

All Superinterfaces: IReadOnlyDecimal

All Known Implementing Classes: DecimalNode

DescriptionImplemented by objects that can both get and set a decimal value.

Methods

setDecimalValue(double)public void setDecimalValue(double newValue)

Sets the current value of this object.

Member Summary

Methods

setDecimalValue(double) Sets the current value of this object.





IDecimal


unset()public void unset()Retracts any user selection made toward this node

IDecimalMinMax


oracle.apps.cz.cioIDecimalMinMax

Syntaxpublic interface IDecimalMinMax

All Known Implementing Classes: DecimalFeature

DescriptionImplemented by objects that have a decimal minimum and maximum value.

Methods

getMax()public double getMax()Get the maximum allowable value.

getMin()public double getMin()Get the minimum allowable value.

hasMax()public boolean hasMax()Returns true if there is a maximum limit.

Member Summary

Methods

getMax() Get the maximum allowable value.

getMin() Get the minimum allowable value.

hasMax() Returns true if there is a maximum limit.

hasMin() Returns true if there is a minimum limit.

IDecimalMinMax


hasMin()public boolean hasMin()Returns true if there is a minimum limit.

IFunctionalCompanion


oracle.apps.cz.cioIFunctionalCompanion

Syntaxpublic interface IFunctionalCompanion

All Known Implementing Classes: FunctionalCompanion

DescriptionImplemented by functional companion objects attached to components in order to provide programatic functionality to a configuration model.

Member Summary

Fields

FC_ON_AUTO_CONFIGURE

FC_ON_GENERATE_OUTPUT

FC_ON_NEW Functional Companion event types

FC_ON_RESTORE

FC_ON_SAVE

FC_ON_VALIDATE

Methods

autoConfigure() Performs a programmatic configuration step.

generateOutput() Generates output for this component.

generateOutput(HttpServletResponse)

Generates output for this component.






Fields

FC_ON_AUTO_CONFIGUREpublic static final int FC_ON_AUTO_CONFIGURE

FC_ON_GENERATE_OUTPUTpublic static final int FC_ON_GENERATE_OUTPUT

FC_ON_NEWpublic static final int FC_ON_NEW

Functional Companion event types

FC_ON_RESTOREpublic static final int FC_ON_RESTORE

FC_ON_SAVEpublic static final int FC_ON_SAVE

FC_ON_VALIDATEpublic static final int FC_ON_VALIDATE

Methods

autoConfigure()public void autoConfigure()

getRuntimeNode() Returns the runtime node to which this component is attached.

initialize(IRuntimeNode, String, String, int)

Saves information about the model and performs any actions needed to initialize the companion.

terminate() Performs any cleanup on this companion that needs to occur before the companion is destroyed.

validate() Programatically checks that a configuration is valid and returns a list of ValidationFailure objects if there are failures, and null otherwise.

Member Summary



Performs a programmatic configuration step. Any modifications to the model should be performed here.

generateOutput()public java.lang.String generateOutput()

Generates output for this component. This version is called in a thick client context where the user's machine can be addressed directly. Can modify the model, but this is not recommended practice.

generateOutput(HttpServletResponse)public void generateOutput(javax.servlet.http.HttpServletResponse response)

Generates output for this component. This version is called in a thin client context where the user's browser is addressed indirectly by writing to the HttpServletResponse object. Can modify the model, but this is not recommended practice.


Returns the description of the functional companion.


Returns the database ID of the functional companion.


Returns the name of the functional companion.


Returns the runtime node to which this component is attached.

initialize(IRuntimeNode, String, String, int)public void initialize(IRuntimeNode node, java.lang.String name,java.lang.String description, int id)

Saves information about the model and performs any actions needed to initialize the companion. Should never attempt to modify the model.



terminate()public void terminate()Performs any cleanup on this companion that needs to occur before the companion is destroyed.

validate()public java.util.List validate()Programatically checks that a configuration is valid and returns a list of ValidationFailure objects if there are failures, and null otherwise. Should never attempt to modify the model.

IInteger


oracle.apps.cz.cioIInteger

Syntaxpublic interface IInteger

All Known Implementing Classes: CountFeature, IntegerNode

DescriptionImplemented by objects that have an integer value.

Methods

getIntValue()public int getIntValue()Get the current integer value of this object.

isUnknown()public boolean isUnknown()Tells whether this feature is in unknown or known state.

Returns: true if the feature is unknown.

Member Summary

Methods

getIntValue() Get the current integer value of this object.


setIntValue(int) Set the current integer value of this object.


IInteger


setIntValue(int)public void setIntValue(int newValue)Set the current integer value of this object.


IIntegerMinMax


oracle.apps.cz.cioIIntegerMinMax

Syntaxpublic interface IIntegerMinMax

All Known Implementing Classes: CountFeature, IntegerFeature, ComponentSet

DescriptionImplemented by objects that have an integer minimum and maximum.

Methods

getMax()public int getMax()Get the maximal allowable value for this object.

getMin()public int getMin()Get the minimal allowable value for this object.

hasMax()public boolean hasMax()Returns true if there is a maximum limit.

Member Summary

Methods

getMax() Get the maximal allowable value for this object.

getMin() Get the minimal allowable value for this object.

hasMax() Returns true if there is a maximum limit.

hasMin() Returns true if there is a minimum limit.

IIntegerMinMax


hasMin()public boolean hasMin()Returns true if there is a minimum limit.

IncompatibleInputException


oracle.apps.cz.cioIncompatibleInputException

Syntaxpublic class IncompatibleInputException extends java.lang.Exception



|+--oracle.apps.cz.cio.IncompatibleInputException


DescriptionSignalled if a particular input is of different type than the node it is trying to restore over.

Member Summary

Methods

getInput() Returns the input object where the mismatch occured

getModelNode() Returns the corresponding model node where the mismatch occured






IncompatibleInputException


Methods

getInput()public oracle.apps.cz.dio.config.DbConfigInput getInput()

Returns the input object where the mismatch occured

Returns: the failed DbConfigInput object

getModelNode()public oracle.apps.cz.dio.model.DbModelNode getModelNode()

Returns the corresponding model node where the mismatch occured




oracle.apps.cz.cioIneffectiveUiNodeException

Syntaxpublic class IneffectiveUiNodeException extends NoSuchUiNodeException



|+--NoSuchUiNodeException

|+--oracle.apps.cz.cio.IneffectiveUiNodeException


Description

Member Summary

Constructors

IneffectiveUiNodeException(IUserInterfaceNode, Configuration)

Methods

getNode()


Methods inherited from interface NoSuchUiNodeException

getName()




Constructors

IneffectiveUiNodeException(IUserInterfaceNode, Configuration)public IneffectiveUiNodeException(IUserInterfaceNode node, Configurationconfig)

Methods

getNode()public IUserInterfaceNode getNode()





InitialRequestException


oracle.apps.cz.cioInitialRequestException

Syntaxpublic class InitialRequestException extends LogicalRuntimeException




|+--LogicalRuntimeException

|+--oracle.apps.cz.cio.InitialRequestException


DescriptionSignalled if a problem occurs during the setting of Initial Requests.

Member Summary

Constructors

InitialRequestException()

InitialRequestException(String)

Methods

toString()

InitialRequestException


Constructors

InitialRequestException()public InitialRequestException()

InitialRequestException(String)public InitialRequestException(java.lang.String msg)

Methods


Overrides:java.lang.Throwable.toString() in class java.lang.Throwable


Methods inherited from interface LogicalRuntimeException

getLogicException()


fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace



IntegerFeature


oracle.apps.cz.cioIntegerFeature

Syntaxpublic class IntegerFeature extends IntegerNode implements IIntegerMinMax


|+--PricedNode

|+--IntegerNode

|+--oracle.apps.cz.cio.IntegerFeature

All Implemented Interfaces: IInteger, IIntegerMinMax, IPrice, IRuntimeNode

DescriptionRepresents a feature with an integer value.

Member Summary

Methods

getMax()

getMin()

getType()

hasMax()

hasMin()

IntegerFeature


Methods












IntegerNode


oracle.apps.cz.cioIntegerNode

Syntaxpublic abstract class IntegerNode extends PricedNode implements IInteger


|+--PricedNode

|+--oracle.apps.cz.cio.IntegerNode

Direct Known Subclasses: IntegerFeature

All Implemented Interfaces: IInteger, IPrice, IRuntimeNode

DescriptionRepresents a feature with an integer value.

Member Summary

Methods

getIntValue()

isUnknown()

setIntValue(int)

unset()

IntegerNode


Methods

getIntValue()public int getIntValue()

Specified By: getIntValue() in interface IInteger







getChildByID(int), getChildByName(String), getChildByPersistentID(int), getChildren(), getChildrenByType(int), getConfiguration(), getDatabaseID(), getDescription(), getFuncCompByID(int), getFuncCompByName(String), getFunctionalCompanions(), getName(), getParent(), getPersistentID(), getProperties(), getPropertyByName(String), getRuntimeID(), getSelectionLineID(), getType(), hasChildren(), hasCount(), hasDecimalValue(), hasDescription(), hasIntegerValue(), hasSelectionLineID(), hasState(), hasTextValue(), isDefaultAffected(), isEffective(), isNative(), isRoot(), isUnsatisfied(), isUnsatisfiedNode(), lookupNodeID(Object), toString(), toString(boolean), typeToString(int)







IntegerNode


isUnknown()public boolean isUnknown()

Specified By: isUnknown() in interface IInteger

setIntValue(int)public void setIntValue(int newIntValue)

Specified By: setIntValue(int) in interface IInteger


Specified By: unset() in interface IInteger

IOption


oracle.apps.cz.cioIOption

Syntaxpublic interface IOption extends IState, ICount


All Superinterfaces: ICount, IState

All Known Implementing Classes: OptionNode

DescriptionImplemented by objects that act as options. The defining characteristic of an option is that it can be selected and deselected.

Member Summary

Methods

deselect() Deslect this option.

isOptionMutexed() Returns true if this option is a child of a mutexed parent

isSelected() Returns true if this option is selected, and false otherwise.

select() Select this option.




IOption


Methods


Deslect this option.


Returns true if this option is a child of a mutexed parent


Returns true if this option is selected, and false otherwise.


Select this option.






IOptionFeature


oracle.apps.cz.cioIOptionFeature

Syntaxpublic interface IOptionFeature extends IState, ICount


All Superinterfaces: ICount, IState

All Known Implementing Classes: OptionFeatureNode

DescriptionImplemented by objects that contain selectable options. This interface provides a mechansim for selecting and deselecting options, and for determining which options are currently selected.

Member Summary

Methods

areOptionsCounted() Returns true if the Feature has counted options.

deselect(IOption) Deselect a particular option.

getMaxSelected() Returns the maximum number of selected options.

getMinSelected() Returns the minimum number of selected options.

getSelectableChildren() Returns a List of all selectable children.

getSelectedOption() Returns the currently selected option, or null if no option is selected.

getSelectedOptions() Returns a, possibly empty, collection of options that are currently selected.

hasMaxSelected() Returns true if the Feature specifies a maximum number of selected options.

hasMinSelected() Returns true if the Feature specifies a minimum number of selected options.

IOptionFeature


Methods


Returns true if the Feature has counted options. You set counted options for a Feature in Developer, by checking the Counted Options check box.

deselect(IOption)public void deselect(IOption option)

Deselect a particular option.

Parameters: option - the option to be de selected.

getMaxSelected()public int getMaxSelected()

Returns the maximum number of selected options.

isSelectionMutexed() Returns true if this feature supports mutexed selections.

select(IOption) Select a particular option.








Member Summary

IOptionFeature


getMinSelected()public int getMinSelected()Returns the minimum number of selected options.

getSelectableChildren()public java.util.List getSelectableChildren()Returns a List of all selectable children. Selectable children are all immediate children of type option as well as the indirect children of all instantiable options.

getSelectedOption()public IOption getSelectedOption()Returns the currently selected option, or null if no option is selected.

Returns: the currently selected option.

Throws: SelectionNotMutexedException - if this feature does not support mutexed selections.

getSelectedOptions()public java.util.List getSelectedOptions()

Returns a, possibly empty, collection of options that are currently selected.

hasMaxSelected()public boolean hasMaxSelected()

Returns true if the Feature specifies a maximum number of selected options.

hasMinSelected()public boolean hasMinSelected()

Returns true if the Feature specifies a minimum number of selected options.


Returns true if this feature supports mutexed selections. When a selection is mutexed, it means that only one of a particular option is selectable at any one time,

IOptionFeature


and selecting one option automatically deselects any other option that is mutexed and currently selected.


Select a particular option.

Parameters: option - the option to be selected.

IPrice


oracle.apps.cz.cioIPrice

Syntaxpublic interface IPrice


All Known Implementing Classes: PricedNode, StateCountNode

DescriptionImplemented by objects that can be priced. This interface contains methods for getting list, discount, and extended prices, and methods to retrieve pricing errors/warnings/messages.

Member Summary

Methods


getDiscountedPrice() Gets discounted price of item based on adjustments associated with price list specified in initParameters.

getDiscountedPricingNotifications() Returns strings containing any pricing messages, warnings, or errors when asking selling price/discounted price

getExtendedPrice() Calculates extended price of item (quantity * discounted price).

getItemKey() Returns item key for items imported from Oracle Inventory / BOM.

getListPrice() Gets list price of item on price list specified in initParameters.

getListPricingNotifications() Returns string containing any pricing messages, warnings, or errors when asking list price

getPricingNotifications() Returns string containing any pricing messages, warnings, or errors.

getUomCode() Returns unit of measure code for items imported from Oracle Inventory/ BOM.

IPrice


Methods




Gets discounted price of item based on adjustments associated with price list specified in initParameters.

getDiscountedPricingNotifications()public java.lang.String getDiscountedPricingNotifications()

Returns strings containing any pricing messages, warnings, or errors when asking selling price/discounted price

getExtendedPrice()public double getExtendedPrice()

Calculates extended price of item (quantity * discounted price).

getItemKey()public java.lang.String getItemKey()Returns item key for items imported from Oracle Inventory / BOM. Item key is constructed from BOM_EXPLOSIONS field values: "[COMPONENT_CODE]:[EXPLOSION_TYPE]:[ORGANIZATION_ID]:[TOP_ITEM_ID]" Item key may be used by PL/SQL pricing procedures to price nodes. Returns null if node was not imported from Oracle Inventory / BOM.

getListPrice()public double getListPrice()Gets list price of item on price list specified in initParameters.

getListPricingNotifications()public java.lang.String getListPricingNotifications()Returns string containing any pricing messages, warnings, or errors when asking list price

IPrice


getPricingNotifications()public java.lang.String getPricingNotifications()Returns string containing any pricing messages, warnings, or errors.

getUomCode()public java.lang.String getUomCode()Returns unit of measure code for items imported from Oracle Inventory/ BOM. The unit of measure may be used by PL/SQL pricing procedures to price nodes. Returns null if node was not imported from Oracle Inventory / BOM.

IReadOnlyDecimal


oracle.apps.cz.cioIReadOnlyDecimal

Syntaxpublic interface IReadOnlyDecimal

All Known Subinterfaces: IDecimal

All Known Implementing Classes: ReadOnlyDecimalNode

DescriptionImplemented by objects that have a decimal value.

Methods

getDecimalValue()public double getDecimalValue()Gets the current value of this object.

Returns: the current value.


Tells whether this feature is in unknown or known state.

Member Summary

Methods

getDecimalValue() Gets the current value of this object.


IReadOnlyDecimal



IRuntimeNode


oracle.apps.cz.cioIRuntimeNode

Syntaxpublic interface IRuntimeNode

All Known Subinterfaces: Component, ComponentNode

All Known Implementing Classes: RuntimeNode

DescriptionImplemented by all objects in the runtime configuration tree. This interface implements behavior common to all nodes in the runtime configuration tree, including components, features, options, totals, etc.

Member Summary

Fields

ALL_FEATURES A pseudo-type that represents all feature types for use in getChildrenByType.

BOM_MODEL BOM model type.

BOM_OPTION_CLASS BOM option class type.

BOM_STD_ITEM BOM standard item type.

BOOLEAN_FEATURE Boolean feature type.

COMPONENT Component type.

COMPONENT_SET Component set type.

COUNT_FEATURE Count feature type.

DECIMAL_FEATURE Decimal feature type.

INTEGER_FEATURE Integer feature type.

OPTION Option type.

IRuntimeNode


OPTION_FEATURE Option feature type.

RESOURCE Resource type.

TEXT_FEATURE Text feature type.

TOTAL Total type.

Methods

getChildByID(int) Gets a particular child identified by its ID.

getChildByName(String) Gets a particular child identified by its name.

getChildByPersistentID(int) Gets a particular child identified by its persistent ID.

getChildren() Gets the children of this runtime configuration node.

getChildrenByType(int) Gets all of the children of a particular type.

getConfiguration() Gets the configuration to which this node belongs.

getDatabaseID() Gets the database ID of the node.


getName() Gets the name of the node.

getParent() Get the parent of this node.

getPersistentID() Gets the persistent ID of the node.

getProperties() Returns a collection of the properties associated with this node.

getPropertyByName(String) Returns a particular property of this node, based on its name.

getRuntimeID() Gets the runtime ID of the node.

getSelectionLineID() Returns selection line ID (configuration output database ID) for node.

getType() Gets the type of this node.

hasChildren() Verifies if this runtime configuration node has children.




hasSelectionLineID() Returns true if node has a selection line ID (configuration output ID), false if not.

Member Summary

IRuntimeNode


Fields

ALL_FEATURESpublic static final int ALL_FEATURES

A pseudo-type that represents all feature types for use in getChildrenByType.

BOM_MODELpublic static final int BOM_MODEL

BOM model type.

BOM_OPTION_CLASSpublic static final int BOM_OPTION_CLASS

BOM option class type.

BOM_STD_ITEMpublic static final int BOM_STD_ITEM

BOM standard item type.

BOOLEAN_FEATUREpublic static final int BOOLEAN_FEATURE

Boolean feature type.


hasTextValue() Returns true if the node has a text value.

isEffective() Returns true if this particular node is effective given the effectivity criteria of the model.

isNative() Returns true if this is a native BOM node

isRoot() Returns true if this is the root node of the runtime tree.

isUnsatisfied() Returns true if this particular node, or any one of its children, has not been completely configured.

isUnsatisfiedNode() Returns true if this particular node has not been completely configured.

toString(boolean) Returns a String representation of this node, based on whether the client demands a description (if there is one) or just a name

Member Summary

IRuntimeNode


COMPONENTpublic static final int COMPONENTComponent type.

COMPONENT_SETpublic static final int COMPONENT_SETComponent set type.

COUNT_FEATUREpublic static final int COUNT_FEATURECount feature type.

DECIMAL_FEATUREpublic static final int DECIMAL_FEATUREDecimal feature type.

INTEGER_FEATUREpublic static final int INTEGER_FEATUREInteger feature type.

OPTIONpublic static final int OPTIONOption type.

OPTION_FEATUREpublic static final int OPTION_FEATUREOption feature type.

RESOURCEpublic static final int RESOURCEResource type.

TEXT_FEATUREpublic static final int TEXT_FEATUREText feature type.

IRuntimeNode


TOTALpublic static final int TOTALTotal type.

Methods

getChildByID(int)public IRuntimeNode getChildByID(int id)

Gets a particular child identified by its ID.

Returns: a child of this node.

getChildByName(String)public IRuntimeNode getChildByName(java.lang.String name)

Gets a particular child identified by its name.


getChildByPersistentID(int)public IRuntimeNode getChildByPersistentID(int id)

Gets a particular child identified by its persistent ID.


getChildren()public java.util.List getChildren()

Gets the children of this runtime configuration node.

Returns: a list of children. Empty list if no children.

getChildrenByType(int)public java.util.List getChildrenByType(int type)

IRuntimeNode


Gets all of the children of a particular type.

Returns: a collection of children.

getConfiguration()public Configuration getConfiguration()

Gets the configuration to which this node belongs.

Returns: the configuration to which this node belongs.


getDatabaseID()public int getDatabaseID()Gets the database ID of the node.

Returns: the database ID of the node.


Returns the design-time description of the runtime node.


Gets the name of the node.

Returns: the name of the node.

getParent()public IRuntimeNode getParent()

Get the parent of this node.

IRuntimeNode


Returns: the node's parent.

getPersistentID()public int getPersistentID()Gets the persistent ID of the node.

Returns: the database ID of the node.

getProperties()public java.util.Collection getProperties()

Returns a collection of the properties associated with this node. The collection contains items of the type Property.

getPropertyByName(String)public Property getPropertyByName(java.lang.String name)

Returns a particular property of this node, based on its name. Returns null if a property of the given name does not exist.

getRuntimeID()public int getRuntimeID()Gets the runtime ID of the node. This ID is unique across all other nodes created by a particular CIO.

Returns: runtime ID of the node.

getSelectionLineID()public int getSelectionLineID()

Returns selection line ID (configuration output database ID) for node. The hasSelectionLineID() method should always be called before this method. A RuntimeException will be thrown if ID doesn't exist.

Returns: line ID

IRuntimeNode


getType()public int getType()Gets the type of this node.

Returns: the type of this node.

hasChildren()public boolean hasChildren()Verifies if this runtime configuration node has children.

Returns: true if the node has children.

hasCount()public boolean hasCount()

Returns true if the node has an object count.

hasDecimalValue()public boolean hasDecimalValue()

Returns true if the node has a decimal value.

hasDescription()public boolean hasDescription()

Returns true if there is a design-time description of the runtime node.

hasSelectionLineID()public boolean hasSelectionLineID()

Returns true if node has a selection line ID (configuration output ID), false if not.

hasState()public boolean hasState()

Returns true if the node has a logical state.

hasTextValue()public boolean hasTextValue()

IRuntimeNode


Returns true if the node has a text value.

isEffective()public boolean isEffective()

Returns true if this particular node is effective given the effectivity criteria of the model.

Returns: a boolean indicating whether the node is effective.

isNative()public boolean isNative()

Returns true if this is a native BOM node

isRoot()public boolean isRoot()

Returns true if this is the root node of the runtime tree.


Returns true if this particular node, or any one of its children, has not been completely configured. The value is cached and is only updated on transaction commit or rollback.

Returns: a boolean indicating whether the node is unsatisfied.

isUnsatisfiedNode()public boolean isUnsatisfiedNode()Returns true if this particular node has not been completely configured. The value is cached and is only updated on transaction commit or rollback.

Returns: a boolean indicating whether the node is unsatisfied.

toString(boolean)public java.lang.String toString(boolean description)

IRuntimeNode


Returns a String representation of this node, based on whether the client demands a description (if there is one) or just a name

IState


oracle.apps.cz.cioIState

Syntaxpublic interface IState

All Known Subinterfaces: IBomItem, IOption, IOptionFeature

All Known Implementing Classes: StateNode

DescriptionImplemented by objects that have logic state. This interface contains a set of input states, used to specify a new state for an object, a set of output states, returned when querying an object for its state, and a set of methods for getting and setting the object's state.

Member Summary

Fields

FALSE The input state used to set an object to false.

LFALSE The logically false output state, indicating that the state is false as a consequence of a rule.

LTRUE The logically true output state, indicating that the state is true as a consequence of a rule.

TOGGLE The input state used to turn an object state to true if it is false or unknown, and to make it unknown or false if it is true.

TRUE The input state used to set an object to true.

UFALSE The user false output state, indicating that a user has set this object to false.

UNKNOWN The unknown output state.

UTRUE The user true output state, indicating that a user has set this object to true.

Methods

IState


Fields

FALSEpublic static final int FALSE

The input state used to set an object to false.

LFALSEpublic static final int LFALSE

The logically false output state, indicating that the state is false as a consequence of a rule.

LTRUEpublic static final int LTRUE

The logically true output state, indicating that the state is true as a consequence of a rule.

TOGGLEpublic static final int TOGGLE

The input state used to turn an object state to true if it is false or unknown, and to make it unknown or false if it is true.

TRUEpublic static final int TRUE

getState() Gets the current logic state of this object.

isFalse() Tells whether this feature is in false state.

isLogic() Tells whether this feature is in a logically specified state.

isTrue() Tells whether this feature is in true state.


isUser() Tells whether this feature is in a user specified state.

setState(int) Change the current logic state of this object.


Member Summary

IState


The input state used to set an object to true.

UFALSEpublic static final int UFALSE

The user false output state, indicating that a user has set this object to false.

UNKNOWNpublic static final int UNKNOWN

The unknown output state.

UTRUEpublic static final int UTRUE

The user true output state, indicating that a user has set this object to true.

Methods

getState()public int getState()Gets the current logic state of this object.

Returns: the current state.

isFalse()public boolean isFalse()Tells whether this feature is in false state.

Returns: true if the feature is false.

isLogic()public boolean isLogic()Tells whether this feature is in a logically specified state.

Returns: true if the feature is in logic state.

IState


isTrue()public boolean isTrue()Tells whether this feature is in true state.

Returns: true if the feature is true.

isUnknown()public boolean isUnknown()Tells whether this feature is in unknown or known state.


isUser()public boolean isUser()

Tells whether this feature is in a user specified state.

Returns: true if the feature is in user state.

setState(int)public void setState(int state)

Change the current logic state of this object.


Retracts any user selection made toward this node

IText


oracle.apps.cz.cioIText

Syntaxpublic interface IText

All Known Implementing Classes: TextNode

DescriptionImplemented by objects that have a textual value.

Methods

getTextValue()public java.lang.String getTextValue()Gets the current textual value of this object.

Returns: the current value.

setTextValue(String)public void setTextValue(java.lang.String value)Sets the current textual value of this object.

Member Summary

Methods

getTextValue() Gets the current textual value of this object.

setTextValue(String) Sets the current textual value of this object.


IText



IUserInterface


oracle.apps.cz.cioIUserInterface

Syntaxpublic interface IUserInterface

DescriptionImplemented by applications that want to provide access to the user interface in functional companions. Oracle Configurator Runtime Behavior:

Member Summary

Fields

APPLET_CLIENT An APPLET client

DHTML_CLIENT A DHTML client

Methods

addMessageBox(int, String, String)

addUserInterfaceEventListener(IUserInterfaceEventListener)

addUserInterfaceEventListener(String, IUserInterfaceEventListener)

deleteUserInterfaceEventListener(IUserInterfaceEventListener)

deleteUserInterfaceEventListener(String, IUserInterfaceEventListener)

frameHasOutputRequest(String)

getCurrentScreen() Returns the current screen that is or will be displayed in front of the user Oracle Configurator Runtime Behavior: This function may return null if called during initialization or shutdown

getNode(IRuntimeNode) Given a IRuntimeNode and a screen retrive all associated IUserInterfaceNodes

getNode(IRuntimeNode, IUserInterfaceScreen)

Given a IRuntimeNode retrive all associated IUserInterfaceNodes

IUserInterface


Fields

APPLET_CLIENTpublic static final int APPLET_CLIENT

An APPLET client

DHTML_CLIENTpublic static final int DHTML_CLIENT

A DHTML client

Methods

addMessageBox(int, String, String)public void addMessageBox(int type, java.lang.String message, java.lang.Stringtitle)

addUserInterfaceEventListener(IUserInterfaceEventListener)public void addUserInterfaceEventListener(IUserInterfaceEventListener listener)

addUserInterfaceEventListener(String, IUserInterfaceEventListener)public void addUserInterfaceEventListener(java.lang.String eventId,IUserInterfaceEventListener listener)

getNode(String, IUserInterfaceScreen)

Given a String id and a screen reference retrive all associated IUserInterfaceNodes

getOriginalScreen() Returns the screen that was displayed to the user at the start of the event.

getType() Returns the client type of the user interface

getUiSessionID() Returns the ID of the user interface session

hasMessageBoxRequest()

navigateToScreen(String)

outputToFrame(String, String)

Member Summary

IUserInterface


deleteUserInterfaceEventListener(IUserInterfaceEventListener)public void deleteUserInterfaceEventListener(IUserInterfaceEventListenerlistener)

deleteUserInterfaceEventListener(String, IUserInterfaceEventListener)public void deleteUserInterfaceEventListener(java.lang.String eventId,IUserInterfaceEventListener listener)

frameHasOutputRequest(String)public boolean frameHasOutputRequest(java.lang.String fullFramePath)

getCurrentScreen()public IUserInterfaceScreen getCurrentScreen()

Returns the current screen that is or will be displayed in front of the user Oracle Configurator Runtime Behavior: This function may return null if called during initialization or shutdown

getNode(IRuntimeNode)public java.util.List getNode(IRuntimeNode rtNode)

Given a IRuntimeNode and a screen retrive all associated IUserInterfaceNodes

Parameters: rtNode - - An IRuntimeNode

Returns: A List of IUserInterfaceNode(s)

Throws: NoSuchUiDefException - if there is no associated IUserInterfaceNode

getNode(IRuntimeNode, IUserInterfaceScreen)public java.util.List getNode(IRuntimeNode rtNode, IUserInterfaceScreen screen)

Given a IRuntimeNode retrive all associated IUserInterfaceNodes

Parameters: rtNode - - An IRuntimeNode

IUserInterface


screen - - An IUserInterfaceScreen


Throws: NoSuchUiDefException - if there is no associated IUserInterfaceNode

getNode(String, IUserInterfaceScreen)public java.util.List getNode(java.lang.String id, IUserInterfaceScreen screen)Given a String id and a screen reference retrive all associated IUserInterfaceNodes

Parameters: id - - The id of the user interface object

screen - - The screen where this node can be found


Throws: NoSuchUiNodeException - if the id does not represnet a node

getOriginalScreen()public IUserInterfaceScreen getOriginalScreen()

Returns the screen that was displayed to the user at the start of the event. Oracle Configurator Runtime Behavior: This function may return null if called during initialization or shutdown. The values of getOriginalScreen and getCurrentScreen will be the same when there have been no requests to change the screen, either by UIServer, or another FC


Returns the client type of the user interface

getUiSessionID()public java.lang.String getUiSessionID()

IUserInterface


Returns the ID of the user interface session

hasMessageBoxRequest()public boolean hasMessageBoxRequest()

navigateToScreen(String)public void navigateToScreen(java.lang.String screenName)

outputToFrame(String, String)public void outputToFrame(java.lang.String fullFramePath, java.lang.String text)

IUserInterfaceControl


oracle.apps.cz.cioIUserInterfaceControl

Syntaxpublic interface IUserInterfaceControl extends IUserInterfaceNode

All Known Subinterfaces: IUserInterfaceImage, IUserInterfaceLabel

All Superinterfaces: IUserInterfaceNode

DescriptionImplemented by user interface objects that represent controls that are displayed to the end user Oracle Configurator Runtime Behavior:

Member Summary

Methods

getScreen() Returns The IUserInterfaceScreen that this control is displayed in.


Fields inherited from interface IUserInterfaceNode

BOM_CONTROL, BUTTON, CHECK_BOX, COMBO_BOX, DECIMAL_FIELD, IMAGE, INTEGER_FIELD, LABEL, LOGIC_COUNT_BOX, OPTION, RESOURCE_FIELD, SCREEN, SELECTION_LIST, SELECTION_LIST_MUTEX, TEXT_FIELD, TOTAL_FIELD, TREELINK, UINODE

Methods inherited from interface IUserInterfaceNode

getName(), getRuntimeNode(), getType(), getUiCaption()

IUserInterfaceControl


Methods

getScreen()public IUserInterfaceScreen getScreen()

Returns The IUserInterfaceScreen that this control is displayed in.

IUserInterfaceEvent


oracle.apps.cz.cioIUserInterfaceEvent

Syntaxpublic interface IUserInterfaceEvent

Description

Member Summary

Fields

POST_CLICK

POST_EVENT_EXECUTION

POST_MODEL_EVENT_EXECUTION

POST_NAVIGATION_EVENT_EXECUTION

POST_NEW_CONFIGURATION

POST_RESTORE_CONFIGURATION

POST_SAVE_CONFIGURATION

POST_VALUE_CHANGE

PRE_CANCEL_CONFIGURATION

PRE_SAVE_CONFIGURATION

Methods

getName()

getUiNode() Returns the user interface node that the event is associated with.

getUserInterface() Returns the IUSerInterface that the event was generated from

IUserInterfaceEvent


Fields

POST_CLICKpublic static final java.lang.String POST_CLICK

POST_EVENT_EXECUTIONpublic static final java.lang.String POST_EVENT_EXECUTION

POST_MODEL_EVENT_EXECUTIONpublic static final java.lang.String POST_MODEL_EVENT_EXECUTION

POST_NAVIGATION_EVENT_EXECUTIONpublic static final java.lang.String POST_NAVIGATION_EVENT_EXECUTION

POST_NEW_CONFIGURATIONpublic static final java.lang.String POST_NEW_CONFIGURATION

POST_RESTORE_CONFIGURATIONpublic static final java.lang.String POST_RESTORE_CONFIGURATION

POST_SAVE_CONFIGURATIONpublic static final java.lang.String POST_SAVE_CONFIGURATION

POST_VALUE_CHANGEpublic static final java.lang.String POST_VALUE_CHANGE

PRE_CANCEL_CONFIGURATIONpublic static final java.lang.String PRE_CANCEL_CONFIGURATION

PRE_SAVE_CONFIGURATIONpublic static final java.lang.String PRE_SAVE_CONFIGURATION

IUserInterfaceEvent


Methods


getUiNode()public IUserInterfaceNode getUiNode()

Returns the user interface node that the event is associated with. This will be null if the event is one of POST_NEW_CONFIGURATION, POST_RESTORE_CONFIGURATION, PRE_SAVE_CONFIGURATION, POST_SAVE_CONFIGURATION, PRE_CANCEL_CONFIGURATION, POST_CANCEL_CONFIGURATION

getUserInterface()public IUserInterface getUserInterface()

Returns the IUSerInterface that the event was generated from

IUserInterfaceEventListener


oracle.apps.cz.cioIUserInterfaceEventListener

Syntaxpublic interface IUserInterfaceEventListener

Description

Methods

handleUserInterfaceEvent(IUserInterfaceEvent)public void handleUserInterfaceEvent(IUserInterfaceEvent event)

Member Summary

Methods

handleUserInterfaceEvent(IUserInterfaceEvent)

IUserInterfaceImage


oracle.apps.cz.cioIUserInterfaceImage

Syntaxpublic interface IUserInterfaceImage extends IUserInterfaceControl

All Superinterfaces: IUserInterfaceControl, IUserInterfaceNode

DescriptionImplemented by user interface objects that provide capabilities needed by functional companions to interact with images. Oracle Configurator Runtime Behavior:

Member Summary

Methods

getFileName() Returns the name of the image currently being displayed by the image.

setFileName(String) Sets the name of the image to be displayed.




Methods inherited from interface IUserInterfaceControl

getScreen()



IUserInterfaceImage


Methods

getFileName()public java.lang.String getFileName()

Returns the name of the image currently being displayed by the image. Oracle Configurator Runtime Behavior:

setFileName(String)public void setFileName(java.lang.String imageName)

Sets the name of the image to be displayed. The image name can be null. Oracle Configurator Runtime Behavior: The veracity of the image is not checked by the runtime (server). The image will be loaded by the client any problems of locating the image will be handled by the client. If null is passed as the argument the runtime will have the client take down the image. However, the image control will still be displayed with nothing in it.

IUserInterfaceLabel


oracle.apps.cz.cioIUserInterfaceLabel

Syntaxpublic interface IUserInterfaceLabel extends IUserInterfaceControl

All Superinterfaces: IUserInterfaceControl, IUserInterfaceNode

DescriptionImplemented by user interface objects that provide capabilities needed by functional companions to interact with labels. Oracle Configurator Runtime Behavior:

Member Summary

Methods

setUiCaption(String) Sets the caption to be displayed by the label.




Methods inherited from interface IUserInterfaceControl

getScreen()



IUserInterfaceLabel


Methods

setUiCaption(String)public void setUiCaption(java.lang.String caption)

Sets the caption to be displayed by the label. The image name can be null. Oracle Configurator Runtime Behavior: If null is passed as the argument the runtime will send "" to the client. The label control will still be displayed.

IUserInterfaceNode


oracle.apps.cz.cioIUserInterfaceNode

Syntaxpublic interface IUserInterfaceNode

All Known Subinterfaces: IUserInterfaceControl, IUserInterfaceImage, IUserInterfaceLabel, IUserInterfaceScreen

DescriptionImplemented by user interface object that allow interaction with functional companions. Oracle Configurator Runtime Behavior: Oracle Configurator provides a set of constant types for use by functional companion writers. Other implementations may provide their own types.

Member Summary

Fields

BOM_CONTROL A DHTML Bill-of-material control

BUTTON A DHTML button control

CHECK_BOX A DHTML logic check box control

COMBO_BOX A DHTML logic combo box control

DECIMAL_FIELD A DHTML decimal input field control

IMAGE A DHTML image control

INTEGER_FIELD A DHTML integer input field control

LABEL A DHTML label control

LOGIC_COUNT_BOX A DHTML logic section list control, with count

OPTION An option

RESOURCE_FIELD A DHTML resource field

SCREEN A DHTML screen node

IUserInterfaceNode


Fields

BOM_CONTROLpublic static final int BOM_CONTROL

A DHTML Bill-of-material control

BUTTONpublic static final int BUTTON

A DHTML button control

CHECK_BOXpublic static final int CHECK_BOX

A DHTML logic check box control

COMBO_BOXpublic static final int COMBO_BOX

A DHTML logic combo box control

SELECTION_LIST A DHTML logic selection list control

SELECTION_LIST_MUTEX A DHTML mutexed, logic selection list control

TEXT_FIELD A DHTML text input field control

TOTAL_FIELD A DHTML total field

TREELINK A DHTML screen link node

UINODE A UINODE of unspecified type

Methods

getName() Returns the internal name of the user interface node, which can be null.

getRuntimeNode() Returns the associated runtime model node, if any.

getType() Gets the type of the node

getUiCaption() Returns the visible caption of the user interface node, if it has one.

Member Summary

IUserInterfaceNode


DECIMAL_FIELDpublic static final int DECIMAL_FIELDA DHTML decimal input field control

IMAGEpublic static final int IMAGEA DHTML image control

INTEGER_FIELDpublic static final int INTEGER_FIELDA DHTML integer input field control

LABELpublic static final int LABELA DHTML label control

LOGIC_COUNT_BOXpublic static final int LOGIC_COUNT_BOXA DHTML logic section list control, with count

OPTIONpublic static final int OPTIONAn option

RESOURCE_FIELDpublic static final int RESOURCE_FIELDA DHTML resource field

SCREENpublic static final int SCREENA DHTML screen node

SELECTION_LISTpublic static final int SELECTION_LISTA DHTML logic selection list control

IUserInterfaceNode


SELECTION_LIST_MUTEXpublic static final int SELECTION_LIST_MUTEXA DHTML mutexed, logic selection list control

TEXT_FIELDpublic static final int TEXT_FIELDA DHTML text input field control

TOTAL_FIELDpublic static final int TOTAL_FIELDA DHTML total field

TREELINKpublic static final int TREELINKA DHTML screen link node

UINODEpublic static final int UINODEA UINODE of unspecified type

Methods

getName()public java.lang.String getName()Returns the internal name of the user interface node, which can be null.

getRuntimeNode()public IRuntimeNode getRuntimeNode()Returns the associated runtime model node, if any.

getType()public int getType()Gets the type of the node

Returns: The int type.

IUserInterfaceNode


getUiCaption()public java.lang.String getUiCaption()Returns the visible caption of the user interface node, if it has one. Returns null if there is no caption.

IUserInterfaceScreen


oracle.apps.cz.cioIUserInterfaceScreen

Syntaxpublic interface IUserInterfaceScreen extends IUserInterfaceNode

All Superinterfaces: IUserInterfaceNode

DescriptionImplemented by user interface objects that provide capabilities needed by functional companions to interact with screens. Oracle Configurator Runtime Behavior:

Member Summary

Methods

getControls()

getNode(IRuntimeNode)

getNode(String)

navigate() Request the IUserInterface to display the screen to the user as part of the response the user's request.

renderNavigateEvent() Provides the text of the UI event to navigate to this screen.

renderNavigateScript(String) Provides the script to navigate to this screen.







Methods

getControls()public java.util.List getControls()

getNode(IRuntimeNode)public java.util.List getNode(IRuntimeNode rtNode)

getNode(String)public java.util.List getNode(java.lang.String id)

navigate()public void navigate()

Request the IUserInterface to display the screen to the user as part of the response the user's request. Oracle Configurator Runtime Behavior: This request will overwrite any previous request to navigate. If the ComponentTree style is being displayed then its tree will be kept in synch. However, any navigation buttons in any other frame will not be synchronized by the user interface. This need, if desired, is the responsibility of the fc writer.

renderNavigateEvent()public java.lang.String renderNavigateEvent()

Provides the text of the UI event to navigate to this screen. This can be used to construct responses for outputToFrame that can not be covered by renderNavigateScript. Oracle Configurator Runtime Behavior: Returns the text that is required by the Oracle Configurator Runtime to execute a screen change.

renderNavigateScript(String)public java.lang.String renderNavigateScript(java.lang.String fullFramePath)

Provides the script to navigate to this screen. This will be used in conjunction with html/JS streamed to frame by the outputToFrame method.





Parameters: fullFramePath - - the path to and including czSrc.js Oracle Configurator Runtime Behavior: Returns the href tag syntax that is required by the Oracle Configurator Runtime to execute a screen change.

LogicalException


oracle.apps.cz.cioLogicalException

Syntaxpublic class LogicalException extends java.lang.Exception



|+--oracle.apps.cz.cio.LogicalException

Direct Known Subclasses: LogicalOverridableException, NodeNotEffectiveException


DescriptionSignalled if a logical failure occurs. This failure could either be a contradiction, or a more serious problem.

Member Summary

Constructors

LogicalException()

LogicalException(LogicException, Configuration)

LogicalException(LogicException, Configuration, Component)

This constructor takes the parentComp as an additional argument which is the parent component in which the 'node' lives.

LogicalException(Reason, Configuration)

LogicalException


Constructors

LogicalException()public LogicalException()

LogicalException(LogicException, Configuration)public LogicalException(oracle.apps.cz.logic.LogicException le, Configurationconfig)

LogicalException(LogicException, Configuration, Component)public LogicalException(oracle.apps.cz.logic.LogicException le, Configurationconfig, Component parentComp)This constructor takes the parentComp as an additional argument which is the parent component in which the 'node' lives. If this argument is null, 'node' will be

LogicalException(String, Configuration)

Methods

getCause()

getMessage()

getMessageHeader()

getMessageHeader(String)

getReasons()

isOverridable()



fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, toString



Member Summary

LogicalException


looked up in the net by the config, else it will be looked up in the parentComp. This is useful when a contradiction occurs during load time i.e., at a time when the net and parent component have not been hooked together in the config.

LogicalException(Reason, Configuration)public LogicalException(Reason r, Configuration config)

LogicalException(String, Configuration)public LogicalException(java.lang.String msg, Configuration config)

Methods

getCause()public IRuntimeNode getCause()

getMessage()public java.lang.String getMessage()

Overrides:java.lang.Throwable.getMessage() in class java.lang.Throwable

getMessageHeader()public java.lang.String getMessageHeader()

getMessageHeader(String)public java.lang.String getMessageHeader(java.lang.String caption)

getReasons()public java.util.List getReasons()

isOverridable()public boolean isOverridable()

LogicalOverridableException


oracle.apps.cz.cioLogicalOverridableException

Syntaxpublic class LogicalOverridableException extends LogicalException



|+--LogicalException

|+--oracle.apps.cz.cio.LogicalOverridableException


DescriptionSignalled if a logical contradiction occurs that can be overriden.

Member Summary

Constructors

LogicalOverridableException(LogicContradictionException, Configuration)

Methods

equals(Object)

isOverridable()

override()

LogicalOverridableException


Constructors

LogicalOverridableException(LogicContradictionException, Configuration)publicLogicalOverridableException(oracle.apps.cz.logic.LogicContradictionExceptionlce, Configuration config)

Methods

equals(Object)public boolean equals(java.lang.Object lce)

Overrides:java.lang.Object.equals(java.lang.Object) in class java.lang.Object

isOverridable()public boolean isOverridable()

Overrides:isOverridable() in class LogicalException

override()public java.util.List override()


Methods inherited from interface LogicalException

getCause(), getMessage(), getMessageHeader(), getMessageHeader(String), getReasons()




getClass, hashCode, notify, notifyAll, wait, wait, wait

LogicalRuntimeException


oracle.apps.cz.cioLogicalRuntimeException

Syntaxpublic class LogicalRuntimeException extends java.lang.RuntimeException




|+--oracle.apps.cz.cio.LogicalRuntimeException

Direct Known Subclasses: InitialRequestException


DescriptionSignalled if a fatal logic exception occured.

Member Summary

Constructors

LogicalRuntimeException(LogicException)

LogicalRuntimeException(String)

Methods

getLogicException()

LogicalRuntimeException


Constructors

LogicalRuntimeException(LogicException)public LogicalRuntimeException(oracle.apps.cz.logic.LogicException le)

LogicalRuntimeException(String)public LogicalRuntimeException(java.lang.String msg)

Methods

getLogicException()public oracle.apps.cz.logic.LogicException getLogicException()






MissingFileException


oracle.apps.cz.cioMissingFileException

Syntaxpublic class MissingFileException extends java.lang.RuntimeException




|+--oracle.apps.cz.cio.MissingFileException


DescriptionSignalled if a particular logic file is missing.






MissingLogicException


oracle.apps.cz.cioMissingLogicException

Syntaxpublic class MissingLogicException extends java.lang.RuntimeException




|+--oracle.apps.cz.cio.MissingLogicException


DescriptionSignalled if a particular logic record is missing.






ModelLookupException


oracle.apps.cz.cioModelLookupException

Syntaxpublic class ModelLookupException extends java.lang.Exception



|+--oracle.apps.cz.cio.ModelLookupException


DescriptionSignals that that there is a problem with the ModelLookup date.

Member Summary

Constructors

ModelLookupException(String)






ModelLookupException


Constructors

ModelLookupException(String)public ModelLookupException(java.lang.String message)

ModifiedConfigOverwriteException


oracle.apps.cz.cioModifiedConfigOverwriteException

Syntaxpublic class ModifiedConfigOverwriteException

oracle.apps.cz.cio.ModifiedConfigOverwriteException

DescriptionThis exception is thrown if a user tries to overwrite a configuration revision that has been modified since the user accessed it.

Constructors

ModifiedConfigOverwriteException(DbConfigHeader, String)publicModifiedConfigOverwriteException(oracle.apps.cz.dio.config.DbConfigHeaderheader, java.lang.String message)

Member Summary

Constructors

ModifiedConfigOverwriteException(DbConfigHeader, String)

NoAtpCalculatedException


oracle.apps.cz.cioNoAtpCalculatedException

Syntaxpublic class NoAtpCalculatedException extends java.lang.Exception



|+--oracle.apps.cz.cio.NoAtpCalculatedException


DescriptionException which is thrown when an ATP method is called on an item for which ATP is not calculated.






NoConfigHeaderException


oracle.apps.cz.cioNoConfigHeaderException

Syntaxpublic class NoConfigHeaderException extends java.lang.Exception



|+--oracle.apps.cz.cio.NoConfigHeaderException


DescriptionSignalled if the configuration hasn't been saved yet.

Member Summary

Constructors

NoConfigHeaderException(Configuration)






NoConfigHeaderException


Constructors

NoConfigHeaderException(Configuration)public NoConfigHeaderException(Configuration config)

NodeNotEffectiveException


oracle.apps.cz.cioNodeNotEffectiveException

Syntaxpublic class NodeNotEffectiveException extends LogicalException



|+--LogicalException

|+--oracle.apps.cz.cio.NodeNotEffectiveException


Description

Member Summary

Methods

getNode()


Methods inherited from interface LogicalException

getCause(), getMessage(), getMessageHeader(), getMessageHeader(String), getReasons(), isOverridable()





NodeNotEffectiveException


Methods

getNode()public IRuntimeNode getNode()

NonPricedNodeException


oracle.apps.cz.cioNonPricedNodeException

Syntaxpublic class NonPricedNodeException extends java.lang.Exception



|+--oracle.apps.cz.cio.NonPricedNodeException


DescriptionException which is thrown when a pricing method is called on an item which should not be priced.






NoSuchChildException


oracle.apps.cz.cioNoSuchChildException

Syntaxpublic class NoSuchChildException extends java.lang.Exception



|+--oracle.apps.cz.cio.NoSuchChildException


DescriptionSignalled if a requested child does not exist.

Member Summary

Constructors

NoSuchChildException(IRuntimeNode, int, Configuration)

NoSuchChildException(IRuntimeNode, String, Configuration)

Methods

getID()

getName()

getParent()

NoSuchChildException


Constructors

NoSuchChildException(IRuntimeNode, int, Configuration)public NoSuchChildException(IRuntimeNode parent, int id, Configuration config)

NoSuchChildException(IRuntimeNode, String, Configuration)public NoSuchChildException(IRuntimeNode parent, java.lang.String name,Configuration config)

Methods









NoSuchUiNodeException


oracle.apps.cz.cioNoSuchUiNodeException

Syntaxpublic class NoSuchUiNodeException extends java.lang.Exception



|+--oracle.apps.cz.cio.NoSuchUiNodeException

Direct Known Subclasses: IneffectiveUiNodeException, UiNodeUnAvailableException


DescriptionSignalled if a requested node does not exist.

Member Summary

Constructors

NoSuchUiNodeException(String, Configuration)

Methods

getName()



NoSuchUiNodeException


Constructors

NoSuchUiNodeException(String, Configuration)public NoSuchUiNodeException(java.lang.String name, Configuration config)

Methods






NotOneProductException


oracle.apps.cz.cioNotOneProductException

Syntaxpublic class NotOneProductException extends java.lang.Exception



|+--oracle.apps.cz.cio.NotOneProductException


DescriptionException which is thrown when a client tries to create a configuration by specifying the name of the project and the project contains more than one or no products.






NotOneProjectException


oracle.apps.cz.cioNotOneProjectException

Syntaxpublic class NotOneProjectException extends java.lang.Exception



|+--oracle.apps.cz.cio.NotOneProjectException


DescriptionException which is thrown when a client tries to create a configuration by specifying the name of the project and the project name identifies more than one or no projects.






Option


oracle.apps.cz.cioOption

Syntaxpublic class Option extends OptionNode


|+--PricedNode

|+--StateNode

|+--StateCountNode

|+--OptionNode

|+--oracle.apps.cz.cio.Option

All Implemented Interfaces: ICount, IOption, IPrice, IRuntimeNode, IState

DescriptionRepresents an option of an option feature.

Member Summary

Methods

getType()




Option




Methods inherited from class OptionNode

deselect(), isOptionMutexed(), isSelected(), select(), setState(int)




getState(), isDefaultState(int), isFalse(), isFalseState(int), isLogic(), isLogicState(int), isTrue(), isTrueState(int), isUnknown(), isUnknownState(int), isUser(), isUserState(int), statesMatch(int, int), unset()















Option


Methods







OptionFeature


oracle.apps.cz.cioOptionFeature

Syntaxpublic class OptionFeature extends OptionFeatureNode


|+--PricedNode

|+--StateNode

|+--StateCountNode


|+--oracle.apps.cz.cio.OptionFeature

All Implemented Interfaces: ICount, IOptionFeature, IPrice, IRuntimeNode, IState

DescriptionRepresents a feature with selectable options.

Member Summary

Methods

areOptionsCounted()

getType()



OptionFeature






deselect(IOption), getAvailableOptions(), getMaxSelected(), getMinSelected(), getSelectableChildren(), getSelectedOption(), getSelectedOptions(), hasMaxSelected(), hasMinSelected(), isSelectionMutexed(), select(IOption)












deselect(IOption), getMaxSelected(), getMinSelected(), getSelectableChildren(), getSelectedOption(), getSelectedOptions(), hasMaxSelected(), hasMinSelected(), isSelectionMutexed(), select(IOption)





OptionFeature


Methods










OptionFeatureNode


oracle.apps.cz.cioOptionFeatureNode

Syntaxpublic abstract class OptionFeatureNode extends StateCountNode implementsIOptionFeature


|+--PricedNode

|+--StateNode

|+--StateCountNode

|+--oracle.apps.cz.cio.OptionFeatureNode

Direct Known Subclasses: BomNode, OptionFeature

All Implemented Interfaces: ICount, IOptionFeature, IPrice, IRuntimeNode, IState

DescriptionAn abstract class implementing behavior commont to all features with options.

Member Summary

Methods

deselect(IOption)

getAvailableOptions()

getMaxSelected()

getMinSelected()

OptionFeatureNode


getSelectableChildren()

getSelectedOption()

getSelectedOptions()

hasMaxSelected()

hasMinSelected()

isSelectionMutexed()

select(IOption)













Member Summary

OptionFeatureNode


Methods

deselect(IOption)public void deselect(IOption option)

Specified By: deselect(IOption) in interface IOptionFeature

getAvailableOptions()public java.util.Map getAvailableOptions()





areOptionsCounted()










OptionFeatureNode


getMaxSelected()public int getMaxSelected()

Specified By: getMaxSelected() in interface IOptionFeature

getMinSelected()public int getMinSelected()

Specified By: getMinSelected() in interface IOptionFeature

getSelectableChildren()public java.util.List getSelectableChildren()

Specified By: getSelectableChildren() in interface IOptionFeature

getSelectedOption()public IOption getSelectedOption()

Specified By: getSelectedOption() in interface IOptionFeature

getSelectedOptions()public java.util.List getSelectedOptions()

Specified By: getSelectedOptions() in interface IOptionFeature

hasMaxSelected()public boolean hasMaxSelected()

Specified By: hasMaxSelected() in interface IOptionFeature

OptionFeatureNode


hasMinSelected()public boolean hasMinSelected()

Specified By: hasMinSelected() in interface IOptionFeature





OptionNode


oracle.apps.cz.cioOptionNode

Syntaxpublic abstract class OptionNode extends StateCountNode implements IOption


|+--PricedNode

|+--StateNode

|+--StateCountNode

|+--oracle.apps.cz.cio.OptionNode

Direct Known Subclasses: Option

All Implemented Interfaces: ICount, IOption, IPrice, IRuntimeNode, IState

DescriptionAn abstract class implementing behavior common to all option-like objects.

Member Summary

Methods

deselect()

isOptionMutexed()

isSelected()

select()

setState(int)

OptionNode










getState(), isDefaultState(int), isFalse(), isFalseState(int), isLogic(), isLogicState(int), isTrue(), isTrueState(int), isUnknown(), isUnknownState(int), isUser(), isUserState(int), statesMatch(int, int), unset()








getState(), isFalse(), isLogic(), isTrue(), isUnknown(), isUser(), unset()




OptionNode


Methods


Specified By: deselect() in interface IOption


Specified By: isOptionMutexed() in interface IOption


Specified By: isSelected() in interface IOption


Specified By: select() in interface IOption





OptionNode





Overrides:setState(int) in class StateNode

PricedNode


oracle.apps.cz.cioPricedNode

Syntaxpublic abstract class PricedNode extends RuntimeNode implements IPrice


|+--oracle.apps.cz.cio.PricedNode

Direct Known Subclasses: IntegerNode, ReadOnlyDecimalNode, StateNode

All Implemented Interfaces: IPrice, IRuntimeNode

DescriptionAbstract class implementing common behavior across all runtime nodes that can be priced.

Member Summary

Methods

addDiscountedPricingNotification(String)

addListPricingNotification(String)

cacheCurrentDiscountedPrice()

clearDiscountedPrice()

clearDiscountedPricingNotifications()

clearListPricingNotifications()

getDiscountedPrice()

PricedNode


getDiscountedPricingNotifications()

getExtendedPrice()

getItemKey()

getListPrice()

getListPricingNotifications()

getOldDiscountedPrice()

getPricingNotifications()

getPricingValue() Generic function that returns the value of a priced runtime node as a String irrespective of the type of node.

getUomCode()

hasDiscountedPrice()

hasListPrice()

setDiscountedPrice(double)

setListPrice(double)









Member Summary

PricedNode


Methods

addDiscountedPricingNotification(String)public void addDiscountedPricingNotification(java.lang.String message)

addListPricingNotification(String)public void addListPricingNotification(java.lang.String message)

cacheCurrentDiscountedPrice()public void cacheCurrentDiscountedPrice()

clearDiscountedPrice()public void clearDiscountedPrice()

clearDiscountedPricingNotifications()public void clearDiscountedPricingNotifications()

clearListPricingNotifications()public void clearListPricingNotifications()



getDatabaseID()




PricedNode


getDiscountedPricingNotifications()public java.lang.String getDiscountedPricingNotifications()

Specified By: getDiscountedPricingNotifications() in interface IPrice

getExtendedPrice()public double getExtendedPrice()

Specified By: getExtendedPrice() in interface IPrice



getListPrice()public double getListPrice()


getListPricingNotifications()public java.lang.String getListPricingNotifications()

Specified By: getListPricingNotifications() in interface IPrice

getOldDiscountedPrice()public double getOldDiscountedPrice()

getPricingNotifications()public java.lang.String getPricingNotifications()

PricedNode


Specified By: getPricingNotifications() in interface IPrice

getPricingValue()public java.lang.String getPricingValue()Generic function that returns the value of a priced runtime node as a String irrespective of the type of node.



hasDiscountedPrice()public boolean hasDiscountedPrice()

hasListPrice()public boolean hasListPrice()

setDiscountedPrice(double)public void setDiscountedPrice(double discountedPrice)

setListPrice(double)public void setListPrice(double listPrice)

PricingUnavailableException


oracle.apps.cz.cioPricingUnavailableException

Syntaxpublic class PricingUnavailableException extends java.lang.Exception



|+--oracle.apps.cz.cio.PricingUnavailableException


DescriptionSignals that the CIO pricing functionality is not available.

Member Summary

Constructors

PricingUnavailableException(String)

PricingUnavailableException(String, Object, Log)






PricingUnavailableException


Constructors

PricingUnavailableException(String)public PricingUnavailableException(java.lang.String reason)

PricingUnavailableException(String, Object, Log)public PricingUnavailableException(java.lang.String reason, java.lang.Objectsource, oracle.apps.fnd.common.Log log)

Property


oracle.apps.cz.cioProperty

Syntaxpublic class Property extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.Property

DescriptionRepresents name/value properties associated with runtime nodes.

Member Summary

Methods

getBooleanValue() Returns the property's value as a boolean.

getDecimalValue() Returns the property's value as a double.

getDescription() Returns the property's description.

getIntValue() Returns the property's value as an integer.

getName() Returns the property's name.

getStringValue() Returns the property's value as a string.

getUnit() Returns the property's unit of measure.

hasBooleanValue() Returns true if property has a boolean value.

hasDecimalValue() Returns true if property has a decimal value.

hasDefaultValue() Checks to see if property has a default value.

hasIntegerValue() Returns true if property has an integer value.

hasStringValue() Returns true if property has a string value.

hasValue() Returns true if property has a value.

isBooleanType() Returns true if property is a boolean property.

Property


Methods

getBooleanValue()public boolean getBooleanValue()Returns the property's value as a boolean.

getDecimalValue()public double getDecimalValue()Returns the property's value as a double.

getDescription()public java.lang.String getDescription()Returns the property's description.

getIntValue()public int getIntValue()Returns the property's value as an integer.

getName()public java.lang.String getName()Returns the property's name.

isDecimalType() Returns true if property is a decimal property.

isDefaulted() Checks to see if property has overridden its default value.

isIntegerType() Returns true if property is an integer property.

isStringType() Returns true if property is a string property.




Member Summary

Property


getStringValue()public java.lang.String getStringValue()Returns the property's value as a string.

getUnit()public java.lang.String getUnit()Returns the property's unit of measure.

hasBooleanValue()public boolean hasBooleanValue()Returns true if property has a boolean value.

hasDecimalValue()public boolean hasDecimalValue()Returns true if property has a decimal value.

hasDefaultValue()public boolean hasDefaultValue()Checks to see if property has a default value.

hasIntegerValue()public boolean hasIntegerValue()Returns true if property has an integer value.

hasStringValue()public boolean hasStringValue()Returns true if property has a string value.

hasValue()public boolean hasValue()Returns true if property has a value.

isBooleanType()public boolean isBooleanType()Returns true if property is a boolean property.

Property


isDecimalType()public boolean isDecimalType()Returns true if property is a decimal property.

isDefaulted()public boolean isDefaulted()Checks to see if property has overridden its default value.

isIntegerType()public boolean isIntegerType()Returns true if property is an integer property.

isStringType()public boolean isStringType()Returns true if property is a string property.

ReadOnlyDecimalNode


oracle.apps.cz.cioReadOnlyDecimalNode

Syntaxpublic abstract class ReadOnlyDecimalNode extends PricedNode implementsIReadOnlyDecimal


|+--PricedNode

|+--oracle.apps.cz.cio.ReadOnlyDecimalNode

Direct Known Subclasses: DecimalNode

All Implemented Interfaces: IPrice, IReadOnlyDecimal, IRuntimeNode

DescriptionAn abstract class implementing behavior common to objects with a decimal value.

Member Summary

Methods

getDecimalValue()

isUnknown()

toString()



ReadOnlyDecimalNode


Methods

getDecimalValue()public double getDecimalValue()

Specified By: getDecimalValue() in interface IReadOnlyDecimal













ReadOnlyDecimalNode



Specified By: isUnknown() in interface IReadOnlyDecimal


Overrides:toString() in class RuntimeNode

Reason


oracle.apps.cz.cioReason

Syntaxpublic class Reason extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.Reason

DescriptionThis class wraps the information returned by a contradiction in order to include information about internal error messages.

Member Summary

Fields

B2B

B2C1

B2C2

B2C3

B2C4

B2P1

B2P2

DEFAULT This reason initiated from inability to set a state, because of a default relation.

INTL_TEXT The message is an internationalized text string.

MINMAX This reason initiated from an internal MINMAX relationship.

ORTHEN This reason initiated from an internal ORTHEN relationship.

TEXT The message is an unknown format text string.

TRUEATBIRTH This reason initiated from an internal relationship for a group.

Constructors

Reason


Fields

B2Bpublic static int B2B

B2C1public static int B2C1


Reason(int, IRuntimeNode, String, Configuration)

Construct a reason given all of it's information.

Reason(Message, String, IRuntimeNode, Configuration)

Constructs a reason from an FND message.

Reason(String, Configuration) Constructs a simple TEXT reason.

Methods

getFndMessageString(Message)

getMsg() Get the message associated with this reason.

getNode() Get the node associated with this reason.

getType() Get the type of reason is held in this object.

toString() Convert this object to a string.

translate() This method returns the translated string for the reason.

translate(String) This method returns the translated reason string using the given name for substitution variable.




Member Summary

Reason




B2P1public static int B2P1

B2P2public static int B2P2

DEFAULTpublic static int DEFAULTThis reason initiated from inability to set a state, because of a default relation.

INTL_TEXTpublic static int INTL_TEXTThe message is an internationalized text string.

MINMAXpublic static int MINMAXThis reason initiated from an internal MINMAX relationship.

ORTHENpublic static int ORTHENThis reason initiated from an internal ORTHEN relationship.

TEXTpublic static int TEXTThe message is an unknown format text string.

TRUEATBIRTHpublic static int TRUEATBIRTHThis reason initiated from an internal relationship for a group.

Reason


Constructors

Reason(int, IRuntimeNode, String, Configuration)public Reason(int type, IRuntimeNode node, java.lang.String msg, Configurationconfig)

Construct a reason given all of it's information.

Parameters: type - What type of reason this is.

node - The node that caused the problem.

msg - The message returned.

Reason(Message, String, IRuntimeNode, Configuration)public Reason(oracle.apps.fnd.common.Message fndMsg, java.lang.String token,IRuntimeNode node, Configuration config)

Constructs a reason from an FND message.

Parameters: fndMsg - The FND message object with all but one token substituted.

token - The token name left to substitute.

node - The node requiring substitution.

Reason(String, Configuration)public Reason(java.lang.String msg, Configuration config)Constructs a simple TEXT reason.

Parameters: msg - The message string for the reason.

Methods

getFndMessageString(Message)public java.lang.String getFndMessageString(oracle.apps.fnd.common.MessagefndMsg)

Reason


getMsg()public java.lang.String getMsg()Get the message associated with this reason.

getNode()public IRuntimeNode getNode()Get the node associated with this reason.

getType()public int getType()Get the type of reason is held in this object.

toString()public java.lang.String toString()Convert this object to a string.


translate()public java.lang.String translate()This method returns the translated string for the reason. If the string has a node name substitution then the internal name is used.

translate(String)public java.lang.String translate(java.lang.String nodeName)This method returns the translated reason string using the given name for substitution variable.

Parameters: nodeName - The node name to substitute into the string.

Request


oracle.apps.cz.cioRequest

Syntaxpublic class Request extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.Request

DescriptionThis class is the used for input and output of requests into the system.

Member Summary

Constructors

Request()

Request(IRuntimeNode, String)

Methods

getNumericValue() Returns the numeric value of this request.

getRuntimeNode()

getValue()

isFalseStateRequest() Returns true if this request is for changing the state of a runtime node to False, i.e., if the case insensitive value of this request is either "f" or "false".

isNumericRequest() Returns true if this request is for changing the numeric value of a runtime node, i.e., if the value of this request is a Number.

isStateRequest() Returns true if this request is for changing the state of a runtime node, i.e, if the case insensitive value of this request is either "t", "true", "f", "false", "toggle", or "unknown".

isToggleStateRequest() Returns true if this request is for toggling the state of a runtime node i.e., if the case insensitive value of this request is "toggle".

isTrueStateRequest() Returns true if this request is for changing the state of a runtime node to True, i.e., if the case insensitive value of this request is either "t" or "true".

Request


Constructors

Request()public Request()

Request(IRuntimeNode, String)public Request(IRuntimeNode node, java.lang.String value)

Methods

getNumericValue()public double getNumericValue()

Returns the numeric value of this request.


getValue()public java.lang.String getValue()

isFalseStateRequest()public boolean isFalseStateRequest()

Returns true if this request is for changing the state of a runtime node to False, i.e., if the case insensitive value of this request is either "f" or "false".

isUnknownStateRequest() Returns true if this request is for unsetting the state of a runtime node i.e., if the case insensitive value of this request is "unknown".

toString()




Member Summary

Request


isNumericRequest()public boolean isNumericRequest()Returns true if this request is for changing the numeric value of a runtime node, i.e., if the value of this request is a Number.

isStateRequest()public boolean isStateRequest()Returns true if this request is for changing the state of a runtime node, i.e, if the case insensitive value of this request is either "t", "true", "f", "false", "toggle", or "unknown".

isToggleStateRequest()public boolean isToggleStateRequest()Returns true if this request is for toggling the state of a runtime node i.e., if the case insensitive value of this request is "toggle".

isTrueStateRequest()public boolean isTrueStateRequest()Returns true if this request is for changing the state of a runtime node to True, i.e., if the case insensitive value of this request is either "t" or "true".

isUnknownStateRequest()public boolean isUnknownStateRequest()Returns true if this request is for unsetting the state of a runtime node i.e., if the case insensitive value of this request is "unknown".



Resource


oracle.apps.cz.cioResource

Syntaxpublic class Resource extends DecimalNode


|+--PricedNode


|+--DecimalNode

|+--oracle.apps.cz.cio.Resource


DescriptionRepresents a consumable resource. A resource will signal a validation failure when it is overconsumed (in other words, when its value goes below zero). NOTE: This class inherits from DecimalNode, but the functionality of a DecimalNode (specifically the method SetDecimalValue()) is 'deprecated', meaning that it shouldn't be used on new projects and may be unsupported in a future release. Use only methods inherited from ReadOnlyDecimalNode.

Member Summary

Methods

getType()

Resource






















Resource


Methods





RestoreValidationFailure


oracle.apps.cz.cioRestoreValidationFailure

Syntaxpublic class RestoreValidationFailure extends ValidationFailure


|+--ValidationFailure

|+--oracle.apps.cz.cio.RestoreValidationFailure

DescriptionFailure produced when restoring a configuration over a changed model.

Member Summary

Methods

equals(Object)

getInput() Returns the input object where the validation failure occured

hashCode()


Fields inherited from class ValidationFailure

COMPANION_FAILURE, CUSTOM_FAILURE, MAX_FAILURE, MIN_FAILURE, MIN0_FAILURE, MINMAX_FAILURE, RESOURCE_FAILURE, RESTORE_FAILURE

Fields inherited from class StatusInfo

STATUS_DELETED, STATUS_EXISTING, STATUS_NEW

Methods inherited from class ValidationFailure

RestoreValidationFailure


Methods

equals(Object)public boolean equals(java.lang.Object obj)

Overrides:equals(Object) in class ValidationFailure

getInput()public oracle.apps.cz.dio.config.DbConfigInput getInput()Returns the input object where the validation failure occured


hashCode()public int hashCode()

Overrides:hashCode() in class StatusInfo

getMessage(), getMessage(String), getType(), toString()

Methods inherited from class StatusInfo

getNode(), getStatus(), statusToString(int), toString(boolean)


getClass, notify, notifyAll, wait, wait, wait


RuntimeNode


oracle.apps.cz.cioRuntimeNode

Syntaxpublic abstract class RuntimeNode extends java.lang.Object implementsIRuntimeNode

java.lang.Object|+--oracle.apps.cz.cio.RuntimeNode

Direct Known Subclasses: ComponentSet, PricedNode, TextNode

All Implemented Interfaces: IRuntimeNode

DescriptionAbstract class implementing common behavior across all runtime nodes.

Member Summary

Methods

getChildByID(int) Returns the child of this node with a given ID.

getChildByName(String) Returns the child of this node with a given name.

getChildByPersistentID(int) Returns the child of this node with a given persistent ID.

getChildren() Returns a list of all children of this runtime node.

getChildrenByType(int) Returns a list of all children of a particular type.

getConfiguration() Returns the configuration to which this node belongs.



getFuncCompByID(int) Returns a particular functional companion based on its ID, null if no match.

RuntimeNode


getFuncCompByName(String) Returns a particular functional companion based on its name, null if no match.

getFunctionalCompanions() Returns a list of all functional companions associated with this component.

getName() Returns the name of the runtime node.

getParent() Returns the parent of this runtime node, or null if this is the root node.

getPersistentID() Returns the peristent ID of the runtime node.

getProperties() Returns a collection of the properties associated with this node.

getPropertyByName(String) Returns a particular property of this node, based on its name.

getRuntimeID() Returns the runtime ID for the node.

getSelectionLineID()

getType() Returns the type of the runtime node.

hasChildren()




hasIntegerValue() Returns true if the node has a integer value.

hasSelectionLineID()


hasTextValue() Returns true if the node has a text value.

isDefaultAffected() Returns true if the given state is affected by a default assertion (not unknown, or user, or logic).

isEffective()

isNative() Returns true if this is a native BOM node

isRoot() Returns true if this is the root node of the runtime tree.

isUnsatisfied() Returns true if this runtime node, or any of its children, is not fully configured.

isUnsatisfiedNode() Returns true if this particular node is not fully configured.

lookupNodeID(Object)

toString()

Member Summary

RuntimeNode


Methods

getChildByID(int)public IRuntimeNode getChildByID(int id)Returns the child of this node with a given ID.

Specified By: getChildByID(int) in interface IRuntimeNode

Throws: NoSuchChildException - if there is no child with such ID.

getChildByName(String)public IRuntimeNode getChildByName(java.lang.String name)

Returns the child of this node with a given name.

Specified By: getChildByName(String) in interface IRuntimeNode

Throws: NoSuchChildException - if there is no child with such name.

toString(boolean)

typeToString(int) Returns a string representation of a given runtime node type constant.






Member Summary

RuntimeNode


getChildByPersistentID(int)public IRuntimeNode getChildByPersistentID(int id)Returns the child of this node with a given persistent ID.

Specified By: getChildByPersistentID(int) in interface IRuntimeNode

Throws: NoSuchChildException - if there is no child with such ID.

getChildren()public java.util.List getChildren()

Returns a list of all children of this runtime node.

Specified By: getChildren() in interface IRuntimeNode

getChildrenByType(int)public java.util.List getChildrenByType(int type)

Returns a list of all children of a particular type.

Specified By: getChildrenByType(int) in interface IRuntimeNode

getConfiguration()public Configuration getConfiguration()

Returns the configuration to which this node belongs.

Specified By: getConfiguration() in interface IRuntimeNode



RuntimeNode


Specified By: getDatabaseID() in interface IRuntimeNode

getDescription()public java.lang.String getDescription()Returns the design-time description of the runtime node.

Specified By: getDescription() in interface IRuntimeNode

getFuncCompByID(int)public IFunctionalCompanion getFuncCompByID(int id)

Returns a particular functional companion based on its ID, null if no match.

getFuncCompByName(String)public IFunctionalCompanion getFuncCompByName(java.lang.String name)

Returns a particular functional companion based on its name, null if no match.

getFunctionalCompanions()public java.util.List getFunctionalCompanions()

Returns a list of all functional companions associated with this component.


Returns the name of the runtime node.

Specified By: getName() in interface IRuntimeNode


Returns the parent of this runtime node, or null if this is the root node.

Specified By: getParent() in interface IRuntimeNode

RuntimeNode


getPersistentID()public int getPersistentID()Returns the peristent ID of the runtime node.

Specified By: getPersistentID() in interface IRuntimeNode

getProperties()public java.util.Collection getProperties()Returns a collection of the properties associated with this node. The collection contains items of the type IProperty.

Specified By: getProperties() in interface IRuntimeNode

getPropertyByName(String)public Property getPropertyByName(java.lang.String name)

Returns a particular property of this node, based on its name. Returns null if a property of the given name does not exist.

Specified By: getPropertyByName(String) in interface IRuntimeNode

getRuntimeID()public int getRuntimeID()

Returns the runtime ID for the node. This ID is unique across all nodes in a particular configuration.

Specified By: getRuntimeID() in interface IRuntimeNode

getSelectionLineID()public int getSelectionLineID()

Specified By: getSelectionLineID() in interface IRuntimeNode

RuntimeNode


getType()public abstract int getType()Returns the type of the runtime node. Must be implemented.


hasChildren()public boolean hasChildren()

Specified By: hasChildren() in interface IRuntimeNode

hasCount()public boolean hasCount()

Returns true if the node has an object count.

Specified By: hasCount() in interface IRuntimeNode

hasDecimalValue()public boolean hasDecimalValue()

Returns true if the node has a decimal value.

Specified By: hasDecimalValue() in interface IRuntimeNode

hasDescription()public boolean hasDescription()

Returns true if there is a design-time description of the runtime node.

Specified By: hasDescription() in interface IRuntimeNode

hasIntegerValue()public boolean hasIntegerValue()

RuntimeNode


Returns true if the node has a integer value.

hasSelectionLineID()public boolean hasSelectionLineID()

Specified By: hasSelectionLineID() in interface IRuntimeNode

hasState()public boolean hasState()

Returns true if the node has a logical state.

Specified By: hasState() in interface IRuntimeNode

hasTextValue()public boolean hasTextValue()Returns true if the node has a text value.

Specified By: hasTextValue() in interface IRuntimeNode

isDefaultAffected()public boolean isDefaultAffected()Returns true if the given state is affected by a default assertion (not unknown, or user, or logic).

isEffective()public boolean isEffective()

Specified By: isEffective() in interface IRuntimeNode

isNative()public boolean isNative()Returns true if this is a native BOM node

RuntimeNode


Specified By: isNative() in interface IRuntimeNode

isRoot()public boolean isRoot()Returns true if this is the root node of the runtime tree.

Specified By: isRoot() in interface IRuntimeNode


Returns true if this runtime node, or any of its children, is not fully configured.

Specified By: isUnsatisfied() in interface IRuntimeNode

isUnsatisfiedNode()public boolean isUnsatisfiedNode()

Returns true if this particular node is not fully configured.

Specified By: isUnsatisfiedNode() in interface IRuntimeNode

lookupNodeID(Object)public IRuntimeNode lookupNodeID(java.lang.Object id)




RuntimeNode


Specified By: toString(boolean) in interface IRuntimeNode

typeToString(int)public static java.lang.String typeToString(int type)Returns a string representation of a given runtime node type constant.

SelectionNotMutexedException


oracle.apps.cz.cioSelectionNotMutexedException

Syntaxpublic class SelectionNotMutexedException extends java.lang.Exception



|+--oracle.apps.cz.cio.SelectionNotMutexedException


DescriptionSignalled when an mutexed selection operation is performed on an option feature that does not support mutexed selection.

Member Summary

Methods

getFeature()






SelectionNotMutexedException


Methods

getFeature()public IOptionFeature getFeature()

StateCountNode


oracle.apps.cz.cioStateCountNode

Syntaxpublic abstract class StateCountNode extends StateNode implements ICount, IPrice


|+--PricedNode

|+--StateNode

|+--oracle.apps.cz.cio.StateCountNode

Direct Known Subclasses: CountFeature, OptionFeatureNode, OptionNode

All Implemented Interfaces: ICount, IPrice, IRuntimeNode, IState

DescriptionAbstract class implementing common behavior for nodes with a logic state and count.

Member Summary

Methods

getCount()

getDecimalCount()

setCount(int)

setDecimalCount(double)

toString()

StateCountNode





















StateCountNode


Methods


Specified By: getCount() in interface ICount

getDecimalCount()public double getDecimalCount()

Specified By: getDecimalCount() in interface ICount

setCount(int)public void setCount(int newCount)

Specified By: setCount(int) in interface ICount

setDecimalCount(double)public void setDecimalCount(double newCount)

Specified By: setDecimalCount(double) in interface ICount


Overrides:toString() in class RuntimeNode

StateNode


oracle.apps.cz.cioStateNode

Syntaxpublic abstract class StateNode extends PricedNode implements IState


|+--PricedNode

|+--oracle.apps.cz.cio.StateNode

Direct Known Subclasses: BooleanFeature, StateCountNode

All Implemented Interfaces: IPrice, IRuntimeNode, IState

DescriptionAbstract class implementing common behavior across nodes with logic state.

Member Summary

Methods

getState()

isDefaultState(int) Returns true if the given state is default (not unknown, or user, or logic).

isFalse()

isFalseState(int) Returns true if the given state is false (not unknown or true).

isLogic()

isLogicState(int) Returns true if the given state is logic (not unknown, or user, or default).

isTrue()

StateNode


isTrueState(int) Returns true if the given state is true (not unknown or false).

isUnknown()

isUnknownState(int) Returns true if the given state is unknown (not true or false).

isUser()

isUserState(int) Returns true if the given state is user (not unknown, or logic, or default).

setState(int)

statesMatch(int, int) Returns true if the two given states match.

unset()













Member Summary

StateNode


Methods

getState()public int getState()


isDefaultState(int)public static boolean isDefaultState(int state)

Returns true if the given state is default (not unknown, or user, or logic).

isFalse()public boolean isFalse()

Specified By: isFalse() in interface IState

isFalseState(int)public static boolean isFalseState(int state)

Returns true if the given state is false (not unknown or true).

isLogic()public boolean isLogic()





StateNode


Specified By: isLogic() in interface IState

isLogicState(int)public static boolean isLogicState(int state)Returns true if the given state is logic (not unknown, or user, or default).

isTrue()public boolean isTrue()

Specified By: isTrue() in interface IState

isTrueState(int)public static boolean isTrueState(int state)

Returns true if the given state is true (not unknown or false).


Specified By: isUnknown() in interface IState

isUnknownState(int)public static boolean isUnknownState(int state)

Returns true if the given state is unknown (not true or false).

isUser()public boolean isUser()

Specified By: isUser() in interface IState

isUserState(int)public static boolean isUserState(int state)

Returns true if the given state is user (not unknown, or logic, or default).

StateNode




statesMatch(int, int)public static boolean statesMatch(int inputState, int outputState)Returns true if the two given states match.


Specified By: unset() in interface IState

StatusInfo


oracle.apps.cz.cioStatusInfo

Syntaxpublic class StatusInfo extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.cio.StatusInfo

Direct Known Subclasses: ValidationFailure

DescriptionContains information about a status change for a particular runtime node. The status can be STATUS_NEW, STATUS_EXISTING, or STATUS_DELETED. The condition for which this status holds depends on which list the status exists. Possibilities include validation failure, selected nodes, and unsatisfied nodes.

Member Summary

Fields

STATUS_DELETED The node has newly lost this status since the last check.

STATUS_EXISTING The already had this status during the last check, and it still does.

STATUS_NEW The node has newly attained this status since the last check.

Methods

equals(Object)

getNode() Returns the runtime node with which this status is associated.

getStatus() Returns the current status of the node.

hashCode()

statusToString(int) Return a printable representation of a status constant.

toString()

StatusInfo


Fields

STATUS_DELETEDpublic static final int STATUS_DELETEDThe node has newly lost this status since the last check.

STATUS_EXISTINGpublic static final int STATUS_EXISTINGThe already had this status during the last check, and it still does.

STATUS_NEWpublic static final int STATUS_NEWThe node has newly attained this status since the last check.

Methods


Overrides:java.lang.Object.equals(java.lang.Object) in class java.lang.Object

getNode()public IRuntimeNode getNode()

Returns the runtime node with which this status is associated.

toString(boolean)




Member Summary

StatusInfo


getStatus()public int getStatus()Returns the current status of the node.

hashCode()public int hashCode()

Overrides:java.lang.Object.hashCode() in class java.lang.Object

statusToString(int)public static java.lang.String statusToString(int status)Return a printable representation of a status constant.




TextFeature


oracle.apps.cz.cioTextFeature

Syntaxpublic class TextFeature extends TextNode


|+--TextNode

|+--oracle.apps.cz.cio.TextFeature

All Implemented Interfaces: IRuntimeNode, IText

DescriptionRepresents a feature that has a textual value.

Member Summary

Methods

getType()




Methods inherited from class TextNode

getTextValue(), setTextValue(String), unset()


TextFeature


Methods






Methods inherited from interface IText

getTextValue(), setTextValue(String), unset()




TextNode


oracle.apps.cz.cioTextNode

Syntaxpublic abstract class TextNode extends RuntimeNode implements IText


|+--oracle.apps.cz.cio.TextNode

Direct Known Subclasses: TextFeature

All Implemented Interfaces: IRuntimeNode, IText

DescriptionRepresents a feature that has a textual value.

Member Summary

Methods

getTextValue()

setTextValue(String)

unset()




TextNode


Methods

getTextValue()public java.lang.String getTextValue()

Specified By: getTextValue() in interface IText

setTextValue(String)public void setTextValue(java.lang.String newTextValue)

Specified By: setTextValue(String) in interface IText


Specified By: unset() in interface IText








Total


oracle.apps.cz.cioTotal

Syntaxpublic class Total extends DecimalNode


|+--PricedNode


|+--DecimalNode

|+--oracle.apps.cz.cio.Total


DescriptionRepresents a total that has a decimal numeric value. NOTE: This class inherits from DecimalNode, but the functionality of a DecimalNode (specifically the method SetDecimalValue()) is 'deprecated', meaning that it shouldn't be used on new projects and may be unsupported in a future release. Use only methods inherited from ReadOnlyDecimalNode.

Member Summary

Methods

getType()



Total






















Total


Methods



TransactionException


oracle.apps.cz.cioTransactionException

Syntaxpublic class TransactionException extends java.lang.Exception



|+--oracle.apps.cz.cio.TransactionException


DescriptionSignalled if a particular logic file is missing.

Member Summary

Methods

getAction() Returns a String representation of the action that caused the exception






TransactionException


Methods

getAction()public java.lang.String getAction()

Returns a String representation of the action that caused the exception

UiNodeUnAvailableException


oracle.apps.cz.cioUiNodeUnAvailableException

Syntaxpublic class UiNodeUnAvailableException extends NoSuchUiNodeException



|+--NoSuchUiNodeException

|+--oracle.apps.cz.cio.UiNodeUnAvailableException


Description

Member Summary

Constructors

UiNodeUnAvailableException(IUserInterfaceNode, Configuration)

Methods

getNode()


Methods inherited from interface NoSuchUiNodeException

getName()


UiNodeUnAvailableException


Constructors

UiNodeUnAvailableException(IUserInterfaceNode, Configuration)public UiNodeUnAvailableException(IUserInterfaceNode node, Configurationconfig)

Methods

getNode()public IUserInterfaceNode getNode()





ValidationFailure


oracle.apps.cz.cioValidationFailure

Syntaxpublic class ValidationFailure extends StatusInfo


|+--oracle.apps.cz.cio.ValidationFailure

Direct Known Subclasses: CompanionValidationFailure, RestoreValidationFailure

DescriptionImplements behavior common to all validation failures.

Member Summary

Fields

COMPANION_FAILURE

CUSTOM_FAILURE

MAX_FAILURE

MIN_FAILURE

MIN0_FAILURE

MINMAX_FAILURE

RESOURCE_FAILURE

RESTORE_FAILURE

Methods

equals(Object)

getMessage()

ValidationFailure


Fields

COMPANION_FAILUREpublic static final int COMPANION_FAILURE

CUSTOM_FAILUREpublic static final int CUSTOM_FAILURE

MAX_FAILUREpublic static final int MAX_FAILURE

MIN_FAILUREpublic static final int MIN_FAILURE

MIN0_FAILUREpublic static final int MIN0_FAILURE

getMessage(String)

getType()

toString()


Fields inherited from class StatusInfo

STATUS_DELETED, STATUS_EXISTING, STATUS_NEW

Methods inherited from class StatusInfo

getNode(), getStatus(), hashCode(), statusToString(int), toString(boolean)



Member Summary

ValidationFailure


MINMAX_FAILUREpublic static final int MINMAX_FAILURE

RESOURCE_FAILUREpublic static final int RESOURCE_FAILURE

RESTORE_FAILUREpublic static final int RESTORE_FAILURE

Methods


Overrides:equals(Object) in class StatusInfo

getMessage()public java.lang.String getMessage()

getMessage(String)public java.lang.String getMessage(java.lang.String nodeName)



Overrides:toString() in class StatusInfo

ValidationFailure


Package oracle.apps.cz.common C-1

CPackage oracle.apps.cz.common

Description

Class Summary

Classes

CZContext Represents the runtime context of a configuration session.

CZContext

C-2 Oracle Configuration Interface Object (CIO) Developer’s Guide

oracle.apps.cz.commonCZContext

Syntaxpublic final class CZContext

oracle.apps.cz.common.CZContext

Description

Deprecated.for non-mobile users

Represents the runtime context of a configuration session. The context owns the database connection, resources, and log object. It also maintains apps, user, and language information. CZContext is a shadow of the oracle.apps.fnd.common.AppsContext implementation and is designed to operate outside of the middle-tier Oracle Apps environment. This object is to be used only by mobile customers. All others should use either AppsContext or WebAppsContext.

Member Summary

Constructors

CZContext(String, String) Creates a new CZContext containing a connection established with the supplied database url.

CZContext(String, String, String, String)

Creates a new CZContext containing a connection established with the supplied database url, user name, and password.

Methods

createConnection(String, String, String)

Creates a new JDBC connection.

finalizeWorkaround()

getAppId(String) Returns the application ID for product configuration (CZ).

getCurrLangCode() Returns the current language code.

getCurrLangInfo() This method is restricted.

CZContext


Constructors

CZContext(String, String)public CZContext(java.lang.String url, java.lang.String dbOwner)

getDbOwner() Returns name of Oracle Configurator Schema owner.

getEnvStore() CZContext does not contain an environment store, so this method will always throw a RuntimeException.

getInitializeMessage()

getInstance() Returns database instance name.

getJDBCConnection()

getJDBCConnection(Object) Returns the JDBC connection.

getLangCode(String) This method is restricted.

getLangInfo(String, String) This method is restricted.

getLoginType()

getName() Returns the context's moniker

getNLSLang(String) This method is restricted.

getSessionManager() This method is restricted.

getUrl() Returns the JDBC URL.

getUser() Returns the user name.

isAlive()

isCompatibleConnection(UiXmlInitMessage)

releaseJDBCConnection()

setCurrLang(String) Sets the current language code.

setInitializeMessage(UiXmlInitMessage)

setLoginType(int)

setName(String) Sets the context's moniker

Member Summary

CZContext


Creates a new CZContext containing a connection established with the supplied database url.

Parameters: url - The full url of the database.

dbOwner - the schema owner of the Oracle Configurator tables

CZContext(String, String, String, String)public CZContext(java.lang.String url, java.lang.String user, java.lang.Stringpassword, java.lang.String dbOwner)Creates a new CZContext containing a connection established with the supplied database url, user name, and password.

Parameters: url - The full url of the database.

user - The database user name.

password - The user password.

dbOwner - the schema owner of the Oracle Configurator tables

Methods

createConnection(String, String, String)public void createConnection(java.lang.String url, java.lang.String user,java.lang.String password)

Creates a new JDBC connection.

finalizeWorkaround()public void finalizeWorkaround()

getAppId(String)public int getAppId(java.lang.String applShtName)

Returns the application ID for product configuration (CZ). The parameter signature is for compatibility with the AppsContext implementation.

getCurrLangCode()public java.lang.String getCurrLangCode()

CZContext


Returns the current language code.

getCurrLangInfo()public oracle.apps.fnd.common.LangInfo getCurrLangInfo()

This method is restricted.

getDbOwner()public java.lang.String getDbOwner()

Returns name of Oracle Configurator Schema owner.

getEnvStore()public oracle.apps.fnd.common.EnvironmentStore getEnvStore()

CZContext does not contain an environment store, so this method will always throw a RuntimeException. This may need to change in the future if we depend on an environment store, but CZContext will only be used for testing from now on.

getInitializeMessage()public oracle.apps.cz.common.UiXmlInitMessage getInitializeMessage()

getInstance()public java.lang.String getInstance()

Returns database instance name.

getJDBCConnection()public java.sql.Connection getJDBCConnection()

getJDBCConnection(Object)public java.sql.Connection getJDBCConnection(java.lang.Object pThis)

Returns the JDBC connection. The parameter signature includes a reference to the caller to be compatible with the AppsContext implementation.

getLangCode(String)public java.lang.String getLangCode(java.lang.String pNLSLang)


getLangInfo(String, String)public oracle.apps.fnd.common.LangInfo getLangInfo(java.lang.String pLangCode,

CZContext


java.lang.String pNLSLang)


getLoginType()public int getLoginType()


Returns the context's moniker

getNLSLang(String)public java.lang.String getNLSLang(java.lang.String pLangCode)


getSessionManager()public oracle.apps.fnd.security.SessionManager getSessionManager()


getUrl()public java.lang.String getUrl()

Returns the JDBC URL.

getUser()public java.lang.String getUser()

Returns the user name.

isAlive()public boolean isAlive()

isCompatibleConnection(UiXmlInitMessage)public boolean isCompatibleConnection(oracle.apps.cz.common.UiXmlInitMessagemsg)

releaseJDBCConnection()public void releaseJDBCConnection()

CZContext


setCurrLang(String)public boolean setCurrLang(java.lang.String pLangCode)Sets the current language code.

setInitializeMessage(UiXmlInitMessage)public void setInitializeMessage(oracle.apps.cz.common.UiXmlInitMessage msg)

setLoginType(int)public void setLoginType(int loginType)

setName(String)public void setName(java.lang.String name)Sets the context's moniker

CZContext


Package oracle.apps.cz.utilities D-1

DPackage oracle.apps.cz.utilities

Description

Class Summary

Classes

NameValuePair Provides a name-value pair object combination.

NameValuePairSet Implements an object to hold a unique set of name value pairs

NameValuePair

D-2 Oracle Configuration Interface Object (CIO) Developer’s Guide

oracle.apps.cz.utilitiesNameValuePair

Syntaxpublic class NameValuePair extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.utilities.NameValuePair

DescriptionProvides a name-value pair object combination. The name cannot be changed once created.

Member Summary

Constructors

NameValuePair(String) Constructs a name-value pair object without a value.

NameValuePair(String, Object) Constructs a name-value pair object.

Methods

getName() Retrieve the name (key).

getValue() Retrieve the value which can be null.

setValue(Object) Replaces the value for this pair.




NameValuePair


Constructors

NameValuePair(String)public NameValuePair(java.lang.String key)

Constructs a name-value pair object without a value. Key is always stored as a lowercase string, regardless of the case of the key parameter.

Parameters: key - - The String name(key) for this pair.

NameValuePair(String, Object)public NameValuePair(java.lang.String key, java.lang.Object value)

Constructs a name-value pair object. Key is always stored as a lowercase string, regardless of the case of the key parameter.

Parameters: key - - The String name(key) for this pair. String cannot be null or have only whitespace.

value - - The Object for this pair.

Methods

getName()public java.lang.String getName()Retrieve the name (key). Will always be lowercase.

getValue()public java.lang.Object getValue()Retrieve the value which can be null.

setValue(Object)public void setValue(java.lang.Object value)Replaces the value for this pair.

Parameters: The - Object for this pair which can be null.

NameValuePairSet


oracle.apps.cz.utilitiesNameValuePairSet

Syntaxpublic class NameValuePairSet extends java.lang.Object

java.lang.Object|+--oracle.apps.cz.utilities.NameValuePairSet

DescriptionImplements an object to hold a unique set of name value pairs

Member Summary

Constructors

NameValuePairSet()

Methods

Add(NameValuePair) Add a name value pair object to the set

Add(String, Object) Create a NameValuePair and add it to the set using the name and object.

getValueByName(String) Gets value, which may be null, of the name/value pair identified by the "name" input.

iterator() Returns the set of keys for the name value pairs

lookupPairByName(String) Look up a name (key) in the set




NameValuePairSet


Constructors

NameValuePairSet()public NameValuePairSet()

Methods

Add(NameValuePair)public void Add(NameValuePair nvp)

Add a name value pair object to the set

Parameters: nameValuePair - - The NameValuePair object to add. The key will provide the hash.

Add(String, Object)public void Add(java.lang.String name, java.lang.Object value)

Create a NameValuePair and add it to the set using the name and object.

Parameters: name - - The String key of the pair. THe name will provide the hash identifier.

value - - The value object which can be null.

getValueByName(String)public java.lang.Object getValueByName(java.lang.String name)Gets value, which may be null, of the name/value pair identified by the "name" input. Returns null if pair does not exist.

Parameters: name - the name string by which to look up the value

Returns: the value associated with name

iterator()public java.util.Iterator iterator()

NameValuePairSet


Returns the set of keys for the name value pairs

lookupPairByName(String)public NameValuePair lookupPairByName(java.lang.String name)

Look up a name (key) in the set

Parameters: name - - The String to lookup

Returns: The NameValuePair which can be null if the string is not in the set

Index-1

IndexAadd() -

oracle.apps.cz.cio.ComponentSet.add(), B–60Add(NameValuePair) -

oracle.apps.cz.utilities.NameValuePairSet.Add(oracle.apps.cz.utilities.NameValuePair), D–5

Add(String, Object) - oracle.apps.cz.utilities.NameValuePairSet.Add(java.lang.String, java.lang.Object), D–5

addAtpNotification(String) - oracle.apps.cz.cio.BomNode.addAtpNotification(java.lang.String), B–16

addCompSetEventListener(ICompSetEventListener) - oracle.apps.cz.cio.ComponentSet.addCompSetEventListener(oracle.apps.cz.cio.ICompSetEventListener), B–60

addConfigEventListener(ICompSetEventListener) - oracle.apps.cz.cio.ComponentSet.addConfigEventListener(oracle.apps.cz.cio.ICompSetEventListener), B–60

addConfigEventListener(IConfigEventListener) - oracle.apps.cz.cio.Configuration.addConfigEventListener(oracle.apps.cz.cio.IConfigEventListener), B–69

addConfigMessage(String, String) - oracle.apps.cz.cio.Configuration.addConfigMessage(java.lang.String, java.lang.String), B–69

addDiscountedPricingNotification(String) - oracle.apps.cz.cio.PricedNode.addDiscountedPricingNotification(java.lang.String), B–236

addListPricingNotification(String) - oracle.apps.cz.cio.PricedNode.addListPricingN

otification(java.lang.String), B–236addMessageBox(int, String, String) -

oracle.apps.cz.cio.IUserInterface.addMessageBox(int, java.lang.String, java.lang.String), B–173

addUserInterfaceEventListener(IUserInterfaceEventListener) - oracle.apps.cz.cio.IUserInterface.addUserInterfaceEventListener(oracle.apps.cz.cio.IUserInterfaceEventListener), B–173

addUserInterfaceEventListener(String, IUserInterfaceEventListener) - oracle.apps.cz.cio.IUserInterface.addUserInterfaceEventListener(java.lang.String, oracle.apps.cz.cio.IUserInterfaceEventListener),

B–173ALL_FEATURES -

oracle.apps.cz.cio.IRuntimeNode.ALL_FEATURES, B–158

APPLET_CLIENT - oracle.apps.cz.cio.IUserInterface.APPLET_CLIENT, B–173

areOptionsCounted() - oracle.apps.cz.cio.BomNode.areOptionsCounted(), B–16

areOptionsCounted() - oracle.apps.cz.cio.IOptionFeature.areOptionsCounted(), B–148

areOptionsCounted() - oracle.apps.cz.cio.OptionFeature.areOptionsCounted(), B–224

assertionslogic, 3–8

ATP_APPS_107_110 - oracle.apps.cz.cio.Configuration.ATP_APPS_

Index-2

107_110, B–68ATP_CALLBACK -

oracle.apps.cz.cio.Configuration.ATP_CALLBACK, B–68

ATP_DISABLED - oracle.apps.cz.cio.Configuration.ATP_DISABLED, B–68

AtpUnavailableException - oracle.apps.cz.cio.AtpUnavailableException, B–6

AtpUnavailableException(String) - oracle.apps.cz.cio.AtpUnavailableException.AtpUnavailableException(java.lang.String), B–7

AtpUnavailableException(String, Object, Log) - oracle.apps.cz.cio.AtpUnavailableException.AtpUnavailableException(java.lang.String, java.lang.Object, oracle.apps.fnd.common.Log), B–7

autoCommitargument of

Configuration.beginConfigTransaction(), 3–28

usage, 3–9Auto-configuration, 1–2, 1–11, 1–19, 3–11

button, 1–14exceptions, 3–23, 3–34

autoConfigure()usage, 3–11, 3–33

autoConfigure() - oracle.apps.cz.cio.FunctionalCompanion.autoConfigure(), B–108

autoConfigure() - oracle.apps.cz.cio.IFunctionalCompanion.autoConfigure(), B–126

AutoFunctionalCompanionusage, 3–7, 3–8, 3–11, 3–28, 3–30

for initial requests, 3–30AutoFunctionalCompanion -

oracle.apps.cz.cio.AutoFunctionalCompanion,B–8

AutoFunctionalCompanion() - oracle.apps.cz.cio.AutoFunctionalCompanion.AutoFunctionalCompanion(), B–9

BB2B - oracle.apps.cz.cio.Reason.B2B, B–249B2C1 - oracle.apps.cz.cio.Reason.B2C1, B–249B2C2 - oracle.apps.cz.cio.Reason.B2C2, B–249B2C3 - oracle.apps.cz.cio.Reason.B2C3, B–250B2C4 - oracle.apps.cz.cio.Reason.B2C4, B–250B2P1 - oracle.apps.cz.cio.Reason.B2P1, B–250B2P2 - oracle.apps.cz.cio.Reason.B2P2, B–250Base Component

for a Functional Companion, 1–11beginConfigTransaction()

usage, 3–9beginConfigTransaction() -

oracle.apps.cz.cio.Configuration.beginConfigTransaction(), B–70

beginConfigTransaction(boolean) - oracle.apps.cz.cio.Configuration.beginConfigTransaction(boolean), B–70

BOM_CONTROL - oracle.apps.cz.cio.IUserInterfaceNode.BOM_CONTROL, B–188

BOM_MODEL - oracle.apps.cz.cio.IRuntimeNode.BOM_MODEL, B–158

BOM_OPTION_CLASS - oracle.apps.cz.cio.IRuntimeNode.BOM_OPTION_CLASS, B–158

BOM_STD_ITEM - oracle.apps.cz.cio.IRuntimeNode.BOM_STD_ITEM, B–158

BomExplosionException - oracle.apps.cz.cio.BomExplosionException, B–10

BomModel - oracle.apps.cz.cio.BomModel, B–12BomNode - oracle.apps.cz.cio.BomNode, B–13BomOptionClass -

oracle.apps.cz.cio.BomOptionClass, B–25BomStdItem - oracle.apps.cz.cio.BomStdItem, B–28BOOLEAN_FEATURE -

oracle.apps.cz.cio.IRuntimeNode.BOOLEAN_FEATURE, B–158

BooleanFeature - oracle.apps.cz.cio.BooleanFeature, B–31

BUTTON -

Index-3

oracle.apps.cz.cio.IUserInterfaceNode.BUTTON, B–188

CcacheCurrentDiscountedPrice() -

oracle.apps.cz.cio.PricedNode.cacheCurrentDiscountedPrice(), B–236

calculateAtpDate() - oracle.apps.cz.cio.BomNode.calculateAtpDate(),

B–17calculateAtpDates() -

oracle.apps.cz.cio.Configuration.calculateAtpDates(), B–70

calculateListPrices() - oracle.apps.cz.cio.Configuration.calculateListPrices(), B–70

calculateListPrices(List) - oracle.apps.cz.cio.Configuration.calculateListPrices(java.util.List), B–70

canPerform() - oracle.apps.cz.cio.Configuration.canPerform(),

B–71canUndo() -

oracle.apps.cz.cio.Configuration.canUndo(), B–71

CHECK_BOX - oracle.apps.cz.cio.IUserInterfaceNode.CHECK_BOX, B–188

CIOSee Configuration Interface Object

CIO - oracle.apps.cz.cio.CIO, B–34CIO() - oracle.apps.cz.cio.CIO.CIO(), B–35class hierarchy

user interface classes, 2–1CLASSPATH, 1–8clearAtpDate() -

oracle.apps.cz.cio.BomNode.clearAtpDate(), B–17

clearAtpNotifications() - oracle.apps.cz.cio.BomNode.clearAtpNotifications(), B–17

clearConfigMessages() - oracle.apps.cz.cio.Configuration.clearConfigMessages(), B–71

clearDiscountedPrice() - oracle.apps.cz.cio.PricedNode.clearDiscountedPrice(), B–236

clearDiscountedPricingNotifications() - oracle.apps.cz.cio.PricedNode.clearDiscountedPricingNotifications(), B–236

clearListPricingNotifications() - oracle.apps.cz.cio.PricedNode.clearListPricingNotifications(), B–236

clearLogicFile(Object) - oracle.apps.cz.cio.CIO.clearLogicFile(java.lang.Object), B–36

clearLogicFileCache() - oracle.apps.cz.cio.CIO.clearLogicFileCache(),B–36

close() - oracle.apps.cz.cio.CIO.close(), B–36close() -

oracle.apps.cz.cio.Configuration.close(), B–71closeConfiguration()

usage, 3–7closeConfiguration(Configuration) -

oracle.apps.cz.cio.CIO.closeConfiguration(oracle.apps.cz.cio.Configuration), B–36

COMBO_BOX - oracle.apps.cz.cio.IUserInterfaceNode.COMBO_BOX, B–188

commitConfigTransaction(ConfigTransaction) - oracle.apps.cz.cio.Configuration.commitConfigTransaction(oracle.apps.cz.cio.ConfigTransaction), B–71

commitConfigTransaction(transaction)usage, 3–9, 3–21, 3–24

companionSee Functional Companion

COMPANION_FAILURE - oracle.apps.cz.cio.ValidationFailure.COMPANION_FAILURE, B–296

CompanionNode - oracle.apps.cz.cio.CompanionNode, B–45

CompanionRoot - oracle.apps.cz.cio.CompanionRoot, B–48

CompanionRoot(IRuntimeNode) - oracle.apps.cz.cio.CompanionRoot.CompanionRoot(oracle.apps.cz.cio.IRuntimeNode), B–49

CompanionValidationFailure -

Index-4

oracle.apps.cz.cio.CompanionValidationFailure,B–51

CompanionValidationFailure(String, IRuntimeNode, IFunctionalCompanion) - oracle.apps.cz.cio.CompanionValidationFailure.CompanionValidationFailure(java.lang.String, oracle.apps.cz.cio.IRuntimeNode, oracle.apps.cz.cio.IFunctionalCompanion), B–52

Component - oracle.apps.cz.cio.Component, B–53COMPONENT -

oracle.apps.cz.cio.IRuntimeNode.COMPONENT, B–159

COMPONENT_SET - oracle.apps.cz.cio.IRuntimeNode.COMPONENT_SET, B–159

ComponentNode - oracle.apps.cz.cio.ComponentNode, B–56

ComponentSet - oracle.apps.cz.cio.ComponentSet, B–58

ComponentSet.add()usage, 3–12

ComponentSet.delete(component)usage, 3–12

configHeaderIDusage, 3–7

config.jar, 1–8ConfigTransaction -

oracle.apps.cz.cio.ConfigTransaction, B–63configuration

creating initial requests on, 3–28Configuration -

oracle.apps.cz.cio.Configuration, B–64configuration inputs

obtaining list of, 3–8Configuration Interface Object, 1–1

defined, 3–1configuration subschema objects, 3–1configuration-level logic transactions, 3–8configurations, 3–6constants, 4–1contradictions, 3–23, 3–34controls

accessing in user interface, 2–5COUNT_FEATURE -

oracle.apps.cz.cio.IRuntimeNode.COUNT_FEATURE, B–159

CountFeature - oracle.apps.cz.cio.CountFeature, B–85

createCIO() - oracle.apps.cz.cio.Factory.createCIO(), B–99

createConfiguration()usage, 3–6

createConfiguration(int, Context) - oracle.apps.cz.cio.CIO.createConfiguration(int, oracle.apps.fnd.common.Context), B–36

createConfiguration(int, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int) - oracle.apps.cz.cio.CIO.createConfiguration(int, oracle.apps.fnd.common.Context, oracle.apps.cz.cio.IUserInterface,2044452268,B–37

createConfiguration(int, int, Date, Context) - oracle.apps.cz.cio.CIO.createConfiguration(int, int, java.util.Date, oracle.apps.fnd.common.Context), B–38

createConfiguration(int, int, Date, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int) - oracle.apps.cz.cio.CIO.createConfiguration(int, int, java.util.Date, oracle.apps.fnd.common.Context, or24811098, B–39

createConfiguration(String, Context) - oracle.apps.cz.cio.CIO.createConfiguration(java.lang.String, oracle.apps.fnd.common.Context), B–40

createConfiguration(String, Context, IUserInterface, Calendar, Calendar, String, String) - oracle.apps.cz.cio.CIO.createConfiguration(java.lang.String, oracle.apps.fnd.common.Context, oracle.apps.cz.cio.IUserInterface, java.u-1533816725, B–41

createConnection(String, String, String) - oracle.apps.cz.common.CZContext.createConnection(java.lang.String, java.lang.String, java.lang.String), C–4

createContext(String, String, String, String) - oracle.apps.cz.cio.Factory.createContext(java.la

Index-5

ng.String, java.lang.String, java.lang.String, java.lang.String), B–99

createContext(String, String, String, String, String, String, String) - oracle.apps.cz.cio.Factory.createContext(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), B–99

custom user interfacedeveloped with CIO, 1–3

CUSTOM_FAILURE - oracle.apps.cz.cio.ValidationFailure.CUSTOM_FAILURE, B–296

cz3rdpty.jar, 1–8, 1–10CZContext -

oracle.apps.cz.common.CZContext, C–2CZContext(String, String) -

oracle.apps.cz.common.CZContext.CZContext(java.lang.String, java.lang.String), C–3

CZContext(String, String, String, String) - oracle.apps.cz.common.CZContext.CZContext(java.lang.String, java.lang.String, java.lang.String, java.lang.String), C–4

cz.dll, 1–8czjni.dll, 1–8cz.uiservlet.dio_share, 1–18

DDECIMAL_FEATURE -

oracle.apps.cz.cio.IRuntimeNode.DECIMAL_FEATURE, B–159

DECIMAL_FIELD - oracle.apps.cz.cio.IUserInterfaceNode.DECIMAL_FIELD, B–189

DecimalFeature - oracle.apps.cz.cio.DecimalFeature, B–89

DecimalNode - oracle.apps.cz.cio.DecimalNode, B–93

DEFAULT - oracle.apps.cz.cio.Reason.DEFAULT, B–250

delete(Component) - oracle.apps.cz.cio.ComponentSet.delete(oracle.apps.cz.cio.Component), B–60

deleteUserInterfaceEventListener(IUserInterfaceEve

ntListener) - oracle.apps.cz.cio.IUserInterface.deleteUserInterfaceEventListener(oracle.apps.cz.cio.IUserInterfaceEventListener), B–174

deleteUserInterfaceEventListener(String, IUserInterfaceEventListener) - oracle.apps.cz.cio.IUserInterface.deleteUserInterfaceEventListener(java.lang.String, oracle.apps.cz.cio.IUserInterfaceEventListener),

B–174deselect()

usage, 3–17deselect() -

oracle.apps.cz.cio.BomNode.deselect(), B–17deselect() -

oracle.apps.cz.cio.IOption.deselect(), B–146deselect() -

oracle.apps.cz.cio.OptionNode.deselect(), B–232

deselect(IOption) - oracle.apps.cz.cio.IOptionFeature.deselect(oracle.apps.cz.cio.IOption), B–148

deselect(IOption) - oracle.apps.cz.cio.OptionFeatureNode.deselect(oracle.apps.cz.cio.IOption), B–227

DHTML_CLIENT - oracle.apps.cz.cio.IUserInterface.DHTML_CLIENT, B–173

driversJDBC, 1–8

EEffectivityUsageException -

oracle.apps.cz.cio.EffectivityUsageException,B–96

EffectivityUsageException(String) - oracle.apps.cz.cio.EffectivityUsageException.EffectivityUsageException(java.lang.String), B–97

endConfigTransaction(ConfigTransaction) - oracle.apps.cz.cio.Configuration.endConfigTransaction(oracle.apps.cz.cio.ConfigTransaction),B–71

endConfigTransaction(transaction)usage, 3–9

Index-6

equals(Object) - oracle.apps.cz.cio.CompanionValidationFailure.equals(java.lang.Object), B–52

equals(Object) - oracle.apps.cz.cio.LogicalOverridableException.equals(java.lang.Object), B–199

equals(Object) - oracle.apps.cz.cio.RestoreValidationFailure.equals(java.lang.Object), B–260

equals(Object) - oracle.apps.cz.cio.StatusInfo.equals(java.lang.Object), B–282

equals(Object) - oracle.apps.cz.cio.ValidationFailure.equals(java.lang.Object), B–297

eventshandling in user interface, 2–8listeners in user interface, 2–9

invocation, 2–10types in user interface, 2–9

exceptionsfatal, 3–23, 3–34logic, 3–20

FFactory - oracle.apps.cz.cio.Factory, B–98Factory() -

oracle.apps.cz.cio.Factory.Factory(), B–99failed requests

defined, 3–26FALSE

usage, 3–13FALSE - oracle.apps.cz.cio.IState.FALSE, B–167FC_ON_AUTO_CONFIGURE -

oracle.apps.cz.cio.IFunctionalCompanion.FC_ON_AUTO_CONFIGURE, B–126

FC_ON_GENERATE_OUTPUT - oracle.apps.cz.cio.IFunctionalCompanion.FC_ON_GENERATE_OUTPUT, B–126

FC_ON_NEW - oracle.apps.cz.cio.IFunctionalCompanion.FC_ON_NEW, B–126

FC_ON_RESTORE - oracle.apps.cz.cio.IFunctionalCompanion.FC_

ON_RESTORE, B–126FC_ON_SAVE -

oracle.apps.cz.cio.IFunctionalCompanion.FC_ON_SAVE, B–126

FC_ON_VALIDATE - oracle.apps.cz.cio.IFunctionalCompanion.FC_ON_VALIDATE, B–126

finalizeWorkaround() - oracle.apps.cz.cio.Configuration.finalizeWorkaround(), B–71

finalizeWorkaround() - oracle.apps.cz.common.CZContext.finalizeWorkaround(), C–4

frameHasOutputRequest(String) - oracle.apps.cz.cio.IUserInterface.frameHasOutputRequest(java.lang.String), B–174

FuncCompCreationException - oracle.apps.cz.cio.FuncCompCreationException, B–101

FuncCompErrorExceptionusage, 3–23

FuncCompErrorException - oracle.apps.cz.cio.FuncCompErrorException,B–103

FuncCompErrorException(IFunctionalCompanion, String) - oracle.apps.cz.cio.FuncCompErrorException.FuncCompErrorException(oracle.apps.cz.cio.IFunctionalCompanion, java.lang.String), B–104

FuncCompMessageExceptionusage deprecated, 3–23

FuncCompMessageException - oracle.apps.cz.cio.FuncCompMessageException, B–105

FuncCompMessageException(IFunctionalCompanion, String) - oracle.apps.cz.cio.FuncCompMessageException.FuncCompMessageException(oracle.apps.cz.cio.IFunctionalCompanion, java.lang.String), B–106

Functional Companionsand Project Structure, 1–10associated nodes, 1–3association with Components, 1–3defined, 1–1

Index-7

instantiation, 1–3loading errors, 1–3order of execution, 2–4, 2–10recommended development language, 1–3relationship to CIO, 1–3, 1–4, 3–2types, 1–2

FunctionalCompanion - oracle.apps.cz.cio.FunctionalCompanion, B–107

FunctionalCompanion() - oracle.apps.cz.cio.FunctionalCompanion.FunctionalCompanion(), B–108

FunctionalCompanionExceptionrole in handling exceptions, 3–23

FunctionalCompanionException - oracle.apps.cz.cio.FunctionalCompanionException, B–111

FunctionalCompanionException(Throwable) - oracle.apps.cz.cio.FunctionalCompanionException.FunctionalCompanionException(java.lang.Throwable), B–111

FunctionalCompanionException(Throwable, String) - oracle.apps.cz.cio.FunctionalCompanionException.FunctionalCompanionException(java.lang.Throwable, java.lang.String), B–111

GgenerateOutput()

usage, 3–35generateOutput() -

oracle.apps.cz.cio.FunctionalCompanion.generateOutput(), B–108

generateOutput() - oracle.apps.cz.cio.IFunctionalCompanion.generateOutput(), B–127

generateOutput(HttpServletResponse) - oracle.apps.cz.cio.FunctionalCompanion.generateOutput(javax.servlet.http.HttpServletResponse), B–109

generateOutput(HttpServletResponse) - oracle.apps.cz.cio.IFunctionalCompanion.generateOutput(javax.servlet.http.HttpServletResponse), B–127

getAction() - oracle.apps.cz.cio.TransactionException.getAction(), B–292

getActiveModelPath() - oracle.apps.cz.cio.CIO.getActiveModelPath(),B–42

getAltPricingAtpContext() - oracle.apps.cz.cio.Configuration.getAltPricingAtpContext(), B–71

getAppId(String) - oracle.apps.cz.common.CZContext.getAppId(java.lang.String), C–4

getAtpDate() - oracle.apps.cz.cio.BomNode.getAtpDate(), B–17

getAtpDate() - oracle.apps.cz.cio.IAtp.getAtpDate(), B–113

getAtpMode() - oracle.apps.cz.cio.Configuration.getAtpMode(),

B–72getAtpNotifications() -

oracle.apps.cz.cio.BomNode.getAtpNotifications(), B–17

getAtpNotifications() - oracle.apps.cz.cio.IAtp.getAtpNotifications(),B–113

getAvailableNodes(List) - oracle.apps.cz.cio.Configuration.getAvailableNodes(java.util.List), B–72

getAvailableOptions() - oracle.apps.cz.cio.OptionFeatureNode.getAvailableOptions(), B–227

getBoolean(String) - oracle.apps.cz.cio.CompanionNode.getBoolean(java.lang.String), B–46

getBoolean(String, boolean) - oracle.apps.cz.cio.CompanionNode.getBoolean(java.lang.String, boolean), B–46

getBooleanValue() - oracle.apps.cz.cio.Property.getBooleanValue(),

B–242getCause()

usage, 3–20getCause() -

oracle.apps.cz.cio.LogicalException.getCause(),

Index-8

B–197getChildByID(int) -

oracle.apps.cz.cio.IRuntimeNode.getChildByID(int), B–160

getChildByID(int) - oracle.apps.cz.cio.RuntimeNode.getChildByID(int), B–263

getChildByInstanceNumber(int) - oracle.apps.cz.cio.ComponentSet.getChildByInstanceNumber(int), B–60

getChildByName(String) - oracle.apps.cz.cio.IRuntimeNode.getChildByName(java.lang.String), B–160

getChildByName(String) - oracle.apps.cz.cio.RuntimeNode.getChildByName(java.lang.String), B–263

getChildByPersistentID(int) - oracle.apps.cz.cio.IRuntimeNode.getChildByPersistentID(int), B–160

getChildByPersistentID(int) - oracle.apps.cz.cio.RuntimeNode.getChildByPersistentID(int), B–264

getChildComponentNodes() - oracle.apps.cz.cio.ComponentNode.getChildComponentNodes(), B–57

getChildComponentNodes() - oracle.apps.cz.cio.ComponentSet.getChildComponentNodes(), B–60

getChildren() - oracle.apps.cz.cio.CompanionNode.getChildren(), B–46

getChildren() - oracle.apps.cz.cio.IRuntimeNode.getChildren(),

B–160getChildren() -

oracle.apps.cz.cio.RuntimeNode.getChildren(),B–264

getChildrenByType(int) - oracle.apps.cz.cio.IRuntimeNode.getChildrenByType(int), B–160

getChildrenByType(int) - oracle.apps.cz.cio.RuntimeNode.getChildrenByType(int), B–264

getCIO()usage, 3–7

getCIO() - oracle.apps.cz.cio.Configuration.getCIO(), B–72

getCompanion() - oracle.apps.cz.cio.CompanionValidationFailure.getCompanion(), B–52

getComponentCode() - oracle.apps.cz.cio.BomNode.getComponentCode(), B–17

getComponentCode() - oracle.apps.cz.cio.IBomItem.getComponentCode(), B–115

getConfigHeaderCheckoutUser() - oracle.apps.cz.cio.Configuration.getConfigHeaderCheckoutUser(), B–72

getConfigHeaderDateCreated() - oracle.apps.cz.cio.Configuration.getConfigHeaderDateCreated(), B–72

getConfigHeaderDescription() - oracle.apps.cz.cio.Configuration.getConfigHeaderDescription(), B–73

getConfigHeaderEffectiveFrom() - oracle.apps.cz.cio.Configuration.getConfigHeaderEffectiveFrom(), B–73

getConfigHeaderEffectiveTo() - oracle.apps.cz.cio.Configuration.getConfigHeaderEffectiveTo(), B–73

getConfigHeaderId() - oracle.apps.cz.cio.Configuration.getConfigHeaderId(), B–73

getConfigHeaderLastUpdateDate() - oracle.apps.cz.cio.Configuration.getConfigHeaderLastUpdateDate(), B–74

getConfigHeaderName() - oracle.apps.cz.cio.Configuration.getConfigHeaderName(), B–74

getConfigHeaderNote() - oracle.apps.cz.cio.Configuration.getConfigHeaderNote(), B–74

getConfigHeaderNumberQuotesUsedIn() - oracle.apps.cz.cio.Configuration.getConfigHeaderNumberQuotesUsedIn(), B–74

getConfigHeaderOpportunityHeaderId() - oracle.apps.cz.cio.Configuration.getConfigHeaderOpportunityHeaderId(), B–74

Index-9

getConfigHeaderRevision() - oracle.apps.cz.cio.Configuration.getConfigHeaderRevision(), B–75

getConfigHeaderStatus() - oracle.apps.cz.cio.Configuration.getConfigHeaderStatus(), B–75

getConfigHeaderUiDefinitionId() - oracle.apps.cz.cio.Configuration.getConfigHeaderUiDefinitionId(), B–75

getConfigHeaderUserIdCreated() - oracle.apps.cz.cio.Configuration.getConfigHeaderUserIdCreated(), B–75

getConfiguration()usage, 3–11

getConfiguration() - oracle.apps.cz.cio.IRuntimeNode.getConfiguration(), B–161

getConfiguration() - oracle.apps.cz.cio.RuntimeNode.getConfiguration(), B–264

getContext() - oracle.apps.cz.cio.Configuration.getContext(),B–75

getControls() - oracle.apps.cz.cio.IUserInterfaceScreen.getControls(), B–193

getCount() - oracle.apps.cz.cio.ComponentSet.getCount(),B–60

getCount() - oracle.apps.cz.cio.ICount.getCount(), B–119

getCount() - oracle.apps.cz.cio.StateCountNode.getCount(),

B–275getCurrencyFormat() -

oracle.apps.cz.cio.Configuration.getCurrencyFormat(), B–75

getCurrentScreen() - oracle.apps.cz.cio.IUserInterface.getCurrentScreen(), B–174

getCurrLangCode() - oracle.apps.cz.common.CZContext.getCurrLangCode(), C–4

getCurrLangInfo() - oracle.apps.cz.common.CZContext.getCurrLan

gInfo(), C–5getDatabaseID() -

oracle.apps.cz.cio.IAtp.getDatabaseID(), B–113getDatabaseID() -

oracle.apps.cz.cio.IPrice.getDatabaseID(), B–152

getDatabaseID() - oracle.apps.cz.cio.IRuntimeNode.getDatabaseID(), B–161

getDatabaseID() - oracle.apps.cz.cio.RuntimeNode.getDatabaseID(), B–264

getDbOwner() - oracle.apps.cz.common.CZContext.getDbOwner(), C–5

getDecimalCount() - oracle.apps.cz.cio.ICount.getDecimalCount(),B–120

getDecimalCount() - oracle.apps.cz.cio.StateCountNode.getDecimalCount(), B–275

getDecimalDefaultQuantity() - oracle.apps.cz.cio.BomNode.getDecimalDefaultQuantity(), B–18

getDecimalMaxQuantity() - oracle.apps.cz.cio.BomNode.getDecimalMaxQuantity(), B–18

getDecimalMaxQuantity() - oracle.apps.cz.cio.IBomItem.getDecimalMaxQuantity(), B–115

getDecimalMinQuantity() - oracle.apps.cz.cio.BomNode.getDecimalMinQuantity(), B–18

getDecimalMinQuantity() - oracle.apps.cz.cio.IBomItem.getDecimalMinQuantity(), B–116

getDecimalValue()usage, 3–15

getDecimalValue() - oracle.apps.cz.cio.IReadOnlyDecimal.getDecimalValue(), B–154

getDecimalValue() - oracle.apps.cz.cio.Property.getDecimalValue(),

B–242getDecimalValue() -

Index-10

oracle.apps.cz.cio.ReadOnlyDecimalNode.getDecimalValue(), B–246

getDefaultAffectedNodes() - oracle.apps.cz.cio.Configuration.getDefaultAffectedNodes(), B–76

getDefaultQuantity() - oracle.apps.cz.cio.BomNode.getDefaultQuantity(), B–18

getDeltaListIterator() - oracle.apps.cz.cio.Configuration.getDeltaListIterator(), B–76

getDescription() - oracle.apps.cz.cio.FunctionalCompanion.getDescription(), B–109

getDescription() - oracle.apps.cz.cio.IFunctionalCompanion.getDescription(), B–127

getDescription() - oracle.apps.cz.cio.IRuntimeNode.getDescription(), B–161

getDescription() - oracle.apps.cz.cio.Property.getDescription(), B–242

getDescription() - oracle.apps.cz.cio.RuntimeNode.getDescription(), B–265

getDescrption() - oracle.apps.cz.cio.FuncCompCreationException.getDescrption(), B–102

getDiscountedPrice() - oracle.apps.cz.cio.BomNode.getDiscountedPrice(), B–18

getDiscountedPrice() - oracle.apps.cz.cio.IPrice.getDiscountedPrice(),

B–152getDiscountedPrice() -

oracle.apps.cz.cio.PricedNode.getDiscountedPrice(), B–236

getDiscountedPricingNotifications() - oracle.apps.cz.cio.IPrice.getDiscountedPricingNotifications(), B–152

getDiscountedPricingNotifications() - oracle.apps.cz.cio.PricedNode.getDiscountedPricingNotifications(), B–237

getDouble(String) -

oracle.apps.cz.cio.CompanionNode.getDouble(java.lang.String), B–46

getDouble(String, double) - oracle.apps.cz.cio.CompanionNode.getDouble(java.lang.String, double), B–46

getEffectiveDate() - oracle.apps.cz.cio.Configuration.getEffectiveDate(), B–76

getEffectiveUsageID() - oracle.apps.cz.cio.Configuration.getEffectiveUsageID(), B–76

getEnvStore() - oracle.apps.cz.common.CZContext.getEnvStore(), C–5

getExplosionDate() - oracle.apps.cz.cio.BomExplosionException.getExplosionDate(), B–11

getExtendedPrice() - oracle.apps.cz.cio.IPrice.getExtendedPrice(), B–152

getExtendedPrice() - oracle.apps.cz.cio.PricedNode.getExtendedPrice(), B–237

getFeature() - oracle.apps.cz.cio.SelectionNotMutexedException.getFeature(), B–272

getFeature(String) - oracle.apps.cz.cio.CompanionNode.getFeature(java.lang.String), B–46

getFeatureIdentifier() - oracle.apps.cz.cio.CompanionRoot.getFeatureIdentifier(), B–49

getFileName() - oracle.apps.cz.cio.IUserInterfaceImage.getFileName(), B–184

getFndMessageString(Message) - oracle.apps.cz.cio.Reason.getFndMessageString(oracle.apps.fnd.common.Message), B–251

getFuncCompByID(int) - oracle.apps.cz.cio.Component.getFuncCompByID(int), B–54

getFuncCompByID(int) - oracle.apps.cz.cio.RuntimeNode.getFuncCompByID(int), B–265

getFuncCompByName(String) -

Index-11

oracle.apps.cz.cio.Component.getFuncCompByName(java.lang.String), B–54

getFuncCompByName(String) - oracle.apps.cz.cio.RuntimeNode.getFuncCompByName(java.lang.String), B–265

getFunctionalCompanions()usage, 3–12

getFunctionalCompanions() - oracle.apps.cz.cio.Component.getFunctionalCompanions(), B–55

getFunctionalCompanions() - oracle.apps.cz.cio.RuntimeNode.getFunctionalCompanions(), B–265

getID() - oracle.apps.cz.cio.FuncCompCreationException.getID(), B–102

getID() - oracle.apps.cz.cio.FunctionalCompanion.getID(), B–109

getID() - oracle.apps.cz.cio.IFunctionalCompanion.getID(), B–127

getID() - oracle.apps.cz.cio.NoSuchChildException.getID(), B–214

getInitializeMessage() - oracle.apps.cz.common.CZContext.getInitializeMessage(), C–5

getInitParameters()usage, 3–8

getInitParameters() - oracle.apps.cz.cio.Configuration.getInitParameters(), B–76

getInput() - oracle.apps.cz.cio.IncompatibleInputException.getInput(), B–134

getInput() - oracle.apps.cz.cio.RestoreValidationFailure.getInput(), B–260

getInstance() - oracle.apps.cz.common.CZContext.getInstance(), C–5

getInstanceNumber() - oracle.apps.cz.cio.Component.getInstanceNumber(), B–55

getInstanceType() - oracle.apps.cz.cio.Component.getInstanceType(), B–55

getInteger(String) - oracle.apps.cz.cio.CompanionNode.getInteger(java.lang.String), B–47

getInteger(String, int) - oracle.apps.cz.cio.CompanionNode.getInteger(java.lang.String, int), B–47

getIntValue()usage, 3–15

getIntValue() - oracle.apps.cz.cio.CountFeature.getIntValue(),

B–87getIntValue() -

oracle.apps.cz.cio.IInteger.getIntValue(), B–129

getIntValue() - oracle.apps.cz.cio.IntegerNode.getIntValue(),B–143

getIntValue() - oracle.apps.cz.cio.Property.getIntValue(), B–242

getInventoryItemId() - oracle.apps.cz.cio.BomExplosionException.getInventoryItemId(), B–11

getInventoryItemId() - oracle.apps.cz.cio.BomNode.getInventoryItemId(), B–19

getInventoryItemId() - oracle.apps.cz.cio.IBomItem.getInventoryItemId(), B–116

getItemKey() - oracle.apps.cz.cio.BomNode.getItemKey(), B–19

getItemKey() - oracle.apps.cz.cio.IAtp.getItemKey(), B–113

getItemKey() - oracle.apps.cz.cio.IPrice.getItemKey(), B–152

getItemKey() - oracle.apps.cz.cio.PricedNode.getItemKey(), B–237

getJDBCConnection() - oracle.apps.cz.common.CZContext.getJDBCConnection(), C–5

Index-12

getJDBCConnection(Object) - oracle.apps.cz.common.CZContext.getJDBCConnection(java.lang.Object), C–5

getLangCode(String) - oracle.apps.cz.common.CZContext.getLangCode(java.lang.String), C–5

getLangInfo(String, String) - oracle.apps.cz.common.CZContext.getLangInfo(java.lang.String, java.lang.String), C–5

getLastContradiction() - oracle.apps.cz.cio.Configuration.getLastContradiction(), B–76

getListPrice() - oracle.apps.cz.cio.BomNode.getListPrice(), B–19

getListPrice() - oracle.apps.cz.cio.IPrice.getListPrice(), B–152

getListPrice() - oracle.apps.cz.cio.PricedNode.getListPrice(), B–237

getListPricingNotifications() - oracle.apps.cz.cio.IPrice.getListPricingNotifications(), B–152

getListPricingNotifications() - oracle.apps.cz.cio.PricedNode.getListPricingNotifications(), B–237

getLogicException() - oracle.apps.cz.cio.LogicalRuntimeException.getLogicException(), B–201

getLoginType() - oracle.apps.cz.common.CZContext.getLoginType(), C–6

getMax() - oracle.apps.cz.cio.ComponentSet.getMax(), B–60

getMax() - oracle.apps.cz.cio.CountFeature.getMax(), B–87

getMax() - oracle.apps.cz.cio.DecimalFeature.getMax(), B–91

getMax() - oracle.apps.cz.cio.IDecimalMinMax.getMax(),B–123

getMax() -

oracle.apps.cz.cio.IIntegerMinMax.getMax(),B–131

getMax() - oracle.apps.cz.cio.IntegerFeature.getMax(), B–141

getMaxQuantity() - oracle.apps.cz.cio.BomNode.getMaxQuantity(),

B–20getMaxQuantity() -

oracle.apps.cz.cio.IBomItem.getMaxQuantity(),B–116

getMaxSelected()usage, 3–13

getMaxSelected() - oracle.apps.cz.cio.IOptionFeature.getMaxSelected(), B–148

getMaxSelected() - oracle.apps.cz.cio.OptionFeatureNode.getMaxSelected(), B–228

getMessage()usage, 3–20

getMessage() - oracle.apps.cz.cio.LogicalException.getMessage(), B–197

getMessage() - oracle.apps.cz.cio.ValidationFailure.getMessage(), B–297

getMessage(String) - oracle.apps.cz.cio.ValidationFailure.getMessage(java.lang.String), B–297

getMessageHeader() - oracle.apps.cz.cio.LogicalException.getMessageHeader(), B–197

getMessageHeader(String) - oracle.apps.cz.cio.LogicalException.getMessageHeader(java.lang.String), B–197

getMin() - oracle.apps.cz.cio.ComponentSet.getMin(), B–61

getMin() - oracle.apps.cz.cio.CountFeature.getMin(), B–87

getMin() - oracle.apps.cz.cio.DecimalFeature.getMin(), B–91

Index-14

oracle.apps.cz.cio.IUserInterface.getNode(oracle.apps.cz.cio.IRuntimeNode, oracle.apps.cz.cio.IUserInterfaceScreen), B–174

getNode(String) - oracle.apps.cz.cio.IUserInterfaceScreen.getNode(java.lang.String), B–193

getNode(String, IUserInterfaceScreen) - oracle.apps.cz.cio.IUserInterface.getNode(java.lang.String, oracle.apps.cz.cio.IUserInterfaceScreen), B–175

getNodeClass(String) - oracle.apps.cz.cio.CompanionRoot.getNodeClass(java.lang.String), B–49

getNodeFromPath(String) - oracle.apps.cz.cio.Configuration.getNodeFromPath(java.lang.String), B–76

getNodeIdentifier() - oracle.apps.cz.cio.CompanionRoot.getNodeIdentifier(), B–49

getNumericValue() - oracle.apps.cz.cio.Request.getNumericValue(),

B–254getOldDiscountedPrice() -

oracle.apps.cz.cio.PricedNode.getOldDiscountedPrice(), B–237

getOrganizationId() - oracle.apps.cz.cio.BomExplosionException.getOrganizationId(), B–11

getOrganizationId() - oracle.apps.cz.cio.BomNode.getOrganizationId(), B–20

getOrganizationId() - oracle.apps.cz.cio.IBomItem.getOrganizationId(), B–116

getOriginalScreen() - oracle.apps.cz.cio.IUserInterface.getOriginalScreen(), B–175

getParent() - oracle.apps.cz.cio.IRuntimeNode.getParent(),B–161

getParent() - oracle.apps.cz.cio.NoSuchChildException.getParent(), B–214

getParent() - oracle.apps.cz.cio.RuntimeNode.getParent(), B–265

getPathForNode(IRuntimeNode) - oracle.apps.cz.cio.Configuration.getPathForNode(oracle.apps.cz.cio.IRuntimeNode), B–77

getPersistentID() - oracle.apps.cz.cio.IRuntimeNode.getPersistentID(), B–162

getPersistentID() - oracle.apps.cz.cio.RuntimeNode.getPersistentID(), B–266

getPosition() - oracle.apps.cz.cio.Component.getPosition(), B–55

getPricingMode() - oracle.apps.cz.cio.Configuration.getPricingMode(), B–77

getPricingNotifications() - oracle.apps.cz.cio.IPrice.getPricingNotifications(), B–153

getPricingNotifications() - oracle.apps.cz.cio.PricedNode.getPricingNotifications(), B–237

getPricingValue() - oracle.apps.cz.cio.PricedNode.getPricingValue(), B–238

getPrimaryUomCode() - oracle.apps.cz.cio.BomNode.getPrimaryUomCode(), B–20

getPrimaryUomCode() - oracle.apps.cz.cio.IBomItem.getPrimaryUomCode(), B–116

getProgString() - oracle.apps.cz.cio.FuncCompCreationException.getProgString(), B–102

getProjectID() - oracle.apps.cz.cio.Configuration.getProjectID(),

B–77getProperties()

usage, 3–16getProperties() -

oracle.apps.cz.cio.IRuntimeNode.getProperties(), B–162

getProperties() -

Index-15

oracle.apps.cz.cio.RuntimeNode.getProperties(), B–266

getPropertyByName()usage, 3–16

getPropertyByName(String) - oracle.apps.cz.cio.IRuntimeNode.getPropertyByName(java.lang.String), B–162

getPropertyByName(String) - oracle.apps.cz.cio.RuntimeNode.getPropertyByName(java.lang.String), B–266

getReasons()usage, 3–20

getReasons() - oracle.apps.cz.cio.LogicalException.getReasons(), B–197

getReferringOrDatabaseID() - oracle.apps.cz.cio.ComponentNode.getReferringOrDatabaseID(), B–57

getReferringOrDatabaseID() - oracle.apps.cz.cio.ComponentSet.getReferringOrDatabaseID(), B–61

getReferringOrPersistentID() - oracle.apps.cz.cio.ComponentNode.getReferringOrPersistentID(), B–57

getReferringOrPersistentID() - oracle.apps.cz.cio.ComponentSet.getReferringOrPersistentID(), B–61

getRootBomModel() - oracle.apps.cz.cio.Configuration.getRootBomModel(), B–77

getRootBomModel(int, int) - oracle.apps.cz.cio.Configuration.getRootBomModel(int, int), B–77

getRootComponent() - oracle.apps.cz.cio.Configuration.getRootComponent(), B–77

getRootComponentDbId() - oracle.apps.cz.cio.Configuration.getRootComponentDbId(), B–78

getRootComponentPersistentId() - oracle.apps.cz.cio.Configuration.getRootComponentPersistentId(), B–78

getRootNodes() - oracle.apps.cz.cio.CompanionRoot.getRootNodes(), B–50

getRuntimeID() - oracle.apps.cz.cio.IRuntimeNode.getRuntimeID(), B–162

getRuntimeID() - oracle.apps.cz.cio.RuntimeNode.getRuntimeID(), B–266

getRuntimeNode() - oracle.apps.cz.cio.FunctionalCompanion.getRuntimeNode(), B–109

getRuntimeNode() - oracle.apps.cz.cio.IFunctionalCompanion.getRuntimeNode(), B–127

getRuntimeNode() - oracle.apps.cz.cio.IUserInterfaceNode.getRuntimeNode(), B–190

getRuntimeNode() - oracle.apps.cz.cio.Request.getRuntimeNode(),

B–254getRuntimeNode(int) -

oracle.apps.cz.cio.Configuration.getRuntimeNode(int), B–78

getRuntimeNodes() - oracle.apps.cz.cio.Configuration.getRuntimeNodes(), B–78

getScreen() - oracle.apps.cz.cio.IUserInterfaceControl.getScreen(), B–178

getSelectableChildren() - oracle.apps.cz.cio.IOptionFeature.getSelectableChildren(), B–149

getSelectableChildren() - oracle.apps.cz.cio.OptionFeatureNode.getSelectableChildren(), B–228

getSelectedItems()usage, 3–24

getSelectedItems() - oracle.apps.cz.cio.Configuration.getSelectedItems(), B–78

getSelectedOption()usage, 3–17

getSelectedOption() - oracle.apps.cz.cio.IOptionFeature.getSelectedOption(), B–149

getSelectedOption() - oracle.apps.cz.cio.OptionFeatureNode.getSelect

Index-16

edOption(), B–228getSelectedOptions() -

oracle.apps.cz.cio.IOptionFeature.getSelectedOptions(), B–149

getSelectedOptions() - oracle.apps.cz.cio.OptionFeatureNode.getSelectedOptions(), B–228

getSelectionLineID() - oracle.apps.cz.cio.IRuntimeNode.getSelectionLineID(), B–162

getSelectionLineID() - oracle.apps.cz.cio.RuntimeNode.getSelectionLineID(), B–266

getSessionManager() - oracle.apps.cz.common.CZContext.getSessionManager(), C–6

getState()usage, 3–14

getState() - oracle.apps.cz.cio.BomNode.getState(), B–20

getState() - oracle.apps.cz.cio.IState.getState(), B–168

getState() - oracle.apps.cz.cio.StateNode.getState(), B–278

getStatus() - oracle.apps.cz.cio.StatusInfo.getStatus(), B–283

getString(String) - oracle.apps.cz.cio.CompanionNode.getString(java.lang.String), B–47

getString(String, String) - oracle.apps.cz.cio.CompanionNode.getString(java.lang.String, java.lang.String), B–47

getStringDeltaList() - oracle.apps.cz.cio.Configuration.getStringDeltaList(), B–79

getStringValue()usage, 3–16

getStringValue() - oracle.apps.cz.cio.Property.getStringValue(), B–243

getTextValue() - oracle.apps.cz.cio.IText.getTextValue(), B–170

getTextValue() - oracle.apps.cz.cio.TextNode.getTextValue(), B–287

getTotalDiscountedPrice() - oracle.apps.cz.cio.Configuration.getTotalDiscountedPrice(), B–79

getTotalListPrice() - oracle.apps.cz.cio.Configuration.getTotalListPrice(), B–79

getTransactionDepth() - oracle.apps.cz.cio.Configuration.getTransactionDepth(), B–79

getType()usage, 3–21

getType() - oracle.apps.cz.cio.BomModel.getType(), B–12

getType() - oracle.apps.cz.cio.BomOptionClass.getType(),B–27

getType() - oracle.apps.cz.cio.BomStdItem.getType(), B–30

getType() - oracle.apps.cz.cio.BooleanFeature.getType(), B–32

getType() - oracle.apps.cz.cio.ComponentSet.getType(), B–61

getType() - oracle.apps.cz.cio.CountFeature.getType(), B–88

getType() - oracle.apps.cz.cio.DecimalFeature.getType(),B–91

getType() - oracle.apps.cz.cio.IntegerFeature.getType(), B–141

getType() - oracle.apps.cz.cio.IRuntimeNode.getType(), B–163

getType() - oracle.apps.cz.cio.IUserInterface.getType(), B–175

getType() - oracle.apps.cz.cio.IUserInterfaceNode.getType(), B–190

getType() - oracle.apps.cz.cio.OptionFeature.getType(), B–

Index-17

224getType() -

oracle.apps.cz.cio.Option.getType(), B–221getType() -

oracle.apps.cz.cio.Reason.getType(), B–252getType() -

oracle.apps.cz.cio.Resource.getType(), B–258getType() -

oracle.apps.cz.cio.RuntimeNode.getType(), B–267

getType() - oracle.apps.cz.cio.TextFeature.getType(), B–285

getType() - oracle.apps.cz.cio.Total.getType(), B–290

getType() - oracle.apps.cz.cio.ValidationFailure.getType(),

B–297getUiCaption() -

oracle.apps.cz.cio.IUserInterfaceNode.getUiCaption(), B–191

getUiNode() - oracle.apps.cz.cio.IUserInterfaceEvent.getUiNode(), B–181

getUiSessionID() - oracle.apps.cz.cio.IUserInterface.getUiSessionID(), B–175

getUnit() - oracle.apps.cz.cio.Property.getUnit(), B–243

getUnsatisfiedItems()usage, 3–24

getUnsatisfiedItems() - oracle.apps.cz.cio.Configuration.getUnsatisfiedItems(), B–79

getUomCode() - oracle.apps.cz.cio.BomNode.getUomCode(), B–21

getUomCode() - oracle.apps.cz.cio.IAtp.getUomCode(), B–113

getUomCode() - oracle.apps.cz.cio.IPrice.getUomCode(), B–153

getUomCode() - oracle.apps.cz.cio.PricedNode.getUomCode(),

B–238getUrl() -

oracle.apps.cz.common.CZContext.getUrl(), C–6

getUser() - oracle.apps.cz.common.CZContext.getUser(),C–6

getUserInterface() - oracle.apps.cz.cio.Configuration.getUserInterface(), B–79

getUserInterface() - oracle.apps.cz.cio.IUserInterfaceEvent.getUserInterface(), B–181

getUserRequests() - oracle.apps.cz.cio.Configuration.getUserRequests(), B–80

getValidationFailures()usage, 3–16, 3–24

getValidationFailures() - oracle.apps.cz.cio.Configuration.getValidationFailures(), B–80

getValue() - oracle.apps.cz.cio.Request.getValue(), B–254

getValue() - oracle.apps.cz.utilities.NameValuePair.getValue(), D–3

getValueByName(String) - oracle.apps.cz.utilities.NameValuePairSet.getValueByName(java.lang.String), D–5

HhandleUserInterfaceEvent(IUserInterfaceEvent) -

oracle.apps.cz.cio.IUserInterfaceEventListener.handleUserInterfaceEvent(oracle.apps.cz.cio.IUserInterfaceEvent), B–182

hasBooleanValue() - oracle.apps.cz.cio.Property.hasBooleanValue(),

B–243hasChildren() -

oracle.apps.cz.cio.IRuntimeNode.hasChildren(),B–163

hasChildren() - oracle.apps.cz.cio.RuntimeNode.hasChildren(),

B–267hasCount() -

oracle.apps.cz.cio.IRuntimeNode.hasCount(),

Index-18

B–163hasCount() -

oracle.apps.cz.cio.RuntimeNode.hasCount(), B–267

hasDecimalValue() - oracle.apps.cz.cio.IRuntimeNode.hasDecimalValue(), B–163

hasDecimalValue() - oracle.apps.cz.cio.Property.hasDecimalValue(),

B–243hasDecimalValue() -

oracle.apps.cz.cio.RuntimeNode.hasDecimalValue(), B–267

hasDefaultQuantity() - oracle.apps.cz.cio.BomNode.hasDefaultQuantity(), B–21

hasDefaultValue() - oracle.apps.cz.cio.Property.hasDefaultValue(),

B–243hasDescription() -

oracle.apps.cz.cio.IRuntimeNode.hasDescription(), B–163

hasDescription() - oracle.apps.cz.cio.RuntimeNode.hasDescription(), B–267

hasDiscountedPrice() - oracle.apps.cz.cio.PricedNode.hasDiscountedPrice(), B–238

hasFeature(String) - oracle.apps.cz.cio.CompanionNode.hasFeature(java.lang.String), B–47

hashCode() - oracle.apps.cz.cio.CompanionValidationFailure.hashCode(), B–52

hashCode() - oracle.apps.cz.cio.RestoreValidationFailure.hashCode(), B–260

hashCode() - oracle.apps.cz.cio.StatusInfo.hashCode(), B–283

hasIntegerValue() - oracle.apps.cz.cio.Property.hasIntegerValue(),B–243

hasIntegerValue() - oracle.apps.cz.cio.RuntimeNode.hasIntegerValu

e(), B–267hasListPrice() -

oracle.apps.cz.cio.PricedNode.hasListPrice(),B–238

hasMax()usage, 3–12

hasMax() - oracle.apps.cz.cio.ComponentSet.hasMax(), B–61

hasMax() - oracle.apps.cz.cio.CountFeature.hasMax(), B–88

hasMax() - oracle.apps.cz.cio.DecimalFeature.hasMax(), B–91

hasMax() - oracle.apps.cz.cio.IDecimalMinMax.hasMax(),

B–123hasMax() -

oracle.apps.cz.cio.IIntegerMinMax.hasMax(),B–131

hasMax() - oracle.apps.cz.cio.IntegerFeature.hasMax(), B–141

hasMaxQuantity() - oracle.apps.cz.cio.BomNode.hasMaxQuantity(),

B–21hasMaxQuantity() -

oracle.apps.cz.cio.IBomItem.hasMaxQuantity(),B–116

hasMaxSelected()usage, 3–13

hasMaxSelected() - oracle.apps.cz.cio.IOptionFeature.hasMaxSelected(), B–149

hasMaxSelected() - oracle.apps.cz.cio.OptionFeatureNode.hasMaxSelected(), B–228

hasMessageBoxRequest() - oracle.apps.cz.cio.IUserInterface.hasMessageBoxRequest(), B–176

hasMin()usage, 3–12

hasMin() - oracle.apps.cz.cio.ComponentSet.hasMin(), B–

Index-19

62hasMin() -

oracle.apps.cz.cio.CountFeature.hasMin(), B–88

hasMin() - oracle.apps.cz.cio.DecimalFeature.hasMin(), B–92

hasMin() - oracle.apps.cz.cio.IDecimalMinMax.hasMin(),B–124

hasMin() - oracle.apps.cz.cio.IIntegerMinMax.hasMin(),B–132

hasMin() - oracle.apps.cz.cio.IntegerFeature.hasMin(), B–141

hasMinQuantity() - oracle.apps.cz.cio.BomNode.hasMinQuantity(),

B–22hasMinQuantity() -

oracle.apps.cz.cio.IBomItem.hasMinQuantity(),B–116

hasMinSelected()usage, 3–13

hasMinSelected() - oracle.apps.cz.cio.IOptionFeature.hasMinSelected(), B–149

hasMinSelected() - oracle.apps.cz.cio.OptionFeatureNode.hasMinSelected(), B–229

hasSelectionLineID() - oracle.apps.cz.cio.IRuntimeNode.hasSelectionLineID(), B–163

hasSelectionLineID() - oracle.apps.cz.cio.RuntimeNode.hasSelectionLineID(), B–268

hasState() - oracle.apps.cz.cio.IRuntimeNode.hasState(), B–163

hasState() - oracle.apps.cz.cio.RuntimeNode.hasState(), B–268

hasStringValue() - oracle.apps.cz.cio.Property.hasStringValue(),B–243

hasTextValue() - oracle.apps.cz.cio.IRuntimeNode.hasTextValue(), B–163

hasTextValue() - oracle.apps.cz.cio.RuntimeNode.hasTextValue(), B–268

hasValue() - oracle.apps.cz.cio.Property.hasValue(), B–243

HTMLdisplaying custom HTML output in user

interface, 2–8

IIAtp - oracle.apps.cz.cio.IAtp, B–112IBomItem - oracle.apps.cz.cio.IBomItem, B–114ICompSetEventListener -

oracle.apps.cz.cio.ICompSetEventListener, B–117

IConfigEventListener - oracle.apps.cz.cio.IConfigEventListener, B–118

ICount - oracle.apps.cz.cio.ICount, B–119IDecimal - oracle.apps.cz.cio.IDecimal, B–121IDecimalMinMax -

oracle.apps.cz.cio.IDecimalMinMax, B–123IFunctionalCompanion, 3–11, 3–12, 3–31, 3–33,

3–34, 3–36standard interface methods, 1–3

IFunctionalCompanion - oracle.apps.cz.cio.IFunctionalCompanion, B–125

IInteger - oracle.apps.cz.cio.IInteger, B–129IIntegerMinMax -

oracle.apps.cz.cio.IIntegerMinMax, B–131IMAGE -

oracle.apps.cz.cio.IUserInterfaceNode.IMAGE,B–189

imagesaccessing in user interface, 2–6changing in user interface, 2–7

IncompatibleInputException - oracle.apps.cz.cio.IncompatibleInputException,

B–133IneffectiveUiNodeException -

Index-20

oracle.apps.cz.cio.IneffectiveUiNodeException,B–135

IneffectiveUiNodeException(IUserInterfaceNode, Configuration) - oracle.apps.cz.cio.IneffectiveUiNodeException.IneffectiveUiNodeException(oracle.apps.cz.cio.IUserInterfaceNode, oracle.apps.cz.cio.Configuration), B–136

initial request "mode", 3–29initial requests, 3–29

defined, 3–26, 3–28effect of restoring, 3–29effect of saving, 3–29limitation

user requests, 3–30limitations, 3–29, 3–30

restoring, 3–30with Components, 3–30

prohibition on overriding, 3–30specifying, 3–28, 3–29usage, 3–12

with transactions, 3–10Initialization, 3–12initialization message, 2–2initialization parameters

obtaining list of, 3–8initialize()

usage, 3–12, 3–31initialize(IRuntimeNode, String, String, int) -

oracle.apps.cz.cio.FunctionalCompanion.initialize(oracle.apps.cz.cio.IRuntimeNode, java.lang.String, java.lang.String, int), B–110

initialize(IRuntimeNode, String, String, int) - oracle.apps.cz.cio.IFunctionalCompanion.initialize(oracle.apps.cz.cio.IRuntimeNode, java.lang.String, java.lang.String, int), B–127

InitialRequestException - oracle.apps.cz.cio.InitialRequestException, B–137

InitialRequestException() - oracle.apps.cz.cio.InitialRequestException.InitialRequestException(), B–138

InitialRequestException(String) - oracle.apps.cz.cio.InitialRequestException.InitialRequestException(java.lang.String), B–138

initTraceFile(Configuration, String) - oracle.apps.cz.cio.CIO.initTraceFile(oracle.apps.cz.cio.Configuration, java.lang.String), B–42

INSTANCE_TYPE_ADDED - oracle.apps.cz.cio.Component.INSTANCE_TYPE_ADDED, B–54

INSTANCE_TYPE_DELETED - oracle.apps.cz.cio.Component.INSTANCE_TYPE_DELETED, B–54

INSTANCE_TYPE_INITIAL - oracle.apps.cz.cio.Component.INSTANCE_TYPE_INITIAL, B–54

INTEGER_FEATURE - oracle.apps.cz.cio.IRuntimeNode.INTEGER_FEATURE, B–159

INTEGER_FIELD - oracle.apps.cz.cio.IUserInterfaceNode.INTEGER_FIELD, B–189

IntegerFeature - oracle.apps.cz.cio.IntegerFeature, B–139

IntegerNode - oracle.apps.cz.cio.IntegerNode, B–142

interfacemethods, 3–30objects, 1–4, 3–2

INTL_TEXT - oracle.apps.cz.cio.Reason.INTL_TEXT, B–250

IOption - oracle.apps.cz.cio.IOption, B–145IOptionFeature -

oracle.apps.cz.cio.IOptionFeature, B–147IPrice - oracle.apps.cz.cio.IPrice, B–151IReadOnlyDecimal -

oracle.apps.cz.cio.IReadOnlyDecimal, B–154IRuntimeNode -

oracle.apps.cz.cio.IRuntimeNode, B–156isAlive() -

oracle.apps.cz.common.CZContext.isAlive(),C–6

isBooleanType() - oracle.apps.cz.cio.Property.isBooleanType(), B–243

isCompatibleConnection(UiXmlInitMessage) - oracle.apps.cz.common.CZContext.isCompatibleConnection(oracle.apps.cz.common.UiXmlInitMessage), C–6

Index-21

isDecimalType() - oracle.apps.cz.cio.Property.isDecimalType(), B–244

isDefaultAffected() - oracle.apps.cz.cio.RuntimeNode.isDefaultAffected(), B–268

isDefaulted() - oracle.apps.cz.cio.Property.isDefaulted(), B–244

isDefaultState(int) - oracle.apps.cz.cio.StateNode.isDefaultState(int),

B–278isEffective() -

oracle.apps.cz.cio.IRuntimeNode.isEffective(),B–164

isEffective() - oracle.apps.cz.cio.RuntimeNode.isEffective(),B–268

isFalse() - oracle.apps.cz.cio.IState.isFalse(), B–168isFalse() -

oracle.apps.cz.cio.StateNode.isFalse(), B–278isFalseState(int) -

oracle.apps.cz.cio.StateNode.isFalseState(int),B–278

isFalseStateRequest() - oracle.apps.cz.cio.Request.isFalseStateRequest(), B–254

isIntegerType() - oracle.apps.cz.cio.Property.isIntegerType(), B–244

isLogic() - oracle.apps.cz.cio.IState.isLogic(), B–168isLogic() -

oracle.apps.cz.cio.StateNode.isLogic(), B–278isLogicState(int) -

oracle.apps.cz.cio.StateNode.isLogicState(int),B–279

isNative() - oracle.apps.cz.cio.IRuntimeNode.isNative(), B–164

isNative() - oracle.apps.cz.cio.RuntimeNode.isNative(), B–268

isNumericRequest() - oracle.apps.cz.cio.Request.isNumericRequest(),

B–255

isOptionMutexed() - oracle.apps.cz.cio.BomNode.isOptionMutexed(), B–22

isOptionMutexed() - oracle.apps.cz.cio.IOption.isOptionMutexed(),

B–146isOptionMutexed() -

oracle.apps.cz.cio.OptionNode.isOptionMutexed(), B–232

isOverridable()usage, 3–20

isOverridable() - oracle.apps.cz.cio.LogicalException.isOverridable(), B–197

isOverridable() - oracle.apps.cz.cio.LogicalOverridableException.isOverridable(), B–199

isRequired() - oracle.apps.cz.cio.BomNode.isRequired(), B–22

isRequired() - oracle.apps.cz.cio.IBomItem.isRequired(), B–116

isRoot() - oracle.apps.cz.cio.IRuntimeNode.isRoot(), B–164

isRoot() - oracle.apps.cz.cio.RuntimeNode.isRoot(), B–269

isSelected()usage, 3–17

isSelected() - oracle.apps.cz.cio.BomNode.isSelected(), B–22

isSelected() - oracle.apps.cz.cio.IOption.isSelected(), B–146

isSelected() - oracle.apps.cz.cio.OptionNode.isSelected(), B–232

isSelectionMutexed() - oracle.apps.cz.cio.BomNode.isSelectionMutexed(), B–22

isSelectionMutexed() - oracle.apps.cz.cio.IOptionFeature.isSelectionMutexed(), B–149

isSelectionMutexed() -

Index-22

oracle.apps.cz.cio.OptionFeatureNode.isSelectionMutexed(), B–229

isStateRequest() - oracle.apps.cz.cio.Request.isStateRequest(), B–255

isStringType() - oracle.apps.cz.cio.Property.isStringType(), B–244

IState - oracle.apps.cz.cio.IState, B–166isToggleStateRequest() -

oracle.apps.cz.cio.Request.isToggleStateRequest(), B–255

isTrue() - oracle.apps.cz.cio.IState.isTrue(), B–169isTrue() -

oracle.apps.cz.cio.StateNode.isTrue(), B–279isTrueState(int) -

oracle.apps.cz.cio.StateNode.isTrueState(int),B–279

isTrueStateRequest() - oracle.apps.cz.cio.Request.isTrueStateRequest(),

B–255isUnknown() -

oracle.apps.cz.cio.IInteger.isUnknown(), B–129

isUnknown() - oracle.apps.cz.cio.IntegerNode.isUnknown(),B–144

isUnknown() - oracle.apps.cz.cio.IReadOnlyDecimal.isUnknown(), B–154

isUnknown() - oracle.apps.cz.cio.IState.isUnknown(), B–169

isUnknown() - oracle.apps.cz.cio.ReadOnlyDecimalNode.isUnknown(), B–247

isUnknown() - oracle.apps.cz.cio.StateNode.isUnknown(), B–279

isUnknownState(int) - oracle.apps.cz.cio.StateNode.isUnknownState(int), B–279

isUnknownStateRequest() - oracle.apps.cz.cio.Request.isUnknownStateRequest(), B–255

isUnsatisfied() -

oracle.apps.cz.cio.Configuration.isUnsatisfied(),B–80

isUnsatisfied() - oracle.apps.cz.cio.IRuntimeNode.isUnsatisfied(), B–164

isUnsatisfied() - oracle.apps.cz.cio.RuntimeNode.isUnsatisfied(),

B–269isUnsatisfiedNode() -

oracle.apps.cz.cio.IRuntimeNode.isUnsatisfiedNode(), B–164

isUnsatisfiedNode() - oracle.apps.cz.cio.RuntimeNode.isUnsatisfiedNode(), B–269

isUser() - oracle.apps.cz.cio.IState.isUser(), B–169isUser() -

oracle.apps.cz.cio.StateNode.isUser(), B–279isUserState(int) -

oracle.apps.cz.cio.StateNode.isUserState(int),B–279

isVirtual() - oracle.apps.cz.cio.Component.isVirtual(), B–55

iterator() - oracle.apps.cz.utilities.NameValuePairSet.iterator(), D–5

IText - oracle.apps.cz.cio.IText, B–170IUserInterface, 2–1

session object, 2–2usage, 2–2, 2–4, 2–8

navigation, 2–6IUserInterface -

oracle.apps.cz.cio.IUserInterface, B–172IUserInterfaceControl, 2–1

usage, 2–5IUserInterfaceControl -

oracle.apps.cz.cio.IUserInterfaceControl, B–177

IUserInterfaceEvent, 2–1usage, 2–9

IUserInterfaceEvent - oracle.apps.cz.cio.IUserInterfaceEvent, B–179

IUserInterfaceEventListener, 2–1usage, 2–8, 2–9

IUserInterfaceEventListener -

Index-24

ic.LogicContradictionException, oracle.apps.cz.cio.Configuration), B–199

LogicalRuntimeException - oracle.apps.cz.cio.LogicalRuntimeException, B–200

LogicalRuntimeException(LogicException) - oracle.apps.cz.cio.LogicalRuntimeException.LogicalRuntimeException(oracle.apps.cz.logic.LogicException), B–201

LogicalRuntimeException(String) - oracle.apps.cz.cio.LogicalRuntimeException.LogicalRuntimeException(java.lang.String), B–201

lookupNodeID(Object) - oracle.apps.cz.cio.RuntimeNode.lookupNodeID(java.lang.Object), B–269

lookupPairByName(String) - oracle.apps.cz.utilities.NameValuePairSet.lookupPairByName(java.lang.String), D–6

LTRUEusage, 3–13

LTRUE - oracle.apps.cz.cio.IState.LTRUE, B–167

Mm_sequence - oracle.apps.cz.cio.Configuration.m_

sequence, B–68MAX_FAILURE -

oracle.apps.cz.cio.ValidationFailure.MAX_FAILURE, B–296

message boxesdisplaying in user interface, 2–8

MIN_FAILURE - oracle.apps.cz.cio.ValidationFailure.MIN_FAILURE, B–296

MIN0_FAILURE - oracle.apps.cz.cio.ValidationFailure.MIN0_FAILURE, B–296

MINMAX - oracle.apps.cz.cio.Reason.MINMAX, B–250

MINMAX_FAILURE - oracle.apps.cz.cio.ValidationFailure.MINMAX_FAILURE, B–297

MissingFileException - oracle.apps.cz.cio.MissingFileException, B–20

2MissingLogicException -

oracle.apps.cz.cio.MissingLogicException, B–203

ModelLookupException - oracle.apps.cz.cio.ModelLookupException, B–204

ModelLookupException(String) - oracle.apps.cz.cio.ModelLookupException.ModelLookupException(java.lang.String), B–205

ModifiedConfigOverwriteException - oracle.apps.cz.cio.ModifiedConfigOverwriteException, B–206

ModifiedConfigOverwriteException(DbConfigHeader, String) - oracle.apps.cz.cio.ModifiedConfigOverwriteException.ModifiedConfigOverwriteException(oracle.apps.cz.dio.config.DbConfigHeader, java.lang.String), B–206

NNameValuePair -

oracle.apps.cz.utilities.NameValuePair, D–2NameValuePair(String) -

oracle.apps.cz.utilities.NameValuePair.NameValuePair(java.lang.String), D–3

NameValuePair(String, Object) - oracle.apps.cz.utilities.NameValuePair.NameValuePair(java.lang.String, java.lang.Object), D–3

NameValuePairSet - oracle.apps.cz.utilities.NameValuePairSet, D–4

NameValuePairSet() - oracle.apps.cz.utilities.NameValuePairSet.NameValuePairSet(), D–5

native BOM, 3–19navigate() -

oracle.apps.cz.cio.IUserInterfaceScreen.navigate(), B–193

navigateToScreen(String) - oracle.apps.cz.cio.IUserInterface.navigateToScreen(java.lang.String), B–176

navigationcontrolling in user interface, 2–6

Index-25

nesting transactions, 3–9New Functional Companion command, 1–11New User Interface command, 1–15NoAtpCalculatedException -

oracle.apps.cz.cio.NoAtpCalculatedException,B–207

NoConfigHeaderException - oracle.apps.cz.cio.NoConfigHeaderException,B–208

NoConfigHeaderException(Configuration) - oracle.apps.cz.cio.NoConfigHeaderException.NoConfigHeaderException(oracle.apps.cz.cio.Configuration), B–209

NodeNotEffectiveException - oracle.apps.cz.cio.NodeNotEffectiveException,

B–210nodes

accessing in user interface, 2–4NonPricedNodeException -

oracle.apps.cz.cio.NonPricedNodeException,B–212

NoSuchChildException - oracle.apps.cz.cio.NoSuchChildException, B–213

NoSuchChildException(IRuntimeNode, int, Configuration) - oracle.apps.cz.cio.NoSuchChildException.NoSuchChildException(oracle.apps.cz.cio.IRuntimeNode, int, oracle.apps.cz.cio.Configuration), B–214

NoSuchChildException(IRuntimeNode, String, Configuration) - oracle.apps.cz.cio.NoSuchChildException.NoSuchChildException(oracle.apps.cz.cio.IRuntimeNode, java.lang.String, oracle.apps.cz.cio.Configuration), B–214

NoSuchUiNodeException - oracle.apps.cz.cio.NoSuchUiNodeException, B–215

NoSuchUiNodeException(String, Configuration) - oracle.apps.cz.cio.NoSuchUiNodeException.NoSuchUiNodeException(java.lang.String, oracle.apps.cz.cio.Configuration), B–216

notifyComponentAdded(Component) - oracle.apps.cz.cio.ICompSetEventListener.notif

yComponentAdded(oracle.apps.cz.cio.Component), B–117

notifyComponentAdded(Component) - oracle.apps.cz.cio.IConfigEventListener.notifyComponentAdded(oracle.apps.cz.cio.Component), B–118

notifyComponentDeleted(Component) - oracle.apps.cz.cio.ICompSetEventListener.notifyComponentDeleted(oracle.apps.cz.cio.Component), B–117

notifyComponentDeleted(Component) - oracle.apps.cz.cio.IConfigEventListener.notifyComponentDeleted(oracle.apps.cz.cio.Component), B–118

NotOneProductException - oracle.apps.cz.cio.NotOneProductException, B–217

NotOneProjectException - oracle.apps.cz.cio.NotOneProjectException, B–218

OOC Servlet

propertiescz.uiservlet.dio_share, 1–18

onNew()usage, 3–7, 3–28

initial requests, 3–30onNew() -

oracle.apps.cz.cio.AutoFunctionalCompanion.onNew(), B–9

onRestore()usage, 3–8

initial requests, 3–30onRestore() -

oracle.apps.cz.cio.AutoFunctionalCompanion.onRestore(), B–9

onSave()usage, 3–8

onSave() - oracle.apps.cz.cio.AutoFunctionalCompanion.onSave(), B–9

openTraceFile(Configuration) - oracle.apps.cz.cio.CIO.openTraceFile(oracle.app

Index-26

s.cz.cio.Configuration), B–42OPTION -

oracle.apps.cz.cio.IRuntimeNode.OPTION, B–159

OPTION - oracle.apps.cz.cio.IUserInterfaceNode.OPTION,

B–189Option - oracle.apps.cz.cio.Option, B–219OPTION_FEATURE -

oracle.apps.cz.cio.IRuntimeNode.OPTION_FEATURE, B–159

OptionFeature - oracle.apps.cz.cio.OptionFeature, B–222

OptionFeatureNode - oracle.apps.cz.cio.OptionFeatureNode, B–225

OptionNode - oracle.apps.cz.cio.OptionNode, B–230

Oracle Configurator, 3–8Oracle Configurator Developer

product support, xvOracle Configurator Servlet, 2–2Oracle JDBC Thin drivers, 1–8Oracle Support Services, xvoracle.apps.cz.cio, 3–2

package to import, 3–1oracle.apps.cz.cio - oracle.apps.cz.cio, B–1oracle.apps.cz.cio.IFunctionalCompanion, 3–31oracle.apps.cz.common -

oracle.apps.cz.common, C–1oracle.apps.cz.utilities -

oracle.apps.cz.utilities, D–1ORTHEN -

oracle.apps.cz.cio.Reason.ORTHEN, B–250Output, 1–2, 1–11, 1–19outputToFrame(String, String) -

oracle.apps.cz.cio.IUserInterface.outputToFrame(java.lang.String, java.lang.String), B–176

override()usage, 3–20, 3–21

override() - oracle.apps.cz.cio.LogicalOverridableException.override(), B–199

overridinginitial requests, 3–30

PPATH, 1–8perform() -

oracle.apps.cz.cio.Configuration.perform(), B–80

POST_CLICK - oracle.apps.cz.cio.IUserInterfaceEvent.POST_CLICK, B–180

POST_EVENT_EXECUTION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_EVENT_EXECUTION, B–180

POST_MODEL_EVENT_EXECUTION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_MODEL_EVENT_EXECUTION, B–180

POST_NAVIGATION_EVENT_EXECUTION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_NAVIGATION_EVENT_EXECUTION, B–180

POST_NEW_CONFIGURATION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_NEW_CONFIGURATION, B–180

POST_RESTORE_CONFIGURATION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_RESTORE_CONFIGURATION, B–180

POST_SAVE_CONFIGURATION - oracle.apps.cz.cio.IUserInterfaceEvent.POST_SAVE_CONFIGURATION, B–180

POST_VALUE_CHANGE - oracle.apps.cz.cio.IUserInterfaceEvent.POST_VALUE_CHANGE, B–180

PRE_CANCEL_CONFIGURATION - oracle.apps.cz.cio.IUserInterfaceEvent.PRE_CANCEL_CONFIGURATION, B–180

PRE_SAVE_CONFIGURATION - oracle.apps.cz.cio.IUserInterfaceEvent.PRE_SAVE_CONFIGURATION, B–180

PRICE_APPS_107_110 - oracle.apps.cz.cio.Configuration.PRICE_APPS_107_110, B–69

PRICE_MULT_ITEMS - oracle.apps.cz.cio.Configuration.PRICE_MULT_ITEMS, B–69

PRICE_MULT_ITEMS_MLS - oracle.apps.cz.cio.Configuration.PRICE_MULT_ITEMS_MLS, B–69

Index-27

PRICE_SINGLE_ITEM - oracle.apps.cz.cio.Configuration.PRICE_SINGLE_ITEM, B–69

PricedNode - oracle.apps.cz.cio.PricedNode, B–234PRICING_DISABLED -

oracle.apps.cz.cio.Configuration.PRICING_DISABLED, B–69

PricingUnavailableException - oracle.apps.cz.cio.PricingUnavailableException,

B–239PricingUnavailableException(String) -

oracle.apps.cz.cio.PricingUnavailableException.PricingUnavailableException(java.lang.String),

B–240PricingUnavailableException(String, Object, Log) -

oracle.apps.cz.cio.PricingUnavailableException.PricingUnavailableException(java.lang.String, java.lang.Object, oracle.apps.fnd.common.Log), B–240

Product Support, xvproduct support for Oracle Configurator

Developer, xvProducts

association with Functional Companions, 1–3Program String

for a Functional Companion, 1–11Property - oracle.apps.cz.cio.Property, B–241

RReadOnlyDecimalNode -

oracle.apps.cz.cio.ReadOnlyDecimalNode, B–245

Reason - oracle.apps.cz.cio.Reason, B–248Reason(int, IRuntimeNode, String, Configuration) -

oracle.apps.cz.cio.Reason.Reason(int, oracle.apps.cz.cio.IRuntimeNode, java.lang.String, oracle.apps.cz.cio.Configuration), B–251

Reason(Message, String, IRuntimeNode, Configuration) - oracle.apps.cz.cio.Reason.Reason(oracle.apps.fnd.common.Message, java.lang.String, oracle.apps.cz.cio.IRuntimeNode, oracle.apps.cz.cio.Configuration), B–251

Reason(String, Configuration) - oracle.apps.cz.cio.Reason.Reason(java.lang.String, oracle.apps.cz.cio.Configuration), B–251

Refresh command, 1–15releaseJDBCConnection() -

oracle.apps.cz.common.CZContext.releaseJDBCConnection(), C–6

removeCompSetEventListener(ICompSetEventListener) - oracle.apps.cz.cio.ComponentSet.removeCompSetEventListener(oracle.apps.cz.cio.ICompSetEventListener), B–62

removeConfigEventListener(ICompSetEventListener) - oracle.apps.cz.cio.ComponentSet.removeConfigEventListener(oracle.apps.cz.cio.ICompSetEventListener), B–62

removeConfigEventListener(IConfigEventListener) - oracle.apps.cz.cio.Configuration.removeConfigEventListener(oracle.apps.cz.cio.IConfigEventListener), B–80

renderNavigateEvent() - oracle.apps.cz.cio.IUserInterfaceScreen.renderNavigateEvent(), B–193

renderNavigateScript(String) - oracle.apps.cz.cio.IUserInterfaceScreen.renderNavigateScript(java.lang.String), B–193

Request - oracle.apps.cz.cio.Request, B–253Request() -

oracle.apps.cz.cio.Request.Request(), B–254Request(IRuntimeNode, String) -

oracle.apps.cz.cio.Request.Request(oracle.apps.cz.cio.IRuntimeNode, java.lang.String), B–254

requests, 3–12contradictions, 3–20defined, 3–26failed requests, 3–26initial requests, 3–26, 3–28logic, 3–20user requests, 3–26

RESOURCE - oracle.apps.cz.cio.IRuntimeNode.RESOURCE,

B–159Resource - oracle.apps.cz.cio.Resource, B–256RESOURCE_FAILURE -

Index-28

oracle.apps.cz.cio.ValidationFailure.RESOURCE_FAILURE, B–297

RESOURCE_FIELD - oracle.apps.cz.cio.IUserInterfaceNode.RESOURCE_FIELD, B–189

restartConfiguration() - oracle.apps.cz.cio.Configuration.restartConfiguration(), B–80

RESTORE_FAILURE - oracle.apps.cz.cio.ValidationFailure.RESTORE_FAILURE, B–297

restoreConfiguration()usage, 3–7, 3–29

restoreConfiguration(int, int, Context) - oracle.apps.cz.cio.CIO.restoreConfiguration(int, int, oracle.apps.fnd.common.Context), B–42

restoreConfiguration(int, int, int, Context, IUserInterface, Calendar, Calendar, String, String, NameValuePairSet, int) - oracle.apps.cz.cio.CIO.restoreConfiguration(int, int, int, oracle.apps.fnd.common.Context, oracle.apps.1589468570, B–43

RestoreValidationFailure - oracle.apps.cz.cio.RestoreValidationFailure, B–259

restoringinitial requests, 3–29

revNumberusage, 3–7

rollbackConfigTransaction(ConfigTransaction) - oracle.apps.cz.cio.Configuration.rollbackConfigTransaction(oracle.apps.cz.cio.ConfigTransaction), B–81

rollbackConfigTransaction(transaction)usage, 3–9, 3–22, 3–24

runtime model subschema objects, 3–1RuntimeNode -

oracle.apps.cz.cio.RuntimeNode, B–261

Ssave()

usage, 3–7save() -

oracle.apps.cz.cio.Configuration.save(), B–81

saveAs(configHeaderID, revNumber)usage, 3–7

saveAs(int, int) - oracle.apps.cz.cio.Configuration.saveAs(int, int), B–81

saveNew()usage, 3–7

saveNew() - oracle.apps.cz.cio.Configuration.saveNew(), B–81

saveNewRev()usage, 3–7

saveNewRev() - oracle.apps.cz.cio.Configuration.saveNewRev(),

B–81saving

initial requests, 3–29SCREEN -

oracle.apps.cz.cio.IUserInterfaceNode.SCREEN,B–189

screensgetting current screen in user interface, 2–4

select()usage, 3–17

select() - oracle.apps.cz.cio.BomNode.select(), B–23select() - oracle.apps.cz.cio.IOption.select(), B–146select() -

oracle.apps.cz.cio.OptionNode.select(), B–232select(IOption) -

oracle.apps.cz.cio.BomNode.select(oracle.apps.cz.cio.IOption), B–23

select(IOption) - oracle.apps.cz.cio.IOptionFeature.select(oracle.apps.cz.cio.IOption), B–150

select(IOption) - oracle.apps.cz.cio.OptionFeatureNode.select(oracle.apps.cz.cio.IOption), B–229

SELECTION_LIST - oracle.apps.cz.cio.IUserInterfaceNode.SELECTION_LIST, B–189

SELECTION_LIST_MUTEX - oracle.apps.cz.cio.IUserInterfaceNode.SELECTION_LIST_MUTEX, B–190

SelectionNotMutexedException - oracle.apps.cz.cio.SelectionNotMutexedExcepti

Index-29

on, B–271selectOption()

usage, 3–17setActiveModelPath(String) -

oracle.apps.cz.cio.CIO.setActiveModelPath(java.lang.String), B–44

setAltPricingAtpContext(Context) - oracle.apps.cz.cio.Configuration.setAltPricingAtpContext(oracle.apps.fnd.common.Context),B–82

setAtpDate(Date) - oracle.apps.cz.cio.BomNode.setAtpDate(java.util.Date), B–23

setConfigHeaderCheckoutUser(String) - oracle.apps.cz.cio.Configuration.setConfigHeaderCheckoutUser(java.lang.String), B–82

setConfigHeaderDescription(String) - oracle.apps.cz.cio.Configuration.setConfigHeaderDescription(java.lang.String), B–82

setConfigHeaderEffectiveFrom(Timestamp) - oracle.apps.cz.cio.Configuration.setConfigHeaderEffectiveFrom(java.sql.Timestamp), B–82

setConfigHeaderEffectiveTo(Timestamp) - oracle.apps.cz.cio.Configuration.setConfigHeaderEffectiveTo(java.sql.Timestamp), B–82

setConfigHeaderName(String) - oracle.apps.cz.cio.Configuration.setConfigHeaderName(java.lang.String), B–82

setConfigHeaderNote(String) - oracle.apps.cz.cio.Configuration.setConfigHeaderNote(java.lang.String), B–82

setConfigHeaderOpportunityHeaderId(int) - oracle.apps.cz.cio.Configuration.setConfigHeaderOpportunityHeaderId(int), B–83

setConfigHeaderUiDefinitionId(int) - oracle.apps.cz.cio.Configuration.setConfigHeaderUiDefinitionId(int), B–83

setCount(int) - oracle.apps.cz.cio.ICount.setCount(int), B–120

setCount(int) - oracle.apps.cz.cio.StateCountNode.setCount(int), B–275

setCurrLang(String) - oracle.apps.cz.common.CZContext.setCurrLang(java.lang.String), C–7

setDecimalCount(double) - oracle.apps.cz.cio.ICount.setDecimalCount(double), B–120

setDecimalCount(double) - oracle.apps.cz.cio.StateCountNode.setDecimalCount(double), B–275

setDecimalValue()usage, 3–15, 3–16

setDecimalValue(double) - oracle.apps.cz.cio.DecimalNode.setDecimalValue(double), B–95

setDecimalValue(double) - oracle.apps.cz.cio.IDecimal.setDecimalValue(double), B–121

setDiscountedPrice(double) - oracle.apps.cz.cio.PricedNode.setDiscountedPrice(double), B–238

setFileName(String) - oracle.apps.cz.cio.IUserInterfaceImage.setFileName(java.lang.String), B–184

setInitializeMessage(UiXmlInitMessage) - oracle.apps.cz.common.CZContext.setInitializeMessage(oracle.apps.cz.common.UiXmlInitMessage), C–7

setInitParameters(NameValuePairSet) - oracle.apps.cz.cio.Configuration.setInitParameters(oracle.apps.cz.utilities.NameValuePairSet),

B–83setIntValue()

usage, 3–15setIntValue(int) -

oracle.apps.cz.cio.CountFeature.setIntValue(int), B–88

setIntValue(int) - oracle.apps.cz.cio.IInteger.setIntValue(int), B–130

setIntValue(int) - oracle.apps.cz.cio.IntegerNode.setIntValue(int),

B–144setListPrice(double) -

oracle.apps.cz.cio.PricedNode.setListPrice(double), B–238

setLoginType(int) - oracle.apps.cz.common.CZContext.setLoginType(int), C–7

Index-30

setName(String) - oracle.apps.cz.cio.Component.setName(java.lang.String), B–55

setName(String) - oracle.apps.cz.common.CZContext.setName(java.lang.String), C–7

setState()usage, 3–14

setState(int state)usage, 3–14

setState(int) - oracle.apps.cz.cio.BomNode.setState(int), B–23

setState(int) - oracle.apps.cz.cio.IState.setState(int), B–169

setState(int) - oracle.apps.cz.cio.OptionNode.setState(int), B–233

setState(int) - oracle.apps.cz.cio.StateNode.setState(int), B–280

setState(state)usage, 3–20

setTextValue(String) - oracle.apps.cz.cio.IText.setTextValue(java.lang.String), B–170

setTextValue(String) - oracle.apps.cz.cio.TextNode.setTextValue(java.lang.String), B–287

setTimeEvent(TimeEvent) - oracle.apps.cz.cio.Configuration.setTimeEvent(oracle.apps.cz.utilities.TimeEvent), B–84

setUiCaption(String) - oracle.apps.cz.cio.IUserInterfaceLabel.setUiCaption(java.lang.String), B–186

setValue(Object) - oracle.apps.cz.utilities.NameValuePair.setValue(java.lang.Object), D–3

standard interface methods, 1–3state

logic, 3–9getting, 3–13setting, 3–13

StateCountNode - oracle.apps.cz.cio.StateCountNode, B–273

StateNode - oracle.apps.cz.cio.StateNode, B–276statesMatch(int, int) -

oracle.apps.cz.cio.StateNode.statesMatch(int, int), B–280

STATUS_DELETED - oracle.apps.cz.cio.StatusInfo.STATUS_DELETED, B–282

STATUS_EXISTING - oracle.apps.cz.cio.StatusInfo.STATUS_EXISTING, B–282

STATUS_NEW - oracle.apps.cz.cio.StatusInfo.STATUS_NEW, B–282

StatusInfo - oracle.apps.cz.cio.StatusInfo, B–281statusToString(int) -

oracle.apps.cz.cio.StatusInfo.statusToString(int),B–283

subschema objectsconfiguration, 3–1runtime model, 3–1

Support, xv

Tterminate()

usage, 3–36terminate() -

oracle.apps.cz.cio.FunctionalCompanion.terminate(), B–110

terminate() - oracle.apps.cz.cio.IFunctionalCompanion.terminate(), B–128

TEXT - oracle.apps.cz.cio.Reason.TEXT, B–250TEXT_FEATURE -

oracle.apps.cz.cio.IRuntimeNode.TEXT_FEATURE, B–159

TEXT_FIELD - oracle.apps.cz.cio.IUserInterfaceNode.TEXT_FIELD, B–190

TextFeature - oracle.apps.cz.cio.TextFeature, B–284TextNode - oracle.apps.cz.cio.TextNode, B–286thick client, 3–35thin client, 3–35TOGGLE

usage, 3–13

Index-31

TOGGLE - oracle.apps.cz.cio.IState.TOGGLE, B–167

toString()usage, 3–21

toString() - oracle.apps.cz.cio.DecimalNode.toString(), B–95

toString() - oracle.apps.cz.cio.FunctionalCompanion.toString(), B–110

toString() - oracle.apps.cz.cio.InitialRequestException.toString(), B–138

toString() - oracle.apps.cz.cio.ReadOnlyDecimalNode.toString(), B–247

toString() - oracle.apps.cz.cio.Reason.toString(), B–252

toString() - oracle.apps.cz.cio.Request.toString(), B–255

toString() - oracle.apps.cz.cio.RuntimeNode.toString(), B–269

toString() - oracle.apps.cz.cio.StateCountNode.toString(),B–275

toString() - oracle.apps.cz.cio.StatusInfo.toString(), B–283

toString() - oracle.apps.cz.cio.ValidationFailure.toString(),

B–297toString(boolean) -

oracle.apps.cz.cio.IRuntimeNode.toString(boolean), B–164

toString(boolean) - oracle.apps.cz.cio.RuntimeNode.toString(boolean), B–269

toString(boolean) - oracle.apps.cz.cio.StatusInfo.toString(boolean),

B–283TOTAL -

oracle.apps.cz.cio.IRuntimeNode.TOTAL, B–160

Total - oracle.apps.cz.cio.Total, B–288TOTAL_FIELD -

oracle.apps.cz.cio.IUserInterfaceNode.TOTAL_FIELD, B–190

trace(Configuration, String) - oracle.apps.cz.cio.CIO.trace(oracle.apps.cz.cio.Configuration, java.lang.String), B–44

traceNoLine(Configuration, String) - oracle.apps.cz.cio.CIO.traceNoLine(oracle.apps.cz.cio.Configuration, java.lang.String), B–44

tracing() - oracle.apps.cz.cio.CIO.tracing(), B–44TransactionException -

oracle.apps.cz.cio.TransactionException, B–291

transactionsbeginning, 3–9commiting, 3–9committing automatically, 3–9ending, 3–9logic, 3–8

contrasted with database transactions, 3–9nesting, 3–9rolling back, 3–9setting states and values inside, 3–9usage

with initial requests, 3–10translate() -

oracle.apps.cz.cio.Reason.translate(), B–252translate(String) -

oracle.apps.cz.cio.Reason.translate(java.lang.String), B–252

TREELINK - oracle.apps.cz.cio.IUserInterfaceNode.TREELINK, B–190

TRUEusage, 3–13

TRUE - oracle.apps.cz.cio.IState.TRUE, B–167TRUEATBIRTH -

oracle.apps.cz.cio.Reason.TRUEATBIRTH, B–250

typeToString(int) - oracle.apps.cz.cio.RuntimeNode.typeToString(int), B–270

UUFALSE

Index-32

usage, 3–13UFALSE - oracle.apps.cz.cio.IState.UFALSE, B–168UI Server, 2–2

current screen, 2–6in creation of user interface, 2–2initialization, 2–2role in handling exceptions, 3–23

UINODE - oracle.apps.cz.cio.IUserInterfaceNode.UINODE, B–190

UiNodeUnAvailableException - oracle.apps.cz.cio.UiNodeUnAvailableException, B–293

UiNodeUnAvailableException(IUserInterfaceNode, Configuration) - oracle.apps.cz.cio.UiNodeUnAvailableException.UiNodeUnAvailableException(oracle.apps.cz.cio.IUserInterfaceNode, oracle.apps.cz.cio.Configuration), B–294

undo()usage, 3–16

undo() - oracle.apps.cz.cio.Configuration.undo(), B–84

UNKNOWNusage, 3–13

UNKNOWN - oracle.apps.cz.cio.IState.UNKNOWN, B–168

unset() - oracle.apps.cz.cio.DecimalNode.unset(), B–95

unset() - oracle.apps.cz.cio.IDecimal.unset(), B–122unset() - oracle.apps.cz.cio.IInteger.unset(), B–130unset() -

oracle.apps.cz.cio.IntegerNode.unset(), B–144unset() - oracle.apps.cz.cio.IState.unset(), B–169unset() - oracle.apps.cz.cio.IText.unset(), B–171unset() -

oracle.apps.cz.cio.StateNode.unset(), B–280unset() -

oracle.apps.cz.cio.TextNode.unset(), B–287updateDefaultNodes() -

oracle.apps.cz.cio.Configuration.updateDefaultNodes(), B–84

useInitialRequests()usage, 3–28, 3–29

useInitialRequests() -

oracle.apps.cz.cio.ConfigTransaction.useInitialRequests(), B–63

user interfaceaccessing controls, 2–5accessing images, 2–6accessing labels, 2–6changing images, 2–7changing labels, 2–7class hierarchy, 2–1display processing, 2–2displaying custom HTML output, 2–8displaying message boxes, 2–8event listeners, 2–9

invocation, 2–10event types, 2–9events

dispatching, 2–3registration, 2–3

getting current screen, 2–4handling events, 2–8interaction

only available for DHTML UI, 2–3restrictions, 2–4

navigation, 2–6nodes, 2–4role of UI Server, 2–2

user requestsdefined, 3–26

UTRUEusage, 3–13

UTRUE - oracle.apps.cz.cio.IState.UTRUE, B–168

Vvalidate()

usage, 3–12, 3–24, 3–34validate() -

oracle.apps.cz.cio.FunctionalCompanion.validate(), B–110

validate() - oracle.apps.cz.cio.IFunctionalCompanion.validate(), B–128

Validation, 1–2, 1–11, 1–19, 3–12validation failures

returned by transactions, 3–8

Index-33

ValidationFailure - oracle.apps.cz.cio.ValidationFailure, B–295

Wweb deployment, 3–8, 3–36, 5–2, 5–9, 5–16

Index-34