de.aristaflow.adept2.core.datamanager

Interface UDTManager

All Known Subinterfaces:

DataTypeManager

public interface UDTManager

This interface encapsulates the creation and deletion of user-defined data types (UDTs) and user-defined functions (UDFs) as well as the search for the usage of a specific UDT in the process repository (buildtime) as well as in the data type manager (runtime).

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
void	createDataType(SessionToken session, java.lang.String userDefinedDataType) Creates a new data type (UDT) in the data type manager/process repository with the designated name.
void	createUDF(SessionToken session, java.lang.String userDefinedDataType, java.lang.String functionName, ProcessConstants.AdeptDataType returnType, java.lang.String function, java.lang.String language) Creates a user-defined function that is able to interpret a specific data type.
void	deleteDataType(SessionToken session, java.lang.String userDefinedDataType) Deletes a data type (UDT) in the process repository.
void	deleteUDF(SessionToken session, java.lang.String userDefinedDataType, java.lang.String functionName) Deletes a user-defined function (UDF) in the data type manager/process repository.

Method Detail

createDataType

void createDataType(SessionToken session,
                    java.lang.String userDefinedDataType)
             throws ConstraintViolationException

Creates a new data type (UDT) in the data type manager/process repository with the designated name. The name has to be unique with respect to the data type manager/process repository.

Parameters:

session - The session which is used to check for access rights on this method.

userDefinedDataType - The unique (with respect to the data type manager/process repository) name of a new data type.

Throws:

ConstraintViolationException - If the designated name of the user-defined data type already exists, a ConstraintViolationException will be raised.

deleteDataType

void deleteDataType(SessionToken session,
                    java.lang.String userDefinedDataType)
             throws ConstraintViolationException

Deletes a data type (UDT) in the process repository. The designated data type may not be used (referenced) in a template in the data type manager/process repository, otherwise a ConstraintViolationException will be raised.

Parameters:

session - The session which is used to check for access rights on this method.

userDefinedDataType - The unique (with respect to the data type manager/process repository) name of the data type to delete.

Throws:

ConstraintViolationException - If the designated user-defined data type is used in a process template, a ConstraintViolationException will be raised.

createUDF

void createUDF(SessionToken session,
               java.lang.String userDefinedDataType,
               java.lang.String functionName,
               ProcessConstants.AdeptDataType returnType,
               java.lang.String function,
               java.lang.String language)
        throws ConstraintViolationException

Creates a user-defined function that is able to interpret a specific data type. The name of the function has to be unique with respect to the designated user-defined data type.

Besides the name of the function, the return type has to be specified as data element type defined by the ADEPT2-processmodel or null in case of a void function. The function itself is provided in a string and has to be written in a language that can be interpreted/executed by the ADEPT2-kernel. Therefore the language also has to be specified (as a string).

Parameters:

session - The session which is used to check for access rights on this method.

userDefinedDataType - The data type to which the function belongs to.

functionName - The name of the function to be registered.

returnType - The return type which is understood by ADEPT2 or null in case of a void function.

function - The function to be evaluated. When evaluated the function is provided with the corresponding value of the user-defined data type.

language - The language in which the function is written which is needed for interpreting/executing the function.

Throws:

ConstraintViolationException - If a user-defined function with the designated name is already registered for the designated user-defined data type, a ConstraintViolationException will be raised.

deleteUDF

void deleteUDF(SessionToken session,
               java.lang.String userDefinedDataType,
               java.lang.String functionName)
        throws ConstraintViolationException

Deletes a user-defined function (UDF) in the data type manager/process repository. The designated function may not be used (referenced) in a template in the process repository, otherwise a ConstraintViolationException will be raised.

Parameters:

session - The session which is used to check for access rights on this method.

userDefinedDataType - The data type to which the function belongs to.

functionName - The name of the function to be deregistered.

Throws:

ConstraintViolationException - If the designated user-defined function is used in a process template, a ConstraintViolationException will be raised.