oracle.adfinternal.businesseditor.restapi

Class BusinessEditorManagerImpl

java.lang.Object

oracle.adfinternal.businesseditor.restapi.BaseManagerImpl

oracle.adfinternal.businesseditor.restapi.BusinessEditorManagerImpl

All Implemented Interfaces:

BusinessEditorManagerInterface, BaseObject.Manager, VOAttributesConstants

public class BusinessEditorManagerImpl
extends BaseManagerImpl
implements BusinessEditorManagerInterface, BaseObject.Manager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseObject.ChildAlreadyExists
protected static interface	BaseObject.Manager
protected static class	BaseObject.Matcher
protected static class	BaseObject.STATE
protected static class	BaseObject.UnsupportedRestOperationException

Field Summary

Fields inherited from interface oracle.adfinternal.businesseditor.restapi.VOAttributesConstants

ADDL_LIST_DISPLAY_FIELDS, ADDL_LIST_SEARCH_FIELDS, API_NAME, BODY, CHILD_LOOKUP_CODES, DATA_FILTERS, DATETIME_DISPLAY_TYPE, DECIMAL_PLACES, DEFAULT_VALUE, DEFINITION, DEPENDENCY_FIELDS, DESCRIPTION, DISPLAY_HEIGHT, DISPLAY_LABEL, DISPLAY_LABEL_PLURAL, DISPLAY_SEQUENCE, DISPLAY_WIDTH, ENABLED, END_DATE_ACTIVE, ERROR_MESSAGE, EXAMPLE, EXPRESSION, FIELDS, FORMULA_TYPE, FULL_NAME, FUNCTION_ID, FUNCTIONS, GLOBAL_FUNCTIONS, HELP_TEXT, ID, INDEXED, IS_CUSTOM, IS_MULTISELECT_PICKLIST, LIST_DISPLAY_FIELD, LIST_OBJECT, LOOKUP_CODE, LOOKUP_TYPE, LOOKUP_TYPES, LOOKUPS, MATCH_CASE, MAX_LENGTH, MAX_VALUE, MEANING, MIN_LENGTH, MIN_VALUE, NAME, OBJECTS, OPERATOR, PARAMETERS, PARENT_BUSINESS_OBJECT, PARENT_LOOKUP_CODE, PARENT_PICKLIST, PICKLIST_LOOKUP_TYPE, PRIVILEGE, PUBLISHED_AS_REST, RECORD_NAME_LABEL, REQUIRED, REQUIRED_EXPRESSION, RETURN_TYPE, SEARCH_FIELD_API_NAME, SORT_BY, SORT_BY_ASCENDING, START_DATE_ACTIVE, TRIGGERS, TYPE, UPDATABLE, UPDATABLE_EXPRESSION, VALIDATORS, VALUE_MAP, VALUE1, VALUE2, VISIBILITY_PROPERTY

Constructor Summary

Constructors

Constructor and Description
BusinessEditorManagerImpl()

Method Summary

Modifier and Type	Method and Description
protected org.codehaus.jettison.json.JSONObject	convertToJSON(java.lang.Object... attrNameAndValues)
BusinessObject	createBusinessObject(BusinessObject parent, java.lang.String name) Creates a BusinessObject.
BusinessObject	createBusinessObject(BusinessObject parent, java.lang.String name, CustomObjectInfo descriptor) Creates a BusinessObject.Throws JboException if a BusinessObject for the name already exists.
BusinessObject	createBusinessObject(java.lang.String name) Creates a BusinessObject.
BusinessObject	createBusinessObject(java.lang.String name, CustomObjectInfo descriptor) Creates a BusinessObject.
protected <T> T	createChild(java.lang.String accessorName, java.lang.Class<T> type, org.codehaus.jettison.json.JSONObject obj)
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.
protected void	deleteChild(BaseObject.Matcher matcher)
protected void	deleteChild(java.lang.String accessorName, java.lang.String childName)
void	deleteGlobalFunction(GlobalFunction function) Deletes a global function.
void	doCreateNewChildren()
void	doDeleteChildren()
void	doSetAttributes()
boolean	equals(java.lang.Object obj)
BusinessObject	findBusinessObject(java.lang.String name) Finds the existing BusinessObject for the given name.
protected <T> T	findChild(java.lang.Class<T> type, BaseObject.Matcher matcher)
protected <T> T	findChild(java.lang.String accessorName, java.lang.String childName, java.lang.Class<T> type)
protected <T> java.util.List<T>	findChildren(java.lang.Class<T> type, BaseObject.Matcher matcher) Find all children objects matching the given Matcher.
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.
protected java.lang.Object	getAttribute(java.lang.String attrName)
protected java.lang.Object	getAttribute(java.lang.String attrName, java.lang.Object defaultValue) Get the attribute value for the given attribute name.
java.util.Collection<BusinessObject>	getBusinessObjects() Returns all customizable buiness objects, and the reference-only business objects that contain attributes that can be used for the display and search attribute for dynamic choice list.
protected <T> java.util.Collection<T>	getChildren(java.lang.String accessorName, java.lang.Class<T> type)
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenDeleted(BaseObject.Matcher childMatcher)
protected org.codehaus.jettison.json.JSONArray	getChildrenJSON(java.lang.String accessorName) Get all children of a given type defined by accessorName.
protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject>	getChildrenNew(BaseObject.Matcher childMatcher)
java.lang.String	getDescription()
protected java.lang.String	getFinderKey(java.lang.String accessorName) Get the key whose value defines the resource name for this object in URL path
java.util.Collection<GlobalFunction>	getGlobalFunctions() Returns global functions.
protected java.lang.String	getInternalName() Name that will represent the resource id for this object.
static java.lang.String	getLocalizedString(java.lang.String key, java.lang.Object... args)
BaseObject.Matcher	getMatcher() Get a Matcher that is used to compare with another object.
java.lang.String	getName()
protected oracle.adfinternal.businesseditor.restapi.BaseObject	getOwner() Get the container object that contains this object.
protected java.lang.String[]	getQueryKeys(java.lang.String accessorName) Different types of objects use different names to find a child object.
protected BaseObject.STATE	getState()
protected <T> T	initChildObject(java.lang.String accessorName, org.codehaus.jettison.json.JSONObject child, java.lang.Class<T> type) Various methods that return child object needs to create the child object.
boolean	isNew()
protected void	setAttribute(java.lang.String attrName, java.lang.Object value)
void	setDescription(java.lang.String text)
protected void	setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)
void	setName(java.lang.String name) Renames this object.
protected java.lang.String	toApiName(java.lang.String name)
void	undoChanges()
protected void	verifyObjectIsValid() Verifies if object is valid.

