io.oasp.module.basic.common.api.reference.Ref Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oasp4j-basic Show documentation

Basic code for common usage (such as base classes for transfer objects) of the Open Application Standard Platform for Java (OASP4J).

The newest version!

package io.oasp.module.basic.common.api.reference;

import net.sf.mmm.util.lang.api.Datatype;

/**
 * Interface for a reference to an {@link net.sf.mmm.util.entity.api.GenericEntity entity} via its {@link #getId() ID}.
 * In most cases you want to use {@link IdRef}.
 *
 * @param  generic type of {@link #getId() ID}.
 * @param  generic type of the referenced {@link net.sf.mmm.util.entity.api.Entity}. For flexibility not technically
 *        bound to {@link net.sf.mmm.util.entity.api.Entity} so it can also be used for an external entity not
 *        satisfying any requirements.
 */
public interface Ref extends Datatype {

  /**
   * @return the ({@link net.sf.mmm.util.entity.api.GenericEntity#getId() ID} of the referenced
   *         {@link net.sf.mmm.util.entity.api.Entity}.
   */
  ID getId();

}