com.highqsoft.ascoba

Class CopyInstancesWithRelatedRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.ascoba.AscobaAbstractRule

com.highqsoft.ascoba.CopyInstancesAbstractRule

com.highqsoft.ascoba.CopyInstancesWithRelatedRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class CopyInstancesWithRelatedRule
extends CopyInstancesAbstractRule

This rule copies the instances from the source to the target session. For more details see \ref rules_com_highqsoft_ascoba_CopyInstancesWithRelatedRule

Since:

$Date: 2017/04/06 13:28:21 $

Version:

$Revision: 1.6 $

Author:

Karst Schaap

Field Summary

Fields inherited from class com.highqsoft.ascoba.CopyInstancesAbstractRule

aeIdMap, checkInstElem, copyInstanceAttributes, skipId, skipValues, targetSess, useGetValueSeq, userGroupMap, withSecurity

Fields inherited from class com.highqsoft.ascoba.AscobaAbstractRule

elementName, handledMap, messenger, sourceSess, useDestroy

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
CopyInstancesWithRelatedRule()

Method Summary

Methods

Modifier and Type	Method and Description
NameValueUnit[][]	getValue() ElementToRule, nothing to do at getValue()
void	init() The initialization of the rule.
protected InstanceElement	instanceElementCopyRelated(InstanceElement ie, ApplicationStructure sourceAs, ApplicationStructure targetAs, boolean copyChild, InstanceElement ieTargetFather) Copy an instance element from the source instance element structure to the target instance element structure.
void	setValue(NameValueUnit[][] nvu) Set the value.
void	terminate() The terminate method, reset the local variables.

Methods inherited from class com.highqsoft.ascoba.CopyInstancesAbstractRule

copyInitialRights, copyRights, createCopiedInstance, getAttributeDatatype, getAttributName, getTargetAID, getTargetUserGroup, init, linkRelated, listAttributes, listElementAttributes, loadFromTarget, terminate

Methods inherited from class com.highqsoft.ascoba.AscobaAbstractRule

addCopied, addHandledId, checkHandledId, destroy, destroy, execute, getCopiedTarget, getIds, getIds, getIdValue, getTargetApplicationRelation, setValue, stactTraceToString

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

CopyInstancesWithRelatedRule

public CopyInstancesWithRelatedRule()

Method Detail

getValue

public NameValueUnit[][] getValue()

ElementToRule, nothing to do at getValue()

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class CopyInstancesAbstractRule

Returns:

The name value of the rule.

See Also:

RuleIF.getValue()

instanceElementCopyRelated

protected InstanceElement instanceElementCopyRelated(InstanceElement ie,
                                         ApplicationStructure sourceAs,
                                         ApplicationStructure targetAs,
                                         boolean copyChild,
                                         InstanceElement ieTargetFather)
                                              throws AoException

Copy an instance element from the source instance element structure to the target instance element structure. The father instances are also copied. Instances of the AoExternalComponent are not copied. If the instance is already in the target application structure the instance will not be copied. This method is not performance optimized.

Parameters:

ie - the instance element to be copied

sourceAs - the source application structure

targetAs - the target application structure

copyChild - copy also the child instances.

ieTargetFather - the instance element with a FATHER relation to the parameter "ie"

Throws:

AoException - thrown when an ASAM ODS Exception occurs

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

Set the value.

Specified by:

setValue in interface RuleIF

Overrides:

setValue in class AscobaAbstractRule

Parameters:

nvu - - the attribute values of the instances of the element of the rule.

Throws:

RuleException

See Also:

RuleIF.setValue(org.asam.ods.NameValueUnit[][])

init

public void init()
          throws InitializationFailedException

The initialization of the rule. The element name, the reference of the OdsCache and the insert mode is loaded from the context.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

See Also:

AbstractImplementation.init()

terminate

public void terminate()
               throws TerminationException

The terminate method, reset the local variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()