/*
 * Copyright 2003-2023 JetBrains s.r.o.
 *
 * 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 org.jetbrains.mps.openapi.language;

import org.jetbrains.annotations.NotNull;

/**
 * Member of a concept, named.
 */
public interface SConceptFeature extends SNamedElement {

  /**
   * Retrieves concept where the feature has been declared. Note, this concept doesn't necessarily match concept
   * of the node when this feature has been obtained through node's meta-model accessors, instead, the feature may
   * originate from one of concept's ancestors.
   * @return concept this feature is declared in
   */
  @NotNull
  SAbstractConcept getOwner();

  /**
   * This is a bit vague attribute of a concept feature, basically indicating there's a corresponding runtime descriptor and MPS
   * knows everything it needs about this meta-model element.
   * However, there are cases, when there's no runtime descriptor, but the information in this instance is still sufficient for
   * some MPS purposes (like limited persistence). It's impossible to find out whether this is the case using this method, though.
   * @return false when MPS doesn't have full runtime descriptor for this element and therefore this element may be of limited use in MPS
   */
  boolean isValid();

  /**
   * Indicates that model persistence shall ignore certain features (i.e. properties, association and aggregation links) when
   * serialising node instance
   * @return {@code} false for regular features that shall get persisted
   */
  default boolean isTransient() {
    return false;
  }
}
