oracle.owb.reconcile
Interface ReconcileService

public interface ReconcileService

ReconcileService is the core interface for the reconcile process. It exposes methods to reconcile objects of different types.

Method Summary

void	executeActionPlan(ReconcileActionPlan actPlan) Method executeActionPlan.
MatchingStrategy	findMatchingStrategy(ReconcileSource source, ReconcileTarget target, java.lang.String matchingStrategyName) Method findMatchingStrategy.
ReconcileActionPlan	getActionPlan(ReconcileSource source, ReconcileTarget target, ReconcileStrategy recStrategy, java.lang.String matchStrategy) Method getActionPlan.
java.lang.String[]	getAvailableMatchingStrategies(ReconcileSource source, ReconcileTarget target) Method getAvailableMatchingStrategies.
ReconcileStrategy	getReconcileStrategy() Method getReconcileStrategy.
boolean	isReconcilable(ReconcileSource src, ReconcileTarget tgt) Method isReconcilable.
void	reconcile(ReconcileSource source, ReconcileTarget target, ReconcileStrategy recStrategy, java.lang.String matchStrategy) Method reconcile.

Method Detail

reconcile

public void reconcile(ReconcileSource source,
                      ReconcileTarget target,
                      ReconcileStrategy recStrategy,
                      java.lang.String matchStrategy)
               throws InvalidSourceException,
                      InvalidTargetException,
                      IncompatibleTypesException

Method reconcile. Reconciles the target metadata definition with that of the source. The target should have been locked by the caller of the service as it would be modified.

Parameters:

source - source of metadata

target - target object whose metadata needs to be updated

recStrategy - the reconcile strategy to be used for reconciliation

matchStrategy - the matching strategy to compare the source and target

Throws:

InvalidSourceException - if the source is not valid

InvalidTargetException - if the target is not valid

IncompatibleTypesException - if the source and target types cannot be reconciled

isReconcilable

public boolean isReconcilable(ReconcileSource src,
                              ReconcileTarget tgt)
                       throws InvalidSourceException,
                              InvalidTargetException

Method isReconcilable.

Parameters:

source - source object of metadata

target - target object whose metadata needs to be updated

Returns:

boolean true, if target can be reconciled with source

Throws:

InvalidSourceException - if the source is not valid

InvalidTargetException - if the target is not valid

getActionPlan

public ReconcileActionPlan getActionPlan(ReconcileSource source,
                                         ReconcileTarget target,
                                         ReconcileStrategy recStrategy,
                                         java.lang.String matchStrategy)
                                  throws InvalidSourceException,
                                         InvalidTargetException,
                                         IncompatibleTypesException

Method getActionPlan. Returns the action plan containing a list of actions to be applied on the target. The target object must be locked before calling this method.

Parameters:

source - source object of metadata

target - target object whose metadata needs to be updated

recStrategy - the reconcile strategy to be used for reconciliation

matchStrategythe - matching strategy to compare the source and target

Returns:

ActionPlan

Throws:

InvalidSourceException - if the source is not valid

InvalidTargetException - if the target is not valid

IncompatibleTypesException - - if the source and target types cannot be reconciled

executeActionPlan

public void executeActionPlan(ReconcileActionPlan actPlan)
                       throws InvalidSourceException,
                              InvalidTargetException

Method executeActionPlan. Executes the action plan passed in. The action plan would be used by the reconcile service to modify the target metadata definition with that of the source. The caller must ensure that the target object has been locked before calling this method.

Parameters:

actPlan - - the action plan computed for the specified source and target combination.

Throws:

InvalidSourceException - if the source is not valid

InvalidTargetException - if the target is not valid

getReconcileStrategy

public ReconcileStrategy getReconcileStrategy()

Method getReconcileStrategy. Returns the reconcile strategy object.

Returns:

ReconcileStrategy

getAvailableMatchingStrategies

public java.lang.String[] getAvailableMatchingStrategies(ReconcileSource source,
                                                         ReconcileTarget target)

Method getAvailableMatchingStrategies. Returns the matching strategies available for the source - target combination

Parameters:

source - source object of metadata

target - target object whose metadata needs to be updated

Returns:

String[]

findMatchingStrategy

public MatchingStrategy findMatchingStrategy(ReconcileSource source,
                                             ReconcileTarget target,
                                             java.lang.String matchingStrategyName)
                                      throws MatchingStrategyNotFoundException

Method findMatchingStrategy.

Parameters:

source - source object of metadata

target - target object whose metadata needs to be updated

matchingStrategyName - - the name of the matching strategy

Returns:

MatchingStrategy

Throws:

MatchingStrategyNotFoundException - - if the matching strategy specified by matchingStrategyName is not found.