Methods inherited from class oracle.adfinternal.businesseditor.restapi.BaseManagerImpl

addDirtyObject, commit, getAccessorNameFromOwner, getLogger, release, rollback

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.adfinternal.businesseditor.objects.BusinessEditorManagerInterface

commit, release, rollback

Methods inherited from interface oracle.adfinternal.businesseditor.restapi.BaseObject.Manager

addDirtyObject

Constructor Detail

BusinessEditorManagerImpl

public BusinessEditorManagerImpl()

Method Detail

getBusinessObjects

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

Description copied from interface: BusinessEditorManagerInterface

Returns all customizable buiness 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)

Description copied from interface: BusinessEditorManagerInterface

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 look for

Returns:

BusinessObject

createBusinessObject

public BusinessObject createBusinessObject(java.lang.String name)

Description copied from interface: BusinessEditorManagerInterface

Creates a BusinessObject. Throws JboException if a BusinessObject for the name already exists.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

name - name of the BusinessObject

Returns:

BusinessObject

createBusinessObject

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

Description copied from interface: BusinessEditorManagerInterface

Creates a BusinessObject. Throws JboException if a BusinessObject for the name already exists.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

name - name of the BusinessObject

descriptor - an instance of CustomObjectDescriptor

Returns:

BusinessObject

createBusinessObject

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

Description copied from interface: BusinessEditorManagerInterface

Creates a BusinessObject. Throws JboException if a BusinessObject for the name already exists.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

parent - parent of the BusinessObject

name - name of the BusinessObject

Returns:

BusinessObject

createBusinessObject

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

Description copied from interface: BusinessEditorManagerInterface

Creates a BusinessObject.Throws JboException if a BusinessObject for the name already exists.

Specified by:

createBusinessObject in interface BusinessEditorManagerInterface

Parameters:

parent - parent of the BusinessObject

name - name of the BusinessObject

descriptor - an instance of CustomObjectDescriptor

Returns:

BusinessObject

deleteBusinessObject

public void deleteBusinessObject(BusinessObject bo)

Description copied from interface: BusinessEditorManagerInterface

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()

Description copied from interface: BusinessEditorManagerInterface

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)

Description copied from interface: BusinessEditorManagerInterface

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)

Description copied from interface: BusinessEditorManagerInterface

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)

Description copied from interface: BusinessEditorManagerInterface

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 global function

deleteGlobalFunction

public void deleteGlobalFunction(GlobalFunction function)

Description copied from interface: BusinessEditorManagerInterface

Deletes a global function.

Specified by:

deleteGlobalFunction in interface BusinessEditorManagerInterface

Parameters:

function - the global function to be deleted.

initChildObject

protected <T> T initChildObject(java.lang.String accessorName,
                                org.codehaus.jettison.json.JSONObject child,
                                java.lang.Class<T> type)

Various methods that return child object needs to create the child object. It is best known to the owning object. Hence to be implemented by the owning object.

Type Parameters:

T - Class that is expected type of the returned child object.

Parameters:

accessorName - resource name used to access the child

child - JSON structure of the child object

type - Class instance of the expected type of child object

Returns:

an instance of BaseObject that represents the child

getOwner

