All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencrx.kernel.document1.cci2.DocumentFolderEntry Maven / Gradle / Ivy

The newest version!
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.cci2;

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

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

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

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code basedOn}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.openmdx.base.cci2.BasicObject getBasedOn(
  );

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

// ----------------------------------------------------------------------------
// 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/AttributeGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the possibly null value for the optional attribute {@code disabled}.
   * @return The possibly null value for attribute {@code disabled}.
   */
  public java.lang.Boolean isDisabled(
  );

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

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

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code document}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.openmdx.base.cci2.BasicObject getDocument(
  );

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

// ----------------------------------------------------------------------------
// 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/AttributeGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the possibly null value for the optional attribute {@code validFrom}.
   * @return The possibly null value for attribute {@code validFrom}.
   */
  public java.util.Date getValidFrom(
  );

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

  /**
   * Sets a new value for the attribute {@code validFrom}.
   * @param validFrom The possibly null new value for attribute {@code validFrom}.
   */
  public void setValidFrom(
    java.util.Date validFrom
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
  /**
   * Retrieves the possibly null value for the optional attribute {@code validTo}.
   * @return The possibly null value for attribute {@code validTo}.
   */
  public java.util.Date getValidTo(
  );

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

  /**
   * Sets a new value for the attribute {@code validTo}.
   * @param validTo The possibly null new value for attribute {@code validTo}.
   */
  public void setValidTo(
    java.util.Date validTo
  );

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

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

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

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

  }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy