import { DataServiceEntityState } from './dataServiceEnums';

/**
 * Defines an object that can be tracked as part of the data services mechanism.
 */
export interface EntityObject {
  /**
   * Indicates the current state of this object.
   */
  dataServiceState: DataServiceEntityState;

  /**
   * Unique identifier for this dataService entity object.
   */
  dataServiceId: number;

  /**
   * Gets the name of the fields that conform the primary key of this object.
   */
  getEntityKeys(): string[];

  /**
   * Gets the actual key as a string for this entity
   */
  getKey(): string;

  /**
   * Gets the name of the entity set for this entity object
   *
   * @return {*}  {string}
   * @memberof EntityObject
   */
  getEntitySet(): string;

  /**
   * Gets the name of this entity object
   *
   * @return {*}  {string}
   * @memberof EntityObject
   */
  getEntityName(): string;

  /**
   * Gets the namespace asociated to this entity
   *
   * @return {*}  {string}
   * @memberof EntityObject
   */
  getNamespace(): string;
}