org.opencrx.kernel.building1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.building1.jmi1;
/**
* Class {@code Segment}
*
* isFrozenisFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:38.439036999Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Segment
extends org.opencrx.kernel.building1.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,
org.opencrx.kernel.base.jmi1.WorkflowTarget{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code building} 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 getBuilding(
org.opencrx.kernel.building1.cci2.BuildingQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code building} 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.building1.jmi1.Building getBuilding(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code building} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getBuilding(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.building1.jmi1.Building getBuilding(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code building}.
*
* 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 building The element to be appended.
*/
public void addBuilding (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.building1.jmi1.Building building
);
/**
* Adds the specified element to the set of the values for the reference {@code building} 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 building The element to be appended.
*/
public void addBuilding (
java.lang.String id,
org.opencrx.kernel.building1.jmi1.Building building
);
/**
* Adds the specified element to the set of the values for the reference {@code building} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param building The element to be appended.
*/
public void addBuilding (
org.opencrx.kernel.building1.jmi1.Building building
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code buildingComplex} 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 getBuildingComplex(
org.opencrx.kernel.building1.cci2.BuildingComplexQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code buildingComplex} 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.building1.jmi1.BuildingComplex getBuildingComplex(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code buildingComplex} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getBuildingComplex(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.building1.jmi1.BuildingComplex getBuildingComplex(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code buildingComplex}.
*
* 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 buildingComplex The element to be appended.
*/
public void addBuildingComplex (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.building1.jmi1.BuildingComplex buildingComplex
);
/**
* Adds the specified element to the set of the values for the reference {@code buildingComplex} 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 buildingComplex The element to be appended.
*/
public void addBuildingComplex (
java.lang.String id,
org.opencrx.kernel.building1.jmi1.BuildingComplex buildingComplex
);
/**
* Adds the specified element to the set of the values for the reference {@code buildingComplex} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param buildingComplex The element to be appended.
*/
public void addBuildingComplex (
org.opencrx.kernel.building1.jmi1.BuildingComplex buildingComplex
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code buildingUnit} 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 getBuildingUnit(
org.opencrx.kernel.building1.cci2.AbstractBuildingUnitQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code buildingUnit} 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.building1.jmi1.AbstractBuildingUnit getBuildingUnit(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code buildingUnit} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getBuildingUnit(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.building1.jmi1.AbstractBuildingUnit getBuildingUnit(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code facility} 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 getFacility(
org.opencrx.kernel.building1.cci2.FacilityQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code facility} 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.building1.jmi1.Facility getFacility(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code facility} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFacility(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.building1.jmi1.Facility getFacility(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code inventoryItem} 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 getInventoryItem(
org.opencrx.kernel.building1.cci2.InventoryItemQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code inventoryItem} 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.building1.jmi1.InventoryItem getInventoryItem(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code inventoryItem} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getInventoryItem(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.building1.jmi1.InventoryItem getInventoryItem(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code inventoryItem}.
*
* 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 inventoryItem The element to be appended.
*/
public void addInventoryItem (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.building1.jmi1.InventoryItem inventoryItem
);
/**
* Adds the specified element to the set of the values for the reference {@code inventoryItem} 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 inventoryItem The element to be appended.
*/
public void addInventoryItem (
java.lang.String id,
org.opencrx.kernel.building1.jmi1.InventoryItem inventoryItem
);
/**
* Adds the specified element to the set of the values for the reference {@code inventoryItem} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param inventoryItem The element to be appended.
*/
public void addInventoryItem (
org.opencrx.kernel.building1.jmi1.InventoryItem inventoryItem
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}