Interface UpdateFileItemParam
-
- All Superinterfaces:
DatabaseApiValue
,UpdateItemParam
- All Known Subinterfaces:
UpdateFileItemParamGenerator
public interface UpdateFileItemParam extends UpdateItemParam
Input parameters used when updating an existing file item in a Model Manager database. The update will save a new version of the file item on the targeted branch.
The input parameters returned from this interface are used in exactly the same way as those returned by
SaveFileItemParam
, except that the target file for the save is automatically fixed from context.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
description()
Get the description to use for the saved file version.java.util.Collection<SourceFileParam>
sourceFiles()
Get input parameters used to specify one or more sources for the file resource contents of the file to be updated.-
Methods inherited from interface com.comsol.api.database.param.UpdateItemParam
assignedTagKeys, sourceDatabaseKey, sourceItemVersionKey, targetItemConflictMode, title
-
-
-
-
Method Detail
-
description
java.lang.String description()
Get the description to use for the saved file version. Returns null if the current description should not be explicitly modified or if the description should be automatically inferred from the source of the save.
An example when the description is automatically inferred is when updating a file item from a source file version, possibly located in another database.
- Returns:
- The description for the saved file version, or null.
-
sourceFiles
java.util.Collection<SourceFileParam> sourceFiles()
Get input parameters used to specify one or more sources for the file resource contents of the file to be updated. Returns null if the source for the file resources is specified usingUpdateItemParam.sourceItemVersionKey()
or if the file resources should be reused from the latest version of the target file for the save.- Returns:
- A collection of input parameters used to specify one or more sources for the file resource contents of the saved file version, or null.
-
-