oracle.jbo.server

Class OperationDefinitionsImpl

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.OperationDefinitionsImpl

All Implemented Interfaces:

java.io.Serializable, DiffMergeable, DiffSkippable, DefPersistable, PersistentDefinition, OperationDefinitions, PropertyManager, OperationSupplier, VariableManagerOwner, VariableManagerOwnerBase

public final class OperationDefinitionsImpl
extends DefObject
implements OperationDefinitions, OperationSupplier

This class represents the metadata for a collection of operation definitions. If a component object has operations, and its definition object has metadata for those operations, then it can be accessed using the method findOperationDefinitions(ComponentObject)

Since:

release specific (what release of product did this appear in)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

Fields inherited from class oracle.jbo.mom.PersistableDefObject

JIT_PACKAGE_NAME, mDebugToSkipEmptyDocForBug24949961, mEditedProperties, mEditedPropertyExprs

Fields inherited from class oracle.jbo.mom.DefinitionObject

DEF_MDS_CLIENT_KEY, DEF_SCOPE_ALL, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, DEF_SCOPE_SITE, DEF_SCOPE_USER, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
OperationDefinitionsImpl(int scope, java.lang.String operType, java.lang.String fullName) For internal framework use only.
OperationDefinitionsImpl(OperationDefinitionsImpl operDefs)
OperationDefinitionsImpl(java.lang.String operType) For internal framework use only.

Method Summary

Modifier and Type	Method and Description
OperationDefinitionImpl	addGroovyOperation(java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body) For internal framework use only.
OperationDefinitionImpl	addOperation(OperationDefinitionImpl opDef) For internal framework use only.
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
static DifferDetails	diffChildrenOpDefList(DiffMergeable docDef, DiffMergeable editDef, DiffMergeable orgDef, DifferDetails difDetails)
static OperationDefinitions	findOperationDefinitions(ComponentObject componentObject) For internal framework use only.
java.lang.String[]	findParameterNames(java.lang.reflect.Method method) For internal framework use only.
java.lang.String[]	findParameterNames(java.lang.String signature) For internal framework use only.
static OperationDefinitions	findRowOperationDefinitions(Row componentObject) For internal framework use only.
int	getDefTypeId()
java.lang.String	getDefXMLElementTag() For internal framework use only.
java.lang.String	getDefXMLNameSpace() For internal framework use only.
java.lang.Class	getMessageBundleClass()
OperationDefinitionImpl	getOperation(int index)
ExprEval	getOperationEvaluator(java.lang.String name, java.lang.Class... types)
ExprEval	getOperationEvaluatorWithArgs(java.lang.String name, java.lang.Object... args)
java.util.HashMap<java.lang.String,OperationDefinitionImpl>	getOperations() For internal framework use only.
OperationDefinitions	getOperDefValues()
java.lang.String	getOwnerName() For internal framework use only.
ResourceBundleDef	getResourceBundleDef()
static java.lang.String	getSignature(java.lang.reflect.Method method)
java.util.List<OperationDefinitionImpl>	getSortedOperations()
java.lang.String	getXMLElementTag() For internal framework use only.
boolean	hasOperation(java.lang.String methodName)
static OperationDefinitions	loadOperationDefinitions(DefElement xmlElement, java.lang.String name) For internal framework use only.
void	loadOperations(OperationDefinitionsImpl opDefs)
void	loadXMLContents(DefElement xmlElement, java.lang.String fullNameFromParent) For internal framework use only.
OperationDefinitionImpl	lookupOperationDefinition(java.lang.String name)
OperationDefinitionImpl	lookupOperationDefinitionbySignature(java.lang.String signature)
void	personalizeOperations(OperationDefinitionsImpl opDefs)
OperationDefinitionImpl	removeOperation(java.lang.String name) For internal framework use only.
void	resolveDefObject()
void	setContentType(java.lang.String contentType)
protected void	setDefForComponent(ComponentObjectImpl comp) For internal framework use only.
void	setFullName(java.lang.String fullName) For internal framework use only.
void	setParent(NamedObjectImpl parent) Sets this object's parent.
protected void	unsetDefForComponent(ComponentObjectImpl comp) For internal framework use only.
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage
void	writeContents(DefWriter jos) Objects should write their persistence output in this method
void	writeObject(DefWriter jos) For internal framework use only.

Methods inherited from class oracle.jbo.server.DefObject

