org.opencrx.kernel.document1.jmi1.DocumentFolder Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.jmi1;
/**
* Class {@code DocumentFolder}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.589555297Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface DocumentFolder
extends org.opencrx.kernel.document1.cci2.DocumentFolder,
org.opencrx.kernel.base.jmi1.Auditee,
org.opencrx.kernel.base.jmi1.Indexed,
org.opencrx.kernel.base.jmi1.SecureObject,
org.opencrx.kernel.base.jmi1.UserDefined,
org.opencrx.kernel.document1.jmi1.PropertySetHolder,
org.openmdx.base.jmi1.BasicObject{
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.document1.jmi1.CreateDefaultShareResult createDefaultShare(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folderEntry} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getFolderEntry(
org.opencrx.kernel.document1.cci2.DocumentFolderEntryQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folderEntry} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolderEntry getFolderEntry(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code folderEntry} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFolderEntry(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolderEntry getFolderEntry(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folderShare} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getFolderShare(
org.opencrx.kernel.document1.cci2.DocumentFolderShareQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folderShare} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolderShare getFolderShare(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code folderShare} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFolderShare(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolderShare getFolderShare(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code folderShare}.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent {@code true} if {@code id} is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param folderShare The element to be appended.
*/
public void addFolderShare (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFolderShare folderShare
);
/**
* Adds the specified element to the set of the values for the reference {@code folderShare} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param folderShare The element to be appended.
*/
public void addFolderShare (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFolderShare folderShare
);
/**
* Adds the specified element to the set of the values for the reference {@code folderShare} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param folderShare The element to be appended.
*/
public void addFolderShare (
org.opencrx.kernel.document1.jmi1.DocumentFolderShare folderShare
);
// ----------------------------------------------------------------------------
// 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.jmi1.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.jmi1.Void removeDefaultShare(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code subFolder} for the specified query.
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with {@code javax.jdo.Query}
* @param query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to {@code true}.
*/
public java.util.List getSubFolder(
org.opencrx.kernel.document1.cci2.DocumentFolderQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code subFolder} for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolder getSubFolder(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code subFolder} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getSubFolder(false,id)}.
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.document1.jmi1.DocumentFolder getSubFolder(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
}