Package com.comsol.api.database.param

Interface SaveCommitParam

  • All Superinterfaces:
    DatabaseApiValue
    All Known Subinterfaces:
    SaveCommitParamGenerator
    public interface SaveCommitParam
extends DatabaseApiValue
    Input parameters used when saving a general commit in a branch. The commit may involve saving item versions, modifying tag assignments, and deleting items.

    • Method Detail

      • tagsToSave

        java.util.Collection<SaveTagItemParam> tagsToSave()
        Get input parameters for saving new versions of tag items (both creating new, and updating existing, tag items). Returns null or empty if no tag versions will be saved in the commit.
        Returns:
        Input parameters for saving new versions of tag items (both creating new, and updating existing, tag items), or null.

      • modelsToSave

        java.util.Collection<SaveModelItemParam> modelsToSave()
        Get input parameters for saving new versions of model items (both creating new, and updating existing, model items). Returns null if no model versions will be saved in the commit.
        Returns:
        Input parameters for saving new versions of model items (both creating new, and updating existing, model items), or null.

      • filesToSave

        java.util.Collection<SaveFileItemParam> filesToSave()
        Get input parameters for saving new versions of file items (both creating new, and updating existing, file items). Returns null if no file versions will be saved in the commit.
        Returns:
        Input parameters for saving new versions of file items (both creating new, and updating existing, file items), or null.

      • tagsToAssign

        java.util.Collection<AssignTagToItemsParam> tagsToAssign()
        Get input parameters for assigning tags to items. Returns null if no explicit tag assignments will be made in the saved commit (tag assignments may be made also when saving new item versions).
        Returns:
        Input parameters for assigning tags to items, or null

      • tagsToUnassign

        java.util.Collection<UnassignTagFromItemsParam> tagsToUnassign()
        Get input parameters for unassigning tags from items. Returns null if no explicit tag unassignments will be made in the saved commit (tag unassignments may be made also when saving new item versions).
        Returns:
        Input parameters for unassigning tags from items, or null

      • itemsToDelete

        java.util.Collection<DeleteItemParam> itemsToDelete()
        Get input parameters specifying items to be deleted in the saved commit. Returns null if no items should be deleted.
        Returns:
        Input parameters specifying items to be deleted in the saved commit, or null.

      • commitComment

        java.lang.String commitComment()
        Get the commit comment to set for the saved commit. Returns null if no comment should be set.
        Returns:
        A comment to set for the saved commit, or null.