addChildren, callFinishedLoading, ensureVariableManager, finishedLoading, getAdfmConfigStartupProperty, getAllProperties, getBaseDefObject, getBooleanAdfmConfigProperty, getVariableManager, getVarMgrParents, hasVariables, isDeprecated, isFromCustomization, loadProperties, loadVariables, resolvePropertyRaw, resolveReferences, setBaseDefObject, setBaseDefObject, setName

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePDef, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, baseIsWriteObject, beginDiffObjects, buildChildName, buildFileName, checkEditable, checkEditableWithDefWriter, checkStructWithOld, close, createEditPDef, createFromXML, deregisterDefObject, deregisterHLDef, deregisterSessionObject, diffChildrenHLDefs, diffChildrenProperties, diffContents, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, forgetChanges, getBaseDir, getBasePackage, getChildren, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDifferSkip, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getHLDefMap, getIdentificationAttributeName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getPropertyNamesSet, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isAutoMerged, isCreateEditPDef, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isFromTip, isInheritPolicyStrict, isLoadBase, isLoadHLDefs, isMajorVersionChanged, isMinorVersionChanged, isNew, isNewRecurse, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, isSaveToJSON, isSkipWrite, isWriteObject, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, lookupHLDef, makeNew, mergeChanges, mergeEditedPropertiesForJSON, mergePropertyMap, objectRemoved, postSaveContents, readJSONObject, reapplyChanges, registerClass, registerDefObject, registerHLDef, registerSessionDefObject, registerSiteDefObject, reloadFromXMLContents, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveJSONContents, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setEditableFlag, setEditableObject, setForRuntime, setFullNameInternal, setLoadBase, setLoadHLDefs, setMajorVersionChanged, setNew, setNewRecurse, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setSkipWrite, setupDefWriterFromMO, setWholeDefDirty, setWholeDefNew, staticUpdateChildrenList, transferDefChangesInto, unlockDefinitionContext, updateChildObject, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeHeaderForNew, writeJSONContents, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getMdsReferenceName, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, objectFound, objectInserted, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyExprEval, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setPropertiesMap, setPropertiesMap2, setProperty, setPropertyExpressionMap, setRawPropertyValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.VariableManagerOwner

getName

Methods inherited from interface oracle.jbo.mom.xml.DefPersistable

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

OperationDefinitionsImpl

@Concealed
public OperationDefinitionsImpl(java.lang.String operType)

For internal framework use only.

For internal use only. Application developers should not use this

OperationDefinitionsImpl

@Concealed
public OperationDefinitionsImpl(int scope,
                                           java.lang.String operType,
                                           java.lang.String fullName)

For internal framework use only.

For internal use only. Application developers should not use this

OperationDefinitionsImpl

@Concealed
public OperationDefinitionsImpl(OperationDefinitionsImpl operDefs)

For internal use only. Application developers should not use this

Method Detail

getSignature

public static java.lang.String getSignature(java.lang.reflect.Method method)

findOperationDefinitions

@Concealed
public static OperationDefinitions findOperationDefinitions(ComponentObject componentObject)

For internal framework use only.

For internal use only. Application developers should not use this

findRowOperationDefinitions

@Concealed
public static OperationDefinitions findRowOperationDefinitions(Row componentObject)

For internal framework use only.

For internal use only. Application developers should not use this

hasOperation

public boolean hasOperation(java.lang.String methodName)

Specified by:

hasOperation in interface OperationSupplier

loadOperationDefinitions

@Concealed
public static OperationDefinitions loadOperationDefinitions(DefElement xmlElement,
                                                                       java.lang.String name)

For internal framework use only.

For internal use only. Application developers should not use this

setContentType

@Concealed
public void setContentType(java.lang.String contentType)

For internal use only. Application developers should not use this

findParameterNames

@Concealed
public java.lang.String[] findParameterNames(java.lang.reflect.Method method)

For internal framework use only.

Specified by:

findParameterNames in interface OperationDefinitions

Returns:

null if the method is not implemented, or if no metadata is available

For internal use only. Application developers should not use this

findParameterNames

@Concealed
public java.lang.String[] findParameterNames(java.lang.String signature)

For internal framework use only.

For internal use only. Application developers should not use this

getOperDefValues

public OperationDefinitions getOperDefValues()

getOperations

@Restricted
public java.util.HashMap<java.lang.String,OperationDefinitionImpl> getOperations()

For internal framework use only.

For internal use only. Application developers should not use this

getSortedOperations

