oracle.adfinternal.businesseditor.restapi

Class FunctionImpl

java.lang.Object

oracle.adfinternal.businesseditor.restapi.FunctionImpl

All Implemented Interfaces:

VOAttributesConstants

Direct Known Subclasses:

BusinessObjectFunctionImpl, GlobalFunctionImpl

public abstract class FunctionImpl
extends java.lang.Object

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
static class	FunctionImpl.FunctionMatcher

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
FunctionImpl(oracle.adfinternal.businesseditor.restapi.BaseObject owner, org.codehaus.jettison.json.JSONObject func)

Method Summary

Modifier and Type	Method and Description
FunctionParameter	addParameter(java.lang.String name, java.lang.String type)
protected org.codehaus.jettison.json.JSONObject	convertToJSON(java.lang.Object... attrNameAndValues)
protected <T> T	createChild(java.lang.String accessorName, java.lang.Class<T> type, org.codehaus.jettison.json.JSONObject obj)
protected void	deleteChild(BaseObject.Matcher matcher)
protected void	deleteChild(java.lang.String accessorName, java.lang.String childName)
void	deleteParameter(java.lang.String name)
void	doCreateNewChildren()
void	doDeleteChildren()
void	doSetAttributes()
boolean	equals(java.lang.Object obj)
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.
protected abstract java.lang.String	getAccessorNameFromOwner() Get the resource name that is used by the owner to access this type of object.
java.lang.String	getApiName()
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.lang.String	getBody()
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()
java.lang.String	getExample()
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.lang.String	getId()
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)
protected oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger	getLogger()
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.
java.util.Collection<FunctionParameter>	getParameters()
boolean	getPrivileged()
protected java.lang.String[]	getQueryKeys(java.lang.String accessorName) Different types of objects use different names to find a child object.
java.lang.String	getReturnType()
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	setBody(java.lang.String body)
void	setDescription(java.lang.String text)
void	setExample(java.lang.String example)
protected void	setLogger(oracle.adfinternal.model.logging.contextual.logger.functional.FunctionalLogger logger)
void	setName(java.lang.String name) Renames this object.
void	setPrivileged(boolean privileged)
void	setReturnType(java.lang.String returnType)
protected java.lang.String	toApiName(java.lang.String name)
static java.lang.String[]	toParamTypesArray(java.util.Collection<FunctionParameter> params)
void	undoChanges()
protected void	verifyObjectIsValid() Verifies if object is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionImpl

public FunctionImpl(oracle.adfinternal.businesseditor.restapi.BaseObject owner,
                    org.codehaus.jettison.json.JSONObject func)
             throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

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

toApiName

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

getApiName

public java.lang.String getApiName()

equals

public boolean equals(java.lang.Object obj)

setReturnType

public void setReturnType(java.lang.String returnType)

getReturnType

public java.lang.String getReturnType()

setExample

public void setExample(java.lang.String example)

getExample

public java.lang.String getExample()

setBody

public void setBody(java.lang.String body)

getBody

public java.lang.String getBody()

setPrivileged

public void setPrivileged(boolean privileged)

getPrivileged

public boolean getPrivileged()

getId

public java.lang.String getId()

getParameters

public java.util.Collection<FunctionParameter> getParameters()

addParameter

public FunctionParameter addParameter(java.lang.String name,
                                      java.lang.String type)

deleteParameter

public void deleteParameter(java.lang.String name)

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

toParamTypesArray

public static java.lang.String[] toParamTypesArray(java.util.Collection<FunctionParameter> params)

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

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

getLogger

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

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)

getAccessorNameFromOwner

protected abstract java.lang.String getAccessorNameFromOwner()

Get the resource name that is used by the owner to access this type of object. For example, it will return "BusinessObjects for a business object, "Fields" for an Attribute object.

Returns:

resource name the owner uses to access this type of 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()

getLocalizedString

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