/*
 Copyright 2013-2015 Jason Leyba

 Licensed 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.
 */

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: dossier.proto

package com.github.jsdossier.proto;

public interface IndexOrBuilder extends
    // @@protoc_insertion_point(interface_extends:dossier.Index)
    com.google.protobuf.MessageOrBuilder {

  /**
   * <code>required string home = 1;</code>
   *
   * <pre>
   * Defines the href from the current page to the main index.
   * </pre>
   */
  boolean hasHome();
  /**
   * <code>required string home = 1;</code>
   *
   * <pre>
   * Defines the href from the current page to the main index.
   * </pre>
   */
  java.lang.String getHome();
  /**
   * <code>required string home = 1;</code>
   *
   * <pre>
   * Defines the href from the current page to the main index.
   * </pre>
   */
  com.google.protobuf.ByteString
      getHomeBytes();

  /**
   * <code>optional bool include_types = 2;</code>
   *
   * <pre>
   * Whether to generate the global type section.
   * </pre>
   */
  boolean hasIncludeTypes();
  /**
   * <code>optional bool include_types = 2;</code>
   *
   * <pre>
   * Whether to generate the global type section.
   * </pre>
   */
  boolean getIncludeTypes();

  /**
   * <code>optional bool include_modules = 3;</code>
   *
   * <pre>
   * Whether to generate the module type section.
   * </pre>
   */
  boolean hasIncludeModules();
  /**
   * <code>optional bool include_modules = 3;</code>
   *
   * <pre>
   * Whether to generate the module type section.
   * </pre>
   */
  boolean getIncludeModules();

  /**
   * <code>repeated .dossier.TypeLink links = 4;</code>
   *
   * <pre>
   * Additional links to include in the navigation pane.
   * </pre>
   */
  java.util.List<com.github.jsdossier.proto.TypeLink> 
      getLinksList();
  /**
   * <code>repeated .dossier.TypeLink links = 4;</code>
   *
   * <pre>
   * Additional links to include in the navigation pane.
   * </pre>
   */
  com.github.jsdossier.proto.TypeLink getLinks(int index);
  /**
   * <code>repeated .dossier.TypeLink links = 4;</code>
   *
   * <pre>
   * Additional links to include in the navigation pane.
   * </pre>
   */
  int getLinksCount();
  /**
   * <code>repeated .dossier.TypeLink links = 4;</code>
   *
   * <pre>
   * Additional links to include in the navigation pane.
   * </pre>
   */
  java.util.List<? extends com.github.jsdossier.proto.TypeLinkOrBuilder> 
      getLinksOrBuilderList();
  /**
   * <code>repeated .dossier.TypeLink links = 4;</code>
   *
   * <pre>
   * Additional links to include in the navigation pane.
   * </pre>
   */
  com.github.jsdossier.proto.TypeLinkOrBuilder getLinksOrBuilder(
      int index);
}
