org.opencrx.kernel.depot1.cci2.Depot Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.depot1.cci2;
/**
* Class {@code Depot}
*
* isFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:36.168810491Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Depot
extends org.opencrx.kernel.base.cci2.PropertySet,
org.opencrx.kernel.contract1.cci2.ContractReferenceHolder,
org.opencrx.kernel.generic.cci2.CrxObject,
org.opencrx.kernel.generic.cci2.DescriptionContainer{
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code allowPositionAutoCreate}.
* @return The non-null value for attribute {@code allowPositionAutoCreate}.
*/
public boolean isAllowPositionAutoCreate(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code allowPositionAutoCreate}.
* @param allowPositionAutoCreate The non-{@code null} new value for attribute {@code allowPositionAutoCreate}.
*/
public void setAllowPositionAutoCreate(
boolean allowPositionAutoCreate
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.openmdx.base.cci2.Void assertReports(
org.opencrx.kernel.depot1.cci2.AssertReportsParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code bookingEntry}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.depot1.cci2.DepotContainsBookingEntry.BookingEntry getBookingEntry(
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.depot1.cci2.CloseDepotResult closeDepot(
org.opencrx.kernel.depot1.cci2.CloseDepotParams in
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code closingDate}.
* @return The possibly null value for attribute {@code closingDate}.
*/
public java.util.Date getClosingDate(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code closingDate}.
* @param closingDate The possibly null new value for attribute {@code closingDate}.
*/
public void setClosingDate(
java.util.Date closingDate
);
// ----------------------------------------------------------------------------
// 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.cci2.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.cci2.DepotHolder getDepotHolder(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code depotNumber}.
* @return The non-null value for attribute {@code depotNumber}.
*/
public java.lang.String getDepotNumber(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code depotNumber}.
* @param depotNumber The non-{@code null} new value for attribute {@code depotNumber}.
*/
public void setDepotNumber(
java.lang.String depotNumber
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code depotReference}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.depot1.cci2.DepotHasDepotReference.DepotReference getDepotReference(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nNoQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the {@code Collection} of objects referenced by {@code depotType}.
* @return The {@code Collection} of referenced objects.
*/
public java.util.List getDepotType(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code description}.
* @return The possibly null value for attribute {@code description}.
*/
public java.lang.String getDescription(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code description}.
* @param description The possibly null new value for attribute {@code description}.
*/
public void setDescription(
java.lang.String description
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code isDefault}.
* @return The non-null value for attribute {@code isDefault}.
*/
public boolean isDefault(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code isDefault}.
* @param isDefault The non-{@code null} new value for attribute {@code isDefault}.
*/
public void setDefault(
boolean isDefault
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code isLocked}.
* @return The non-null value for attribute {@code isLocked}.
*/
public boolean isLocked(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code isLocked}.
* @param isLocked The non-{@code null} new value for attribute {@code isLocked}.
*/
public void setLocked(
boolean isLocked
);
// ----------------------------------------------------------------------------
// 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.cci2.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/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code name}.
* @return The non-null value for attribute {@code name}.
*/
public java.lang.String getName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code name}.
* @param name The non-{@code null} new value for attribute {@code name}.
*/
public void setName(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.depot1.cci2.OpenDepotPositionResult openDepotPosition(
org.opencrx.kernel.depot1.cci2.OpenDepotPositionParams in
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code openingDate}.
* @return The non-null value for attribute {@code openingDate}.
*/
public java.util.Date getOpeningDate(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code openingDate}.
* @param openingDate The non-{@code null} new value for attribute {@code openingDate}.
*/
public void setOpeningDate(
java.util.Date openingDate
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code position}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.depot1.cci2.DepotHasDepotPosition.Position getPosition(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference {@code report}.
* @return A set containing all the elements for this reference.
*/
public org.opencrx.kernel.depot1.cci2.DepotHasReport.Report getReport(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the {@code DepotHolder}'s identity
* @return the parent object's identity
*/
public org.opencrx.kernel.depot1.cci2.DepotHolder.Identity getDepotHolder();
/**
* Tells whether the {@code id} value is persistent or reassignable.
* @return {@code PERSISTENT} or {@code REASSIGNABLE}
*/
public org.oasisopen.cci2.QualifierType getIdType();
/**
* The {@code id} value
* @return the {@code id} value
*/
public java.lang.String getId();
}
}