org.opencrx.kernel.document1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.document1.jmi1;
/**
* Class {@code Segment}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.557469986Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Segment
extends org.opencrx.kernel.document1.cci2.Segment,
org.opencrx.kernel.jmi1.Segment,
org.opencrx.kernel.base.jmi1.Auditee,
org.opencrx.kernel.base.jmi1.Exporter,
org.opencrx.kernel.base.jmi1.Importer,
org.opencrx.kernel.base.jmi1.Indexed,
org.opencrx.kernel.base.jmi1.SecureObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code document} 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 getDocument(
org.opencrx.kernel.document1.cci2.DocumentQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code document} 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.Document getDocument(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code document} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDocument(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.Document getDocument(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code document}.
*
* 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 document The element to be appended.
*/
public void addDocument (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.Document document
);
/**
* Adds the specified element to the set of the values for the reference {@code document} 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 document The element to be appended.
*/
public void addDocument (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.Document document
);
/**
* Adds the specified element to the set of the values for the reference {@code document} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param document The element to be appended.
*/
public void addDocument (
org.opencrx.kernel.document1.jmi1.Document document
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentFilter} 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 getDocumentFilter(
org.opencrx.kernel.document1.cci2.DocumentFilterGlobalQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentFilter} 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.DocumentFilterGlobal getDocumentFilter(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code documentFilter} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDocumentFilter(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.DocumentFilterGlobal getDocumentFilter(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code documentFilter}.
*
* 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 documentFilter The element to be appended.
*/
public void addDocumentFilter (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFilterGlobal documentFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code documentFilter} 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 documentFilter The element to be appended.
*/
public void addDocumentFilter (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFilterGlobal documentFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code documentFilter} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param documentFilter The element to be appended.
*/
public void addDocumentFilter (
org.opencrx.kernel.document1.jmi1.DocumentFilterGlobal documentFilter
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentSchema} 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 getDocumentSchema(
org.opencrx.kernel.document1.cci2.DocumentSchemaQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code documentSchema} 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.DocumentSchema getDocumentSchema(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code documentSchema} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDocumentSchema(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.DocumentSchema getDocumentSchema(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code documentSchema}.
*
* 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 documentSchema The element to be appended.
*/
public void addDocumentSchema (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentSchema documentSchema
);
/**
* Adds the specified element to the set of the values for the reference {@code documentSchema} 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 documentSchema The element to be appended.
*/
public void addDocumentSchema (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentSchema documentSchema
);
/**
* Adds the specified element to the set of the values for the reference {@code documentSchema} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param documentSchema The element to be appended.
*/
public void addDocumentSchema (
org.opencrx.kernel.document1.jmi1.DocumentSchema documentSchema
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folder} 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 getFolder(
org.opencrx.kernel.document1.cci2.DocumentFolderQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code folder} 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 getFolder(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code folder} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFolder(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 getFolder(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code folder}.
*
* 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 folder The element to be appended.
*/
public void addFolder (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFolder folder
);
/**
* Adds the specified element to the set of the values for the reference {@code folder} 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 folder The element to be appended.
*/
public void addFolder (
java.lang.String id,
org.opencrx.kernel.document1.jmi1.DocumentFolder folder
);
/**
* Adds the specified element to the set of the values for the reference {@code folder} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param folder The element to be appended.
*/
public void addFolder (
org.opencrx.kernel.document1.jmi1.DocumentFolder folder
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}