SchemaProvider.java

/**
 * 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.waveprotocol.wave.model.schema;

import org.waveprotocol.wave.model.document.operation.automaton.DocumentSchema;
import org.waveprotocol.wave.model.id.WaveletId;

/**
 * Instances can provide schemas for documents.
 *
 */
public interface SchemaProvider {

  /**
   * Finds the schema to use for a particular document.
   *
   * @param waveletId wavelet in which the document exists
   * @param documentId id of the document
   * @return the schema to use for a document or {@link DocumentSchema#NO_SCHEMA_CONSTRAINTS}
   *     if no schema could be found.
   */
  DocumentSchema getSchemaForId(WaveletId waveletId, String documentId);

}