protected oracle.adfinternal.businesseditor.restapi.BaseObject getOwner()

Get the container object that contains this object. This will be null for containers of root level objects such as BusinessEditorManager, LookupManager. It should not return null for all other objects as it is used to construct the ReST request URL path.

Returns:

object that contains this object

getQueryKeys

protected java.lang.String[] getQueryKeys(java.lang.String accessorName)

Different types of objects use different names to find a child object. For example, BusinessEditorManager.findBusinessObject(String name) may use either FullName or just simple Name attribute value of the BusinessObject in the search. LookupManager.findLookupType(String code) will use LookupType attribute as the code.

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attributes whose values are used for matching the parameter in findChild

getFinderKey

protected java.lang.String getFinderKey(java.lang.String accessorName)

Get the key whose value defines the resource name for this object in URL path

Parameters:

accessorName - the resource name to reach a particular type of child object

Returns:

attribute whose value will be used as the resource name of this object

getInternalName

protected final java.lang.String getInternalName()

Name that will represent the resource id for this object. This will be typically the value of the primary/finder key. The name is initialized during constructor of the object based on the JSON structure and the finder key value. This is not necessarily the name returned by getName() or the name that is used to identify the object in a findChild.

Returns:

resource name that represents this object in a ReST URL path

toApiName

protected java.lang.String toApiName(java.lang.String name)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Renames this object. It throws BaseObject.ChildAlreadyExists if there is a name clash. Whether the name can be overloaded or not is left to the findChild(Class, Matcher)

Parameters:

name - new name

setDescription

public void setDescription(java.lang.String text)

getDescription

public java.lang.String getDescription()

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName)

verifyObjectIsValid

protected void verifyObjectIsValid()

Verifies if object is valid. An existing object can become invalid if it is deleted. A newly created object will become invalid if transaction is rolled back before commit.

Throws:

oracle.jbo.JboException - if object is invalid

getAttribute

protected java.lang.Object getAttribute(java.lang.String attrName,
                                        java.lang.Object defaultValue)

Get the attribute value for the given attribute name. Return defaultValue if the value is null.

Parameters:

attrName - name of attribute

defaultValue - default value

Returns:

attribute value of attribute attrName

setLogger

protected void setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)

getState

protected BaseObject.STATE getState()

isNew

public boolean isNew()

setAttribute

protected void setAttribute(java.lang.String attrName,
                            java.lang.Object value)

getMatcher

public BaseObject.Matcher getMatcher()

Get a Matcher that is used to compare with another object. This is different from equals(Object) which does a finer comparision of the whole URL path. For example, functions from global functions or different business objects might match in signature but not equal as their URL path will be different.

Returns:

gets a Matcher that would typically match this object

getChildrenDeleted

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenDeleted(BaseObject.Matcher childMatcher)

getChildrenNew

protected java.util.List<oracle.adfinternal.businesseditor.restapi.BaseObject> getChildrenNew(BaseObject.Matcher childMatcher)

findChild

protected <T> T findChild(java.lang.String accessorName,
                          java.lang.String childName,
                          java.lang.Class<T> type)

findChild

protected <T> T findChild(java.lang.Class<T> type,
                          BaseObject.Matcher matcher)

findChildren

protected <T> java.util.List<T> findChildren(java.lang.Class<T> type,
                                             BaseObject.Matcher matcher)

Find all children objects matching the given Matcher. This function does not call getChildren() since getChildren() gets an entire list and thus the call can be heavy on network traffic unnecessarily.

Type Parameters:

T - Class that is expected type of the returned children objects.

Parameters:

type - Class instance of type T

matcher - Matcher that is used to find the correct children

Returns:

list of children of given type and matching the given Matcher

getChildrenJSON

protected org.codehaus.jettison.json.JSONArray getChildrenJSON(java.lang.String accessorName)
                                                        throws java.lang.Exception

Get all children of a given type defined by accessorName. The children are in JSON array structure.

Parameters:

accessorName - resource name or type of the children objects

Returns:

array of children in JSON structure

Throws:

java.lang.Exception - if any thrown by the GET request

getChildren

protected <T> java.util.Collection<T> getChildren(java.lang.String accessorName,
                                                  java.lang.Class<T> type)

createChild

protected <T> T createChild(java.lang.String accessorName,
                            java.lang.Class<T> type,
                            org.codehaus.jettison.json.JSONObject obj)

deleteChild

protected void deleteChild(java.lang.String accessorName,
                           java.lang.String childName)

deleteChild

protected void deleteChild(BaseObject.Matcher matcher)

convertToJSON

protected org.codehaus.jettison.json.JSONObject convertToJSON(java.lang.Object... attrNameAndValues)

doDeleteChildren

public void doDeleteChildren()

doCreateNewChildren

public void doCreateNewChildren()

doSetAttributes

public void doSetAttributes()

undoChanges

public void undoChanges()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getLocalizedString

public static java.lang.String getLocalizedString(java.lang.String key,
                                                  java.lang.Object... args)