oracle.odi.domain.adapter.project

Interface IGlobalObjectHelper

public interface IGlobalObjectHelper

An interface which is a helper for finding and storing global objects.

Method Summary

Modifier and Type	Method and Description
java.util.Collection	findAllPropertyDefinitions(java.lang.String ownerClassName, java.lang.String name) Finds all property definitions (global or not) with the specified owner class and name.
IKnowledgeModule	findComponentKM(IProcedureUser procUser, IKnowledgeModule.ProcessingType direction, java.lang.String integrationType) Finds a KM by integration type.
IKnowledgeModule	findDefaultKM(IProcedureUser procUser, IKnowledgeModule.KMType type, IKnowledgeModule.ProcessingType direction) Finds a default KM by integration type.
java.util.List	findGlobalPersistentObjects(java.lang.Class type, java.lang.String key) Finds global persistent objects with the specified key.
IKnowledgeModule	findKM(IKnowledgeModule.KMType type, java.lang.String name) Finds a global KM by type and name.
java.util.List	findMapComponentsByType(java.lang.String componentTypeName) Finds all map components that are associated with the specified component type.
java.util.List	findMatchingCheckKMs(IProcedureUser procUser) Returns a list of all check KMs that can be assigned to the specified procedure owner object.
java.util.List	findMatchingKMs(IProcedureUser procUser, IKnowledgeModule.ProcessingType direction) Returns a list of all KMs that can be assigned to the specified procedure owner object.
java.util.List	findProperties(java.lang.Object repositoryInstanceObject, IPropertyDefinition propDef) Finds all properties that were created by the specified property definition.
IPropertyDefinition	findPropertyDefinition(java.lang.String ownerClassName, java.lang.String name) Finds a global property definition with the specified owner class and name.
java.util.List	getAllContexts() Gets all global context objects in the repository.
java.util.List	getAllLocations() Gets a list of all logical schema locations available in the repository.
java.util.List	getAllMappingDataTypes() Gets all mapping data types.
java.util.List	getAllTechnologies() Gets all technologies in repository.
java.util.List	getGlobalComponentKMs() Gets a list of all global mapping-related KMs that implement IKnowledgeModule interface.
java.util.List	getGlobalKMs(IKnowledgeModule.KMType kmtype) Gets a list of all global KMs of the specified type.
java.util.List	GetGlobalSequences() Gets a list of global sequences.
java.util.List	getGlobalUserFunctions() Gets a list of all globally defined user functions, that are not owned by a specific project.
java.util.List	getGlobalVariables() Gets a list of global variables.
ILogicalSchema	getLogicalSchema(java.lang.String name) Gets the logical schema location by name.
IKnowledgeModule	getSourceComponentKM(IProcedureUser procUser) Get the possible
boolean	isMatchingKM(IProcedureUser procUser, IKnowledgeModule km, IKnowledgeModule.ProcessingType direction, boolean validate) Returns true if the specified KM is a match for the specified procedure owner.

Method Detail

getGlobalComponentKMs

java.util.List getGlobalComponentKMs()
                              throws AdapterException

Gets a list of all global mapping-related KMs that implement IKnowledgeModule interface.

Returns:

list of global KMs

Throws:

AdapterException

getGlobalKMs

java.util.List getGlobalKMs(IKnowledgeModule.KMType kmtype)
                     throws AdapterException

Gets a list of all global KMs of the specified type.

Parameters:

kmtype - type of the KM, such as IKM, LKM, etc.

Returns:

list of global KMs

Throws:

AdapterException

findMatchingKMs

java.util.List findMatchingKMs(IProcedureUser procUser,
                               IKnowledgeModule.ProcessingType direction)
                        throws AdapterException

Returns a list of all KMs that can be assigned to the specified procedure owner object. The direction string is only required for procedure user types that support it.

Parameters:

procUser - procedure owner

direction - processing type of the KM (SOURCE, TARGET, BOTH, NONE)

Returns:

list of knowledge modules that match the procedure owner characteristics

Throws:

AdapterException

isMatchingKM

boolean isMatchingKM(IProcedureUser procUser,
                     IKnowledgeModule km,
                     IKnowledgeModule.ProcessingType direction,
                     boolean validate)
              throws AdapterException

Returns true if the specified KM is a match for the specified procedure owner.

Parameters:

procUser - procedure owner

km - specified KM to match with

validate - if true, switches on stricter checking for validation. This assumes that all the KMs have been assigned and validates the choices for generation. If false, then we will return true for some options that may be incompatible with other KM choices, but are OK to include on the domain list of available KMs.

Returns:

true if KM is a match, false otherwise

Throws:

AdapterException

findMatchingCheckKMs

java.util.List findMatchingCheckKMs(IProcedureUser procUser)
                             throws AdapterException

Returns a list of all check KMs that can be assigned to the specified procedure owner object. The direction string is only required for procedure user types that support it.

Parameters:

procUser - procedure owner

Returns:

