org.opencrx.kernel.home1.cci2.Alert 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.home1.cci2;

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

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

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

// ----------------------------------------------------------------------------
// 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/AttributeGet1_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the attribute {@code importance}.
   * @return The non-null value for attribute {@code importance}.
   */
  public short getImportance(
  );

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

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

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

// ----------------------------------------------------------------------------
// 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 reference}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.openmdx.base.cci2.ContextCapable getReference(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the reference {@code reference}.
   * @param reference The new—possibly {@code null}—value for this reference.
   */
  public void setReference(
    org.openmdx.base.cci2.ContextCapable reference
  );

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

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

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

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

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

    /**
     * Retrieve the {@code UserHome}'s identity
     * @return the parent object's identity
     */
    public org.opencrx.kernel.home1.cci2.UserHome.Identity getUserHome();

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

  }

}