org.opencrx.kernel.document1.cci2.DocumentFolder Maven / Gradle / Ivy
The newest version!
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.cci2;
/**
* Class {@code DocumentFolder}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:35.320753533Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface DocumentFolder
extends org.opencrx.kernel.base.cci2.Auditee,
org.opencrx.kernel.base.cci2.Indexed,
org.opencrx.kernel.base.cci2.SecureObject,
org.opencrx.kernel.base.cci2.UserDefined,
org.opencrx.kernel.document1.cci2.PropertySetHolder,
org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.document1.cci2.CreateDefaultShareResult createDefaultShare(
);
// ----------------------------------------------------------------------------
// 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/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code folderEntry}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.FolderContainsDocument.FolderEntry getFolderEntry(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code folderShare}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentFolderContainsFolderShare.FolderShare getFolderShare(
);
// ----------------------------------------------------------------------------
// 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 parent}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.document1.cci2.DocumentFolder getParent(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code parent}.
* @param parent The new—possibly {@code null}—value for this reference.
*/
public void setParent(
org.opencrx.kernel.document1.cci2.DocumentFolder parent
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.openmdx.base.cci2.Void removeDefaultShare(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code subFolder}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.document1.cci2.FolderContainsFolder.SubFolder getSubFolder(
);
// ----------------------------------------------------------------------------
// 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();
}
}