list of knowledge modules that match the procedure owner characteristics

Throws:

AdapterException

findKM

IKnowledgeModule findKM(IKnowledgeModule.KMType type,
                        java.lang.String name)

Finds a global KM by type and name.

Parameters:

type - type of the KM ("COMPONENT KM", "IKM", "LKM", etc.). If null, then all types will be searched for a KM with a matching name.

name - name of the KM.

Returns:

list of matched KMs

Throws:

AdapterException

findComponentKM

IKnowledgeModule findComponentKM(IProcedureUser procUser,
                                 IKnowledgeModule.ProcessingType direction,
                                 java.lang.String integrationType)
                          throws AdapterException

Finds a KM by integration type. If there are 2 or more results, return the one which is marked as default.

Parameters:

procUser - procedure owner

direction - processing type of the KM (SOURCE, TARGET, BOTH, NONE)

integrationType - integration type of the KM

Returns:

KM object

Throws:

AdapterException

findDefaultKM

IKnowledgeModule findDefaultKM(IProcedureUser procUser,
                               IKnowledgeModule.KMType type,
                               IKnowledgeModule.ProcessingType direction)
                        throws AdapterException

Finds a default KM by integration type.

Parameters:

procUser - procedure owner

type - type of the KM ("COMPONENT KM", "IKM", "LKM", etc.)

direction - processing type of the KM (SOURCE, TARGET, BOTH, NONE)

Returns:

the KM object

Throws:

AdapterException

getSourceComponentKM

IKnowledgeModule getSourceComponentKM(IProcedureUser procUser)
                               throws AdapterException

Get the possible

Parameters:

node -

Returns:

Throws:

AdapterException

getAllContexts

java.util.List getAllContexts()
                       throws AdapterException

Gets all global context objects in the repository. If none, return an empty list.

Returns:

list of context objects

Throws:

AdapterException

getAllLocations

java.util.List getAllLocations()
                        throws AdapterException

Gets a list of all logical schema locations available in the repository. If none, return an empty list.

Returns:

list of logical schemas

Throws:

AdapterException

getLogicalSchema

ILogicalSchema getLogicalSchema(java.lang.String name)
                         throws AdapterException

Gets the logical schema location by name.

Parameters:

name - specific logical schema name

Returns:

the logical schema

Throws:

AdapterException

getGlobalUserFunctions

java.util.List getGlobalUserFunctions()
                               throws AdapterException

Gets a list of all globally defined user functions, that are not owned by a specific project.

Returns:

list of user functions

Throws:

AdapterException

getGlobalVariables

java.util.List getGlobalVariables()
                           throws AdapterException

Gets a list of global variables.

Returns:

list of variables

Throws:

AdapterException

GetGlobalSequences

java.util.List GetGlobalSequences()
                           throws AdapterException

Gets a list of global sequences.

Returns:

list of sequences

Throws:

AdapterException

findPropertyDefinition

IPropertyDefinition findPropertyDefinition(java.lang.String ownerClassName,
                                           java.lang.String name)
                                    throws AdapterException

Finds a global property definition with the specified owner class and name. Return null if not found.

Parameters:

ownerClassName - owner class name of the global property definition

name - name of the property definition

Returns:

the property definition

Throws:

AdapterException

findAllPropertyDefinitions

java.util.Collection findAllPropertyDefinitions(java.lang.String ownerClassName,
                                                java.lang.String name)
                                         throws AdapterException

Finds all property definitions (global or not) with the specified owner class and name. Return empty collection if not found.

Parameters:

ownerClassName - owner class name of the property definition

name - name of the property definition

Returns:

list of property definitions

Throws:

AdapterException

findProperties

java.util.List findProperties(java.lang.Object repositoryInstanceObject,
                              IPropertyDefinition propDef)
                       throws AdapterException

Finds all properties that were created by the specified property definition.

Parameters:

repositoryInstanceObject - repository-specific transaction manager object

propDef - property definition to be matched.

Returns:

list of properties

Throws:

AdapterException

findGlobalPersistentObjects

java.util.List findGlobalPersistentObjects(java.lang.Class type,
                                           java.lang.String key)
                                    throws AdapterException

Finds global persistent objects with the specified key. The key may have different meaning depending on the specific adapter and object type.

Parameters:

type - type of object

key - string key for the object, can be null.

Returns:

list of persistent objects

Throws:

AdapterException

findMapComponentsByType

java.util.List findMapComponentsByType(java.lang.String componentTypeName)
                                throws AdapterException

Finds all map components that are associated with the specified component type.

Parameters:

componentTypeName - name of component type

Returns:

list of map components

Throws:

AdapterException

getAllMappingDataTypes

java.util.List getAllMappingDataTypes()
                               throws AdapterException

Gets all mapping data types.

Returns:

list of data types

Throws:

AdapterException

getAllTechnologies

java.util.List getAllTechnologies()

Gets all technologies in repository.

Returns:

a list of all technologies