org.molgenis.navigator.NavigatorService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of molgenis-navigator Show documentation

Plugin module for navigating metadata.

There is a newer version: 8.4.5

package org.molgenis.navigator;

import java.util.List;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.validation.constraints.NotEmpty;
import org.molgenis.jobs.model.JobExecution;
import org.molgenis.navigator.model.Resource;
import org.molgenis.navigator.model.ResourceIdentifier;

public interface NavigatorService {
  /**
   * @param folderId null implies the root folder
   * @return folder or null if folderId is null
   */
  @Nullable
  @CheckForNull
  Folder getFolder(@Nullable @CheckForNull String folderId);

  /** @param folderId null implies the root folder */
  List getResources(@Nullable @CheckForNull String folderId);

  List findResources(String query);

  /** @param targetFolderId null implies the root folder */
  void moveResources(
      List resources, @Nullable @CheckForNull String targetFolderId);

  /** @param targetFolderId null implies the root folder */
  JobExecution copyResources(
      @NotEmpty List resources, @Nullable @CheckForNull String targetFolderId);

  JobExecution downloadResources(@NotEmpty List resources);

  JobExecution deleteResources(@NotEmpty List resources);

  void updateResource(Resource resource);
}