com.bitplan.mediawiki.japi.SiteInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mediawiki-japi Show documentation

Java library to call Mediawiki API described at http://www.mediawiki.org/wiki/API:Main_page

There is a newer version: 0.2.3

/**
 *
 * This file is part of the https://github.com/WolfgangFahl/Mediawiki-Japi open source project
 *
 * Copyright 2015-2017 BITPlan GmbH https://github.com/BITPlan
 *
 * 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.
 */
package com.bitplan.mediawiki.japi;

import java.util.Map;

import com.bitplan.mediawiki.japi.api.General;
import com.bitplan.mediawiki.japi.api.Ns;

/**
 * Namespaces interface
 * @author wf
 *
 */
public interface SiteInfo {
  
  /**
   * get the languge of this site
   * @return
   * @throws Exception 
   */
  public String getLang() throws Exception;
  
  /**
   * get the Version of this wiki
   * 
   * @throws Exception
   */
  public String getVersion() throws Exception;
  
  /**
   * get the Namespaces for this wiki
   * @return
   * @throws Exception
   */
  public Map getNamespaces() throws Exception;
  
  /**
   * get the Namespaces for this wiki
   * @return
   * @throws Exception
   */
  public Map getNamespacesById() throws Exception;
  
  /**
   * get the Namespaces by canonical name for this wiki
   * @return
   * @throws Exception
   */
  public Map getNamespacesByCanonicalName() throws Exception;
  
  /**
   * get the general siteinfo
   * 
   * @return the general siteinfo
   * @throws Exception
   */
  public General getGeneral() throws Exception;
  
  /**
   * map the given namespace to the target wiki
   * @param ns
   * @param targetWiki
   * @return the namespace name for the target wiki
   * @throws Exception 
   */
  public String mapNamespace(String ns, SiteInfo targetWiki) throws Exception;
}