org.opencrx.kernel.depot1.jmi1.DepotHolder Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.depot1.jmi1;
/**
* Abstract class {@code DepotHolder}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:38.635470211Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface DepotHolder
extends org.opencrx.kernel.depot1.cci2.DepotHolder,
org.opencrx.kernel.contract1.jmi1.ContractReferenceHolder,
org.opencrx.kernel.generic.jmi1.CrxObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code address} 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 getAddress(
org.opencrx.kernel.depot1.cci2.DepotAddressQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code address} 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.depot1.jmi1.DepotAddress getAddress(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code address} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAddress(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.depot1.jmi1.DepotAddress getAddress(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code address}.
*
* 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 address The element to be appended.
*/
public void addAddress (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotAddress address
);
/**
* Adds the specified element to the set of the values for the reference {@code address} 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 address The element to be appended.
*/
public void addAddress (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotAddress address
);
/**
* Adds the specified element to the set of the values for the reference {@code address} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param address The element to be appended.
*/
public void addAddress (
org.opencrx.kernel.depot1.jmi1.DepotAddress address
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.openmdx.base.jmi1.Void assertReports(
org.opencrx.kernel.depot1.jmi1.AssertReportsParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code bookingEntry} 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 getBookingEntry(
org.opencrx.kernel.depot1.cci2.SingleBookingEntryQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code bookingEntry} 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.depot1.jmi1.SingleBookingEntry getBookingEntry(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code bookingEntry} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getBookingEntry(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.depot1.jmi1.SingleBookingEntry getBookingEntry(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code bookingEntry}.
*
* 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 bookingEntry The element to be appended.
*/
public void addBookingEntry (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.SingleBookingEntry bookingEntry
);
/**
* Adds the specified element to the set of the values for the reference {@code bookingEntry} 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 bookingEntry The element to be appended.
*/
public void addBookingEntry (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.SingleBookingEntry bookingEntry
);
/**
* Adds the specified element to the set of the values for the reference {@code bookingEntry} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param bookingEntry The element to be appended.
*/
public void addBookingEntry (
org.opencrx.kernel.depot1.jmi1.SingleBookingEntry bookingEntry
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depot} 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 getDepot(
org.opencrx.kernel.depot1.cci2.DepotQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depot} 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.depot1.jmi1.Depot getDepot(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code depot} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDepot(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.depot1.jmi1.Depot getDepot(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code depot}.
*
* 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 depot The element to be appended.
*/
public void addDepot (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.Depot depot
);
/**
* Adds the specified element to the set of the values for the reference {@code depot} 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 depot The element to be appended.
*/
public void addDepot (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.Depot depot
);
/**
* Adds the specified element to the set of the values for the reference {@code depot} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param depot The element to be appended.
*/
public void addDepot (
org.opencrx.kernel.depot1.jmi1.Depot depot
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code entity}.
* @return The non-{@code null} value for this reference.
*/
public org.opencrx.kernel.depot1.jmi1.DepotEntity getEntity(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.depot1.jmi1.OpenDepotResult openDepot(
org.opencrx.kernel.depot1.jmi1.OpenDepotParams in
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
}