Package com.comsol.api.database.param

Interface UpdateModelItemParam

  • All Superinterfaces:
    DatabaseApiValue, UpdateItemParam
    All Known Subinterfaces:
    UpdateModelItemParamGenerator
    public interface UpdateModelItemParam
extends UpdateItemParam

    Input parameters used when updating an existing model item in a Model Manager database. The update will save a new version of the model item on the targeted branch.

    The input parameters returned from this interface are used in exactly the same way as those returned by SaveModelItemParam, except that the target model for the save is automatically fixed from context.

    • Method Detail

      • filename

        java.lang.String filename()

        Get the filename to use for the saved model version. Returns null if the current filename should not be explicitly modified or if the filename should be automatically taken from the source of the save.

        An example when the filename is automatically inferred is when updating a model item from a source model object. The model object may, for example, come from a model file on the file system or from a model currently loaded in COMSOL Multiphysics.

        Returns:
        The filename for the saved model version, or null.

      • description

        java.lang.String description()

        Get the description to use for the saved model version. Returns null if the current description should not be explicitly modified or if the description should be automatically taken from the source of the save.

        An example when the description is automatically inferred is when updating a model item from a source model object. The model object may, for example, come from a model file on the file system or from a model currently loaded in COMSOL Multiphysics.

        Returns:
        The description for the saved model version, or null.

      • sourceModel

        java.lang.String sourceModel()

        Get the model tag of a model that is currently loaded in COMSOL Multiphysics, as returned by ModelEntity.tag() (not to be confused with a tag item in the database). The model contents of that model will be used as source input for the saved model version. The source model itself need not have been loaded from a Model Manager database.

        Returns null if the source input for the model contents is specified by the return value of UpdateItemParam.sourceItemVersionKey(), the return value of sourceLocation(), or if the model contents should be reused from the latest version of the target model for the save.

        Returns:
        The model tag of a model that is currently loaded in COMSOL Multiphysics, or null.

      • sourceLocation

        java.lang.String sourceLocation()

        Get the absolute file system path to a source model. The model contents of that model will be used as input for the saved model version.

        Returns null if the source input for the model contents is specified by the return value of UpdateItemParam.sourceItemVersionKey(), the return value of sourceModel(), or if the model contents should be reused from the latest version of the target model for the save.

        Returns:
        The absolute file system path to a model, or null.