org.opencrx.kernel.depot1.jmi1.Depot Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.depot1.jmi1;
/**
* Class {@code Depot}
*
* isFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:38.610559700Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Depot
extends org.opencrx.kernel.depot1.cci2.Depot,
org.opencrx.kernel.base.jmi1.PropertySet,
org.opencrx.kernel.contract1.jmi1.ContractReferenceHolder,
org.opencrx.kernel.generic.jmi1.CrxObject,
org.opencrx.kernel.generic.jmi1.DescriptionContainer{
// ----------------------------------------------------------------------------
// 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/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.depot1.jmi1.CloseDepotResult closeDepot(
org.opencrx.kernel.depot1.jmi1.CloseDepotParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depotGroup}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.depot1.jmi1.DepotGroup getDepotGroup(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code depotGroup}.
* @param depotGroup The new—possibly {@code null}—value for this reference.
*/
public void setDepotGroup(
org.opencrx.kernel.depot1.cci2.DepotGroup depotGroup
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depotHolder}.
* @return The non-{@code null} value for this reference.
*/
public org.opencrx.kernel.depot1.jmi1.DepotHolder getDepotHolder(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depotReference} 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 getDepotReference(
org.opencrx.kernel.depot1.cci2.DepotReferenceQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code depotReference} 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.DepotReference getDepotReference(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code depotReference} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getDepotReference(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.DepotReference getDepotReference(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code depotReference}.
*
* 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 depotReference The element to be appended.
*/
public void addDepotReference (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotReference depotReference
);
/**
* Adds the specified element to the set of the values for the reference {@code depotReference} 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 depotReference The element to be appended.
*/
public void addDepotReference (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotReference depotReference
);
/**
* Adds the specified element to the set of the values for the reference {@code depotReference} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param depotReference The element to be appended.
*/
public void addDepotReference (
org.opencrx.kernel.depot1.jmi1.DepotReference depotReference
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code latestReport}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.depot1.jmi1.DepotReport getLatestReport(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code latestReport}.
* @param latestReport The new—possibly {@code null}—value for this reference.
*/
public void setLatestReport(
org.opencrx.kernel.depot1.cci2.DepotReport latestReport
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.depot1.jmi1.OpenDepotPositionResult openDepotPosition(
org.opencrx.kernel.depot1.jmi1.OpenDepotPositionParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code position} 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 getPosition(
org.opencrx.kernel.depot1.cci2.DepotPositionQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code position} 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.DepotPosition getPosition(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code position} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getPosition(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.DepotPosition getPosition(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code position}.
*
* 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 position The element to be appended.
*/
public void addPosition (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotPosition position
);
/**
* Adds the specified element to the set of the values for the reference {@code position} 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 position The element to be appended.
*/
public void addPosition (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotPosition position
);
/**
* Adds the specified element to the set of the values for the reference {@code position} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param position The element to be appended.
*/
public void addPosition (
org.opencrx.kernel.depot1.jmi1.DepotPosition position
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code report} 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 getReport(
org.opencrx.kernel.depot1.cci2.DepotReportQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code report} 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.DepotReport getReport(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code report} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getReport(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.DepotReport getReport(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code report}.
*
* 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 report The element to be appended.
*/
public void addReport (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotReport report
);
/**
* Adds the specified element to the set of the values for the reference {@code report} 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 report The element to be appended.
*/
public void addReport (
java.lang.String id,
org.opencrx.kernel.depot1.jmi1.DepotReport report
);
/**
* Adds the specified element to the set of the values for the reference {@code report} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param report The element to be appended.
*/
public void addReport (
org.opencrx.kernel.depot1.jmi1.DepotReport report
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
}