org.opencrx.kernel.depot1.cci2.DepotEntityRelationship Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencrx-client Show documentation
openCore/Client Library
The newest version!
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.depot1.cci2;

/**
 * Class {@code DepotEntityRelationship}
 */
@javax.annotation.Generated(
  value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
  date = "2023-10-28T12:15:36.178716745Z",
  comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface DepotEntityRelationship
  extends org.opencrx.kernel.generic.cci2.CrxObject{

// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the possibly null value for the optional attribute {@code description}.
   * @return The possibly null value for attribute {@code description}.
   */
  public java.lang.String getDescription(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------

  /**
   * Sets a new value for the attribute {@code description}.
   * @param description The possibly null new value for attribute {@code description}.
   */
  public void setDescription(
    java.lang.String description
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code entity1}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.opencrx.kernel.depot1.cci2.DepotEntity getEntity1(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the reference {@code entity1}.
   * @param entity1 The new—possibly {@code null}—value for this reference.
   */
  public void setEntity1(
    org.opencrx.kernel.depot1.cci2.DepotEntity entity1
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code entity2}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.opencrx.kernel.depot1.cci2.DepotEntity getEntity2(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the reference {@code entity2}.
   * @param entity2 The new—possibly {@code null}—value for this reference.
   */
  public void setEntity2(
    org.opencrx.kernel.depot1.cci2.DepotEntity entity2
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the attribute {@code name}.
   * @return The non-null value for attribute {@code name}.
   */
  public java.lang.String getName(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the attribute {@code name}.
   * @param name The non-{@code null} new value for attribute {@code name}.
   */
  public void setName(
    java.lang.String name
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the attribute {@code relationshipType}.
   * @return The non-null value for attribute {@code relationshipType}.
   */
  public short getRelationshipType(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the attribute {@code relationshipType}.
   * @param relationshipType The non-{@code null} new value for attribute {@code relationshipType}.
   */
  public void setRelationshipType(
    short relationshipType
  );

// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------

// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
  /**
   * Object Identity
   */
  public interface Identity extends org.oasisopen.cci2.Identity {

    /**
     * Retrieve the {@code Segment}'s identity
     * @return the parent object's identity
     */
    public org.openmdx.base.cci2.Segment.Identity getSegment();

    /**
     * Tells whether the {@code id} value is persistent or reassignable.
     * @return {@code PERSISTENT} or {@code REASSIGNABLE}
     */
    public org.oasisopen.cci2.QualifierType getIdType();

    /**
     * The {@code id} value
     * @return the {@code id} value
     */
    public java.lang.String getId();

  }

}