public java.util.List<OperationDefinitionImpl> getSortedOperations()

loadOperations

@Concealed
public void loadOperations(OperationDefinitionsImpl opDefs)

For internal use only. Application developers should not use this

personalizeOperations

@Concealed
public void personalizeOperations(OperationDefinitionsImpl opDefs)

For internal use only. Application developers should not use this

addOperation

@Concealed
public OperationDefinitionImpl addOperation(OperationDefinitionImpl opDef)

For internal framework use only.

For internal use only. Application developers should not use this

setParent

@Concealed
public void setParent(NamedObjectImpl parent)

Description copied from class: DefObject

Sets this object's parent.

Overrides:

setParent in class DefObject

Parameters:

parent - the named object that is to be the parent of this object.

For internal use only. Application developers should not use this

resolveDefObject

@Concealed
public void resolveDefObject()

For internal use only. Application developers should not use this

addGroovyOperation

@Concealed
public OperationDefinitionImpl addGroovyOperation(java.lang.String name,
                                                             java.lang.String returnType,
                                                             java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
                                                             java.lang.String body)

For internal framework use only.

For internal use only. Application developers should not use this

removeOperation

@Concealed
public OperationDefinitionImpl removeOperation(java.lang.String name)

For internal framework use only.

For internal use only. Application developers should not use this

lookupOperationDefinition

@Concealed
public OperationDefinitionImpl lookupOperationDefinition(java.lang.String name)

For internal use only. Application developers should not use this

lookupOperationDefinitionbySignature

public OperationDefinitionImpl lookupOperationDefinitionbySignature(java.lang.String signature)

getDefXMLElementTag

@Concealed
public java.lang.String getDefXMLElementTag()

For internal framework use only.

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

For internal use only. Application developers should not use this

getXMLElementTag

@Concealed
public java.lang.String getXMLElementTag()

For internal framework use only.

Specified by:

getXMLElementTag in interface PersistentDefinition

Overrides:

getXMLElementTag in class PersistableDefObject

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

For internal use only. Application developers should not use this

getDefXMLNameSpace

@Concealed
public java.lang.String getDefXMLNameSpace()

For internal framework use only.

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class DefObject

For internal use only. Application developers should not use this

setFullName

@Concealed
public void setFullName(java.lang.String fullName)

For internal framework use only.

Overrides:

setFullName in class PersistableDefObject

Parameters:

fullName - this object's fully-qualified name; the package name concatenated with the class name.

For internal use only. Application developers should not use this

getOwnerName

@Concealed
public java.lang.String getOwnerName()

For internal framework use only.

For internal use only. Application developers should not use this

writeObject

@Concealed
public void writeObject(DefWriter jos)

For internal framework use only.

Specified by:

writeObject in interface PersistentDefinition

Overrides:

writeObject in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

For internal use only. Application developers should not use this

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

For internal framework use only.

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

For internal framework use only.

Specified by:

unsetDefForComponent in class DefObject

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

Specified by:

getResourceBundleDef in interface VariableManagerOwnerBase

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

Specified by:

getMessageBundleClass in interface VariableManagerOwnerBase

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Overrides:

writeContents in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Overrides:

writeChildren in class DefObject

Parameters:

jos - the Output storage for persistence

loadXMLContents

@Concealed
public void loadXMLContents(DefElement xmlElement,
                                       java.lang.String fullNameFromParent)

For internal framework use only.

Overrides:

loadXMLContents in class PersistableDefObject

For internal use only. Application developers should not use this

diffChildrenOpDefList

public static DifferDetails diffChildrenOpDefList(DiffMergeable docDef,
                                                  DiffMergeable editDef,
                                                  DiffMergeable orgDef,
                                                  DifferDetails difDetails)

diffChildren

public DifferDetails diffChildren(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

Overrides:

diffChildren in class DefObject

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue(<XML-tag-for-Child1>);

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

Overrides:

applyDiffChildren in class DefObject

getOperation

@Concealed
public OperationDefinitionImpl getOperation(int index)

For internal use only. Application developers should not use this

getOperationEvaluator

public ExprEval getOperationEvaluator(java.lang.String name,
                                      java.lang.Class... types)

Specified by:

getOperationEvaluator in interface OperationSupplier

getOperationEvaluatorWithArgs

public ExprEval getOperationEvaluatorWithArgs(java.lang.String name,
                                              java.lang.Object... args)

Specified by:

getOperationEvaluatorWithArgs in interface OperationSupplier