Writable.java

package services.repository;

import models.Resource;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.util.List;
import java.util.Map;

/**
 * @author fo
 */
public interface Writable {

  /**
   * Add a new resource to the repository.
   *
   * @param aResource
   *          The resource to be added
   * @param aMetadata
   *          Map containing metadata such as author, timestamp etc
   */
  void addResource(@Nonnull Resource aResource, Map<String, String> aMetadata) throws IOException;

  /**
   * Add multiple resources to the repository
   *
   * @param aResources
   *          The resources to be added
   * @param aMetadata
   *          Map containing metadata such as author, timestamp etc
   * @throws IOException
   */
  void addResources(@Nonnull List<Resource> aResources, Map<String, String> aMetadata) throws IOException;

  /**
   * Delete a resource from the repository
   *
   * @param aId
   *          The ID of the resource to be deleted
   * @param aMetadata
   *          Map containing metadata such as author, timestamp etc
   * @return The deleted resource
   * @throws IOException
   */
  Resource deleteResource(@Nonnull String aId, Map<String, String> aMetadata) throws IOException;

}