org.opencrx.kernel.base.jmi1.SecureObject 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.base.jmi1;

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

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult addOwningGroup(
      org.opencrx.kernel.base.jmi1.ModifyOwningGroupParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.openmdx.base.jmi1.Void assertOwningGroup(
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.CheckPermissionsResult checkPermissions(
      org.opencrx.kernel.base.jmi1.CheckPermissionsParams in
  );

// ----------------------------------------------------------------------------
// Instance/AttributeGetList
// ----------------------------------------------------------------------------
  /**
   * Retrieves a list containing all the elements for the attribute {@code owner}.
   * @return A list containing all elements for this attribute.
   */
  public java.util.List getOwner(
  );

// ----------------------------------------------------------------------------
// Instance/AttributeSetList
// ----------------------------------------------------------------------------
  /**
   * Clears {@code owner} and adds the members of the given List.
   * 
   * This method is equivalent to
   *   list.clear();
   *   list.addAll(owner);
   * 
   * Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the equivalent code.
   * @param owner collection to be copied.
   */
  public void setOwner(
    java.util.List owner
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
  /**
   * Retrieves the value for the reference {@code owningUser}.
   * @return The —possibly {@code null}— value for this reference.
   */
  public org.opencrx.security.realm1.jmi1.User getOwningUser(
  );

// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
  /**
   * Sets a new value for the reference {@code owningUser}.
   * @param owningUser The new—possibly {@code null}—value for this reference.
   */
  public void setOwningUser(
    org.opencrx.security.realm1.cci2.User owningUser
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult removeAllOwningGroup(
      org.opencrx.kernel.base.jmi1.RemoveAllOwningGroupParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult removeOwningGroup(
      org.opencrx.kernel.base.jmi1.ModifyOwningGroupParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult replaceOwningGroup(
      org.opencrx.kernel.base.jmi1.ModifyOwningGroupsParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult setAccessLevel(
      org.opencrx.kernel.base.jmi1.SetAccessLevelParams in
  );

// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
  /**
   */
  public org.opencrx.kernel.base.jmi1.ModifySecureObjectResult setOwningUser(
      org.opencrx.kernel.base.jmi1.SetOwningUserParams in
  );

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

}