org.opencrx.kernel.code1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.code1.jmi1;
/**
* Class {@code Segment}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.436168767Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Segment
extends org.opencrx.kernel.code1.cci2.Segment,
org.opencrx.kernel.jmi1.Segment,
org.opencrx.kernel.base.jmi1.Exporter,
org.opencrx.kernel.base.jmi1.Importer,
org.opencrx.kernel.base.jmi1.SecureObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code objectValidator} 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 getObjectValidator(
org.opencrx.kernel.code1.cci2.ObjectValidatorQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code objectValidator} 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.code1.jmi1.ObjectValidator getObjectValidator(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code objectValidator} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getObjectValidator(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.code1.jmi1.ObjectValidator getObjectValidator(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code objectValidator}.
*
* 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 objectValidator The element to be appended.
*/
public void addObjectValidator (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.code1.jmi1.ObjectValidator objectValidator
);
/**
* Adds the specified element to the set of the values for the reference {@code objectValidator} 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 objectValidator The element to be appended.
*/
public void addObjectValidator (
java.lang.String id,
org.opencrx.kernel.code1.jmi1.ObjectValidator objectValidator
);
/**
* Adds the specified element to the set of the values for the reference {@code objectValidator} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param objectValidator The element to be appended.
*/
public void addObjectValidator (
org.opencrx.kernel.code1.jmi1.ObjectValidator objectValidator
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code valueContainer} 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 getValueContainer(
org.opencrx.kernel.code1.cci2.CodeValueContainerQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code valueContainer} for the specified qualifier attribute value.
*
* @param nameIsPersistent Defines whether value for the qualifier is persistent or not
* @param name The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.code1.jmi1.CodeValueContainer getValueContainer(
boolean nameIsPersistent,
java.lang.String name
);
/**
* Retrieves the value for the reference {@code valueContainer} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getValueContainer(false,name)}.
*
* @param name The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.code1.jmi1.CodeValueContainer getValueContainer(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code valueContainer}.
*
* Note: This is an extension to the JMI 1 standard.
* @param nameIsPersistent {@code true} if {@code name} is persistent
* @param name The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param valueContainer The element to be appended.
*/
public void addValueContainer (
boolean nameIsPersistent,
java.lang.String name,
org.opencrx.kernel.code1.jmi1.CodeValueContainer valueContainer
);
/**
* Adds the specified element to the set of the values for the reference {@code valueContainer} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param name The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param valueContainer The element to be appended.
*/
public void addValueContainer (
java.lang.String name,
org.opencrx.kernel.code1.jmi1.CodeValueContainer valueContainer
);
/**
* Adds the specified element to the set of the values for the reference {@code valueContainer} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param valueContainer The element to be appended.
*/
public void addValueContainer (
org.opencrx.kernel.code1.jmi1.CodeValueContainer valueContainer
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code valueRange} 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 getValueRange(
org.opencrx.kernel.code1.cci2.ValueRangeQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code valueRange} 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.code1.jmi1.ValueRange getValueRange(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code valueRange} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getValueRange(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.code1.jmi1.ValueRange getValueRange(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code valueRange}.
*
* 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 valueRange The element to be appended.
*/
public void addValueRange (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.code1.jmi1.ValueRange valueRange
);
/**
* Adds the specified element to the set of the values for the reference {@code valueRange} 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 valueRange The element to be appended.
*/
public void addValueRange (
java.lang.String id,
org.opencrx.kernel.code1.jmi1.ValueRange valueRange
);
/**
* Adds the specified element to the set of the values for the reference {@code valueRange} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param valueRange The element to be appended.
*/
public void addValueRange (
org.opencrx.kernel.code1.jmi1.ValueRange valueRange
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}