org.opencrx.kernel.depot1.cci2.CompoundBooking 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
openCRX/Client Library
The newest version!
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.depot1.cci2;

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

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.openmdx.base.cci2.Void acceptCb(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGetSet
// ----------------------------------------------------------------------------
  /**
   * Retrieves a set containing all the elements for the attribute {@code acceptedBy}.
   * @return A set containing all elements for this attribute.
   */
  public java.util.Set getAcceptedBy(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSetSet
// ----------------------------------------------------------------------------
  /**
   * Clears {@code acceptedBy} and adds the given value(s).
   * 
   * This method is equivalent to
   *   set.clear();
   *   for(java.lang.String e : acceptedBy){
   *     set.add(e);
   *   }
   * 
   * @param acceptedBy value(s) to be added to {@code acceptedBy}
   */
  public void setAcceptedBy(
    java.lang.String... acceptedBy
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.depot1.cci2.AppendBookingsResult appendBookings(
      org.opencrx.kernel.depot1.cci2.AppendBookingsParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.depot1.cci2.AppendBookingsResult appendBookings2(
      org.opencrx.kernel.depot1.cci2.AppendBookings2Params in
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
  /**
   * Retrieves a set containing all the elements for the reference {@code booking}.
   * @return A set containing all the elements for this reference.
   */
  public  org.opencrx.kernel.depot1.cci2.CompoundBookingHasBooking.Booking getBooking(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the attribute {@code bookingDate}.
   * @return The non-null value for attribute {@code bookingDate}.
   */
  public java.util.Date getBookingDate(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the attribute {@code bookingDate}.
   * @param bookingDate The non-{@code null} new value for attribute {@code bookingDate}.
   */
  public void setBookingDate(
    java.util.Date bookingDate
  );

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

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

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

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

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.depot1.cci2.CancelCompoundBookingResult cancelCb(
  );

// ----------------------------------------------------------------------------
// 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/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.openmdx.base.cci2.Void finalizeCb(
  );

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

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

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.openmdx.base.cci2.Void lockCb(
      org.opencrx.kernel.depot1.cci2.LockCompoundBookingParams in
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the attribute {@code lockModifiedAt}.
   * @return The non-null value for attribute {@code lockModifiedAt}.
   */
  public java.util.Date getLockModifiedAt(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the attribute {@code lockModifiedAt}.
   * @param lockModifiedAt The non-{@code null} new value for attribute {@code lockModifiedAt}.
   */
  public void setLockModifiedAt(
    java.util.Date lockModifiedAt
  );

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

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

// ----------------------------------------------------------------------------
// 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/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code origin}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.opencrx.kernel.depot1.cci2.BookingOrigin getOrigin(
  );

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

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

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

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.openmdx.base.cci2.Void unlockCb(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code wfProcess}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.opencrx.kernel.home1.cci2.WfProcessInstance getWfProcess(
  );

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

// ----------------------------------------------------------------------------
// 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();

  }

}