io.github.mmm.entity.bean.Edge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-entity-bean Show documentation

Entity as Bean with Property support (IdProperty, LinkProperty, LinkListProperty).

The newest version!

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.entity.bean;

import io.github.mmm.bean.AbstractInterface;
import io.github.mmm.entity.id.Id;
import io.github.mmm.entity.property.link.LinkProperty;

/**
 * An {@link Edge} connects two {@link EntityBean entities} as a directed many-to-many relation. It links from an
 * {@link #In() incoming} to an {@link #Out() outgoing} {@link EntityBean entity}.
 *
 * @param  type of {@link #In()}.
 * @param  type of {@link #Out()}.
 *
 * @since 1.0.0
 */
@AbstractInterface
public interface Edge extends EntityBean {

  /**
   * @return {@link Id} of the incoming {@link EntityBean entity} (source).
   */
  LinkProperty In();

  /**
   * @return {@link Id} of the outgoing {@link EntityBean entity} (target).
   */
  LinkProperty Out();

}