ModelCenter Remote Execution Java API 2025 R2

Interface: IComponentConfig

Last update: 16.07.2025

Package: com.phoenix_int.pacz.api

Deprecated: see com.phoenix_int.pacz.api.v2.IComponentConfig

@Deprecated
public interface IComponentConfig

Configuration for PACZ file

Method Summary

Modifier and Type Method and Description
java.lang.Object getAdditionalConfigValue(java.lang.String valueName)
Deprecated. Get additional configuration value based on specified value name.
java.util.Map<java> getAdditionalConfigValues()
Deprecated. Get additional configuration values as key-value pair map
java.lang.String getASComponent()
Deprecated. Get ModelCenter Remote Execution component name
java.util.List<java> getCommandLineArguments()
Deprecated. Get command line arguments to be passed to component executable
java.lang.String getDescription()
Deprecated. Get component description
Environment getEnvironment()
Deprecated. Get component environment
java.lang.String getExecutable()
Deprecated. Get name of component executable
java.net.URI getHelpUri()
Deprecated. Get URI of help to use for component
java.net.URI getIconUri()
Deprecated. Get URI of icon to use for component
java.util.List<iruntimevariable> getInputs()
Deprecated. Get component inputs
java.util.List<iinstancefile> getInstanceFiles()
Deprecated. Get component instance files
java.util.List<iruntimevariable> getOutputs()
Deprecated. Get component outputs
java.util.Map<java> getProperties()
Deprecated. Get additional component properties
java.util.List<java> getRequiredFeatures()
Deprecated. Get list of features required for component to execute
RunFolderPreference getRunFolderPreference()
Deprecated. Get run folder preference for component
java.lang.String getVersion()
Deprecated. Get component version
void setAdditionalConfigValue(java.lang.String valueName, java.lang.Object value)
Deprecated. Set additional configuration value key-value pair in map.
void setDescription(java.lang.String description)
Deprecated. Set component description
void setRequiredFeatures(java.util.List<java> requiredFeatures)
Deprecated. Set list features required for component to execute
void setVersion(java.lang.String version)
Deprecated. Set component version

Method Detail

getEnvironment

Environment getEnvironment()

Deprecated. Get component environment

Returns:

  • component environment

See Also:

getRunFolderPreference

RunFolderPreference getRunFolderPreference()

Deprecated. Get run folder preference for component

Returns:

  • component run folder preference

See Also:

getVersion

java.lang.String getVersion()

Deprecated. Get component version

Returns:

  • component version

setVersion

void setVersion(java.lang.String version)

Deprecated. Set component version

Parameters:

  • version - component version to use; if null, an empty version will be used

getDescription

java.lang.String getDescription()

Deprecated. Get component description

Returns:

  • component description

setDescription

void setDescription(java.lang.String description)

Deprecated. Set component description

Parameters:

  • description - component description to use; if null, an empty description will be used

getRequiredFeatures

java.util.List<java> getRequiredFeatures()

Deprecated. Get list of features required for component to execute

Returns:

  • list of required features

setRequiredFeatures

void setRequiredFeatures(java.util.List<java> requiredFeatures)

Deprecated. Set list features required for component to execute

Parameters:

  • requiredFeatures - list of features required for component to execute; if null, an empty list will be used

getExecutable

java.lang.String getExecutable()

Deprecated. Get name of component executable

Returns:

  • component executable name

getCommandLineArguments

java.util.List<java> getCommandLineArguments()

Deprecated. Get command line arguments to be passed to component executable

Returns:

  • list of command line arguments

getInputs

java.util.List<iruntimevariable> getInputs()

Deprecated. Get component inputs

Returns:

  • list of component inputs

See Also:

getOutputs

java.util.List<iruntimevariable> getOutputs()

Deprecated. Get component outputs

Returns:

  • list of component outputs

See Also:

getInstanceFiles

java.util.List<iinstancefile> getInstanceFiles()

Deprecated. Get component instance files

Returns:

  • list of component instance files

See Also:

getProperties

java.util.Map<java> getProperties()

Deprecated. Get additional component properties

Returns:

  • key-value pair of component properties

getASComponent

java.lang.String getASComponent()

Deprecated. Get ModelCenter Remote Execution component name

Returns:

  • ModelCenter Remote Execution component name

getHelpUri

java.net.URI getHelpUri()

Deprecated. Get URI of help to use for component

Returns:

  • component help URI; null if no help

getIconUri

java.net.URI getIconUri()

Deprecated. Get URI of icon to use for component

Returns:

  • component icon URI; null if no icon

setAdditionalConfigValue

void setAdditionalConfigValue(java.lang.String valueName, 
                              java.lang.Object value)

Deprecated. Set additional configuration value key-value pair in map. If key exists, the existing value will be overwritten with the new value. If key does not exist, the new key-value pair will be inserted into the map.

Parameters:

  • valueName - name of value to set in additional values map
  • value - value to set for value name

getAdditionalConfigValues

java.util.Map<java> getAdditionalConfigValues()

Deprecated. Get additional configuration values as key-value pair map

Returns:

  • additional configuration value map

getAdditionalConfigValue

java.lang.Object getAdditionalConfigValue(java.lang.String valueName)

Deprecated. Get additional configuration value based on specified value name.

Parameters:

  • valueName - name of value to get

Returns:

  • value for specified value name, or null if name does not exist in map

Connect with Ansys