jec-sandcat/src/com/onsoft/sandcat/reflect/RootPathDescriptor.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 {RootPathVersion} from "jec-jars";

/**
 * The <code>RootPathDescriptor</code> class contains information about a REST 
 * API declared in the Sandcat framework.
 */
export class RootPathDescriptor {
  
  ////////////////////////////////////////////////////////////////////////////
  // Constructor function
  ////////////////////////////////////////////////////////////////////////////

  /**
   * Creates a new <code>RootPathDescriptor</code> instance.
   */
  constructor() {}

  ////////////////////////////////////////////////////////////////////////////
  // Public properties
  ////////////////////////////////////////////////////////////////////////////

  /**
   * The root path of the REST API associated with this 
   * <code>RootPathDescriptor</code> instance.
   */
  public path:string = null;

  /**
   * The full path of the REST API associated with this 
   * <code>RootPathDescriptor</code> instance.
   */
  public fullPath:string = null;

  /**
   * The reference of the REST API associated with this 
   * <code>RootPathDescriptor</code> instance.
   */
  public ref:string = null;

  /**
   * The version of the RES API represented by this 
   * <code>RootPathDescriptor</code> instance.
   */
  public version:RootPathVersion = null;
}