jec-sandcat/src/com/onsoft/sandcat/Sandcat.ts

JEC Sandcat - The default RESTful web services framework for GlassCat applications.

//  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
//
//   Copyright 2016-2018 Pascal ECHEMANN.
//
//   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.

import {DelegatedContainer} from "jec-commons";
import {DomainContainer} from "jec-glasscat-core";
import {RootPathDescriptor} from "./reflect/RootPathDescriptor";
import {SandcatError} from "./exceptions/SandcatError";

/**
 * The main Sandcat execution entry point, which will execute a full Sandcat
 * execution session.
 */
export interface Sandcat extends DelegatedContainer {

  //////////////////////////////////////////////////////////////////////////////
  // Public methods
  //////////////////////////////////////////////////////////////////////////////

  /**
   * @inheritDoc
   */
  setDomainContainer(container:DomainContainer):void;

  /**
   * @inheritDoc
   */
  process(callback:(err:SandcatError)=>void):void;

  /**
   * Adds a new root path to this <code>Sandcat</code> object.
   * 
   * @param {RootPathDescriptor} rootPath the root path to add to this
   *                                      <code>Sandcat</code> object.
   */
  addRootPath(rootPath:RootPathDescriptor):void;

  /**
   * Returns the root path registered with the specified identifier.
   * 
   * @param {string} rootPathRef the identifier of the root path to retreive.
   * @return {RootPathDescriptor} the root path with the specified the
   *                              identifier.
   */
  getRootPath(rootPathRef:string):RootPathDescriptor;
};