/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.texera.amber.core.storage.model

import java.net.URI

/**
  * VirtualCollection provides the abstraction of managing a collection of children VirtualDocument
  */
abstract class VirtualCollection {
  def getURI: URI

  /**
    * get children documents that are directly underneath the current collection
    * @return the children documents
    */
  def getDocuments: List[VirtualDocument[_]]

  /**
    * get a child document with certain name under this collection and return
    * @param name the child document's name
    * @return the document
    */
  def getDocument(name: String): VirtualDocument[_]

  /**
    * physically remove current collection from the system. All children documents underneath will be removed
    */
  def remove(): Unit
}
