com.highqsoft.asamcommander.momax.rules

Class ModifyEnumImplementation

java.lang.Object

com.highqsoft.asamcommander.momax.rules.ModifyEnumImplementation

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class ModifyEnumImplementation
extends java.lang.Object
implements ExecutableIF

This rule is a generic rule for any model. Its purpose is to set an enumeration attribute of one or more instances to a new value.
The Rule requires the following arguments from the MoMa:

Name	Description
sourcesession	the reference to use to get the source session.
Elementid	A String Version of one or more ElemIds as supplied by the MoMaX plugin.
ElementName	The Name of the Application Element whose instances will be modified. If the Element does not match with the AID of the ElemIds, the rule abort.
AttributeName	The Application name of the ENUM Attribute.
NewEnumValue	The new value to set to the attribute. Must be a vliad integer.

This implementation does NOT handle Transactions

Version:

$Revision: 1.10 $

Author:

Alexander Ziller, HighQSoft GmbH

Constructor Summary

Constructors

Constructor and Description
ModifyEnumImplementation()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the program.
XSDContextIF	getContext() Get the context.
java.lang.Object	getDescriptor() Get the xml tree descriptor.
void	init() Initialize the work and perform checks for a successful execution.
void	setArguments(java.util.Properties arguments) Set argument property map.
void	setContext(XSDContextIF context) Set the context.
void	setDescriptor(java.lang.Object descriptor) Set the xml tree descriptor.
void	terminate() Terminate the execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyEnumImplementation

public ModifyEnumImplementation()

Method Detail

init

public void init()
          throws InitializationFailedException

Initialize the work and perform checks for a successful execution.

Specified by:

init in interface ImplementationIF

Throws:

InitializationFailedException - if the initialization fails.

execute

public void execute()
             throws ExecutableException

Execute the program.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

terminate

public void terminate()
               throws TerminationException

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - if termination fails.

getContext

public XSDContextIF getContext()

Get the context.

Specified by:

getContext in interface ImplementationIF

Returns:

ctx the context.

getDescriptor

public java.lang.Object getDescriptor()

Get the xml tree descriptor.

Specified by:

getDescriptor in interface ImplementationIF

Returns:

the tree node.

setArguments

public void setArguments(java.util.Properties arguments)
                  throws InvalidArgumentException

Set argument property map.

Specified by:

setArguments in interface ImplementationIF

Parameters:

arguments - the property map

Throws:

InvalidArgumentException - if the arguments are not valid.

setContext

public void setContext(XSDContextIF context)

Set the context.

Specified by:

setContext in interface ImplementationIF

Parameters:

context - the context.

setDescriptor

public void setDescriptor(java.lang.Object descriptor)
                   throws InvalidDescriptorException

Set the xml tree descriptor.

Specified by:

setDescriptor in interface ImplementationIF

Parameters:

descriptor - the tree node.

Throws:

InvalidDescriptorException - if the descriptor isn't valid.