oracle.adf.businesseditor.objects

Class BusinessEditorManager

java.lang.Object

oracle.adf.businesseditor.objects.BusinessEditorManager

All Implemented Interfaces:

BusinessEditorManagerInterface

public final class BusinessEditorManager
extends java.lang.Object
implements BusinessEditorManagerInterface

A logical container for the business objects.

Constructor Summary

Constructors

Constructor and Description
BusinessEditorManager() Initializes a BusinessEditorManager object.

Method Summary

Modifier and Type	Method and Description
void	commit() Call commit() to save the changes of the current pending logical operation you are performing.
BusinessObject	createBusinessObject(BusinessObject parent, java.lang.String name) Creates a BusinessObject.
BusinessObject	createBusinessObject(BusinessObject parent, java.lang.String name, CustomObjectInfo descriptor) Creates a BusinessObject.
BusinessObject	createBusinessObject(java.lang.String name) Creates a BusinessObject.
BusinessObject	createBusinessObject(java.lang.String name, CustomObjectInfo descriptor) Creates a BusinessObject.
GlobalFunction	createGlobalFunction(java.lang.String name, java.lang.String returnType, java.lang.String body) Creates a global function.
void	deleteBusinessObject(BusinessObject bo) Deletes a business object.
void	deleteGlobalFunction(GlobalFunction function) Deletes a global function.
BusinessObject	findBusinessObject(java.lang.String name) Finds the existing BusinessObject for the given name.
GlobalFunction	findGlobalFunction(java.lang.String name, java.lang.String... paramTypes) Retrieves the global function with the given name.
java.util.Collection<GlobalFunction>	findGlobalFunctions(java.lang.String name) Retrieves all global functions with the name.
java.util.Collection<BusinessObject>	getBusinessObjects() Returns all customizable business objects, and the reference-only business objects that contain attributes that can be used for the display and search attribute for dynamic choice list.
java.util.Collection<GlobalFunction>	getGlobalFunctions() Returns global functions.
void	release() Releases the application module instance.
void	rollback() Discard any changes since last commit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BusinessEditorManager

public BusinessEditorManager()

Initializes a BusinessEditorManager object.

Method Detail

getBusinessObjects

public java.util.Collection<BusinessObject> getBusinessObjects()

Returns all customizable business objects, and the reference-only business objects that contain attributes that can be used for the display and search attribute for dynamic choice list. Use BusinessObject.isCustomizable() to identify if a business object is customizable.

Specified by:

getBusinessObjects in interface BusinessEditorManagerInterface

Returns:

collection of business objects

findBusinessObject

public BusinessObject findBusinessObject(java.lang.String name)

Finds the existing BusinessObject for the given name. If no BusinessObject exists for the name, null is returned.

Specified by:

findBusinessObject in interface BusinessEditorManagerInterface

Parameters:

name - name of object to search for

Returns:

BusinessObject

createBusinessObject

public BusinessObject createBusinessObject(java.lang.String name)

Creates a BusinessObject.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

name - name of the BusinessObject

Returns:

BusinessObject

Throws:

oracle.jbo.JboException - if a BusinessObject for the name already exists

createBusinessObject

public BusinessObject createBusinessObject(java.lang.String name,
                                           CustomObjectInfo descriptor)

Creates a BusinessObject.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

name - name of the BusinessObject

descriptor - an instance of CustomObjectDescriptor

Returns:

BusinessObject

Throws:

oracle.jbo.JboException - if a BusinessObject for the name already exists

createBusinessObject

public BusinessObject createBusinessObject(BusinessObject parent,
                                           java.lang.String name)

Creates a BusinessObject.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

parent - parent of the BusinessObject

name - name of the BusinessObject

Returns:

BusinessObject

Throws:

oracle.jbo.JboException - if a BusinessObject for the name already exists

createBusinessObject

public BusinessObject createBusinessObject(BusinessObject parent,
                                           java.lang.String name,
                                           CustomObjectInfo descriptor)

Creates a BusinessObject.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

parent - parent of the BusinessObject

name - name of the BusinessObject

descriptor - an instance of CustomObjectDescriptor

Returns:

BusinessObject

Throws:

oracle.jbo.JboException - if a BusinessObject for the name already exists

deleteBusinessObject

public void deleteBusinessObject(BusinessObject bo)

Deletes a business object.

Specified by:

deleteBusinessObject in interface BusinessEditorManagerInterface

Parameters:

bo - the business object to be deleted.

getGlobalFunctions

public java.util.Collection<GlobalFunction> getGlobalFunctions()

Returns global functions.

Specified by:

getGlobalFunctions in interface BusinessEditorManagerInterface

Returns:

collection of global functions

findGlobalFunction

public GlobalFunction findGlobalFunction(java.lang.String name,
                                         java.lang.String... paramTypes)

Retrieves the global function with the given name. If there are multiple global functions with the given name, paramTypes must be used to specify the right global function to be returned. If no paramTypes is specified, a global function is returned if there is only one global function with the given name, or if there is one global function with the name that does not contain any parameter. If no global function is found for the given name, null is returned.

Specified by:

findGlobalFunction in interface BusinessEditorManagerInterface

Parameters:

name - name of the global function to be returned

paramTypes - parameters types for the function

Returns:

global function

findGlobalFunctions

public java.util.Collection<GlobalFunction> findGlobalFunctions(java.lang.String name)

Retrieves all global functions with the name.

Specified by:

findGlobalFunctions in interface BusinessEditorManagerInterface

Parameters:

name - name of the global functions to be returned

Returns:

global functions

createGlobalFunction

public GlobalFunction createGlobalFunction(java.lang.String name,
                                           java.lang.String returnType,
                                           java.lang.String body)

Creates a global function.

Specified by:

createGlobalFunction in interface BusinessEditorManagerInterface

Parameters:

name - name of the global function

returnType - return type

body - the function body

Returns:

the new globacl function

deleteGlobalFunction

public void deleteGlobalFunction(GlobalFunction function)

Deletes a global function.

Specified by:

deleteGlobalFunction in interface BusinessEditorManagerInterface

Parameters:

function - the global function to be deleted.

commit

public void commit()

Call commit() to save the changes of the current pending logical operation you are performing. An example of a logical operation includes creating a custom object, adding a custom field, adding a trigger, adding a validation rule, adding a object function, or performing the edit variants of these. When used in this way, all of the metadata changes saved for a single logical operation are atomic: that is, either all will succeed or all will fail. Therefore, at this time, the recommended usage of this API is to call commit() once per each logical transaction. If you ignore this recommendation and perform multiple logical operations before calling commit(), then this method attempts to individually save each logical operation performed since the last commit in a separate transaction. If any of the transactions performed results in an error, then the set of logical changes that you attempt to commit together will not represent an atomic operation. Some may be saved, while others are not.

Specified by:

commit in interface BusinessEditorManagerInterface

rollback

public void rollback()

Discard any changes since last commit.

Specified by:

rollback in interface BusinessEditorManagerInterface

release

public void release()

Releases the application module instance.

Specified by:

release in interface BusinessEditorManagerInterface