de.aristaflow.adept2.core.processrepository

Interface DataTypeManager

All Superinterfaces:

UDTManager

public interface DataTypeManager
extends UDTManager

The data type manager provides the means to administer user-defined data types (UDTs) and user-defined functions (UDFs). UDTs are treated as black boxes by ADEPT2. To be able to use UDTs in branching decisions, functions can be registered that allow to interpret corresponding UDTs. The user-defined functions return data values of types that ADEPT2 understands, which are null (no type), INTEGER, FLOAT, BOOLEAN, STRING, URI or another UDT.

Every UDT and every UDF that are used in a process template need to be registered within the data type manager.

Author:

Ulrich Kreher

See Also:

ProcessConstants.AdeptDataType

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.util.UUID>	findUsageOfDataType(SessionToken session, java.lang.String userDefinedDataType) Finds all process templates (including instance-specific templates) in this process repository which contain a data element of the designated user-defined data type.
RemoteIterator<java.util.List<java.util.UUID>>	findUsageOfDataTypeIterator(SessionToken session, java.lang.String userDefinedDataType) The same as findUsageOfDataType(SessionToken, String) but with partial retrieval of the process template IDs.
java.util.List<java.lang.String>	getAllDataTypes(SessionToken session) Gets a list of names of all user defined data types in the process repository.
RemoteIterator<java.util.List<java.lang.String>>	getAllDataTypesIterator(SessionToken session) The same as getAllDataTypes(SessionToken) but with partial retrieval of the data types.
java.util.List<UserDefinedFunction>	getAllUDFs(SessionToken session, java.lang.String userDefinedDataType) Gets all user-defined functions that are registered for the designated data type.
RemoteIterator<java.util.List<UserDefinedFunction>>	getAllUDFsIterator(SessionToken session, java.lang.String userDefinedDataType) The same as getAllUDFs(SessionToken, String) but with partial retrieval of the user-defined functions.

Methods inherited from interface de.aristaflow.adept2.core.datamanager.UDTManager

createDataType, createUDF, deleteDataType, deleteUDF

Method Detail

getAllDataTypes

java.util.List<java.lang.String> getAllDataTypes(SessionToken session)

Gets a list of names of all user defined data types in the process repository.

Parameters:

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

Returns:

A list of (the names of) all managed data types.

getAllDataTypesIterator

RemoteIterator<java.util.List<java.lang.String>> getAllDataTypesIterator(SessionToken session)

The same as getAllDataTypes(SessionToken) but with partial retrieval of the data types.

Parameters:

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

Returns:

An iterator providing (the names of) all managed data types.

getAllUDFs

java.util.List<UserDefinedFunction> getAllUDFs(SessionToken session,
                                               java.lang.String userDefinedDataType)

Gets all user-defined functions that are registered for the designated data type. There may be an arbitrary amount of functions registered for a specific data type.

Parameters:

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

userDefinedDataType - The unique name of the data type which functions are of interest.

Returns:

A list of all functions of the designated data type.

getAllUDFsIterator

RemoteIterator<java.util.List<UserDefinedFunction>> getAllUDFsIterator(SessionToken session,
                                                                       java.lang.String userDefinedDataType)

The same as getAllUDFs(SessionToken, String) but with partial retrieval of the user-defined functions.

Parameters:

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

userDefinedDataType - The unique name of the data type which functions are of interest.

Returns:

An iterator providing all functions of the designated data type.

findUsageOfDataType

java.util.Set<java.util.UUID> findUsageOfDataType(SessionToken session,
                                                  java.lang.String userDefinedDataType)

Finds all process templates (including instance-specific templates) in this process repository which contain a data element of the designated user-defined data type.

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 user-defined data type which usage is of interest.

Returns:

A list IDs of process templates which reference the designated user-defined data type.

findUsageOfDataTypeIterator

RemoteIterator<java.util.List<java.util.UUID>> findUsageOfDataTypeIterator(SessionToken session,
                                                                           java.lang.String userDefinedDataType)

The same as findUsageOfDataType(SessionToken, String) but with partial retrieval of the process template IDs.

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 user-defined data type which usage is of interest.

Returns:

An iterator providing the IDs of process templates which reference the designated user-defined data type.