org.opencrx.kernel.account1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.account1.jmi1;
/**
* Class {@code Segment}
*
* isFrozenisFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:38.116359927Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Segment
extends org.opencrx.kernel.account1.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{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code account} 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 getAccount(
org.opencrx.kernel.account1.cci2.AccountQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code account} 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.account1.jmi1.Account getAccount(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code account} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAccount(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.account1.jmi1.Account getAccount(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code account}.
*
* 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 account The element to be appended.
*/
public void addAccount (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Account account
);
/**
* Adds the specified element to the set of the values for the reference {@code account} 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 account The element to be appended.
*/
public void addAccount (
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Account account
);
/**
* Adds the specified element to the set of the values for the reference {@code account} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param account The element to be appended.
*/
public void addAccount (
org.opencrx.kernel.account1.jmi1.Account account
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code accountFilter} 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 getAccountFilter(
org.opencrx.kernel.account1.cci2.AccountFilterGlobalQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code accountFilter} 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.account1.jmi1.AccountFilterGlobal getAccountFilter(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code accountFilter} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAccountFilter(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.account1.jmi1.AccountFilterGlobal getAccountFilter(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code accountFilter}.
*
* 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 accountFilter The element to be appended.
*/
public void addAccountFilter (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.account1.jmi1.AccountFilterGlobal accountFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code accountFilter} 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 accountFilter The element to be appended.
*/
public void addAccountFilter (
java.lang.String id,
org.opencrx.kernel.account1.jmi1.AccountFilterGlobal accountFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code accountFilter} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param accountFilter The element to be appended.
*/
public void addAccountFilter (
org.opencrx.kernel.account1.jmi1.AccountFilterGlobal accountFilter
);
// ----------------------------------------------------------------------------
// 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.account1.cci2.AccountAddressQuery 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.account1.jmi1.AccountAddress 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.account1.jmi1.AccountAddress getAddress(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code addressFilter} 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 getAddressFilter(
org.opencrx.kernel.account1.cci2.AddressFilterGlobalQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code addressFilter} 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.account1.jmi1.AddressFilterGlobal getAddressFilter(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code addressFilter} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAddressFilter(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.account1.jmi1.AddressFilterGlobal getAddressFilter(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code addressFilter}.
*
* 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 addressFilter The element to be appended.
*/
public void addAddressFilter (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.account1.jmi1.AddressFilterGlobal addressFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code addressFilter} 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 addressFilter The element to be appended.
*/
public void addAddressFilter (
java.lang.String id,
org.opencrx.kernel.account1.jmi1.AddressFilterGlobal addressFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code addressFilter} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param addressFilter The element to be appended.
*/
public void addAddressFilter (
org.opencrx.kernel.account1.jmi1.AddressFilterGlobal addressFilter
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code competitor} 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 getCompetitor(
org.opencrx.kernel.account1.cci2.CompetitorQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code competitor} 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.account1.jmi1.Competitor getCompetitor(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code competitor} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getCompetitor(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.account1.jmi1.Competitor getCompetitor(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code competitor}.
*
* 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 competitor The element to be appended.
*/
public void addCompetitor (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Competitor competitor
);
/**
* Adds the specified element to the set of the values for the reference {@code competitor} 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 competitor The element to be appended.
*/
public void addCompetitor (
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Competitor competitor
);
/**
* Adds the specified element to the set of the values for the reference {@code competitor} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param competitor The element to be appended.
*/
public void addCompetitor (
org.opencrx.kernel.account1.jmi1.Competitor competitor
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code organization} 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 getOrganization(
org.opencrx.kernel.account1.cci2.OrganizationQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code organization} 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.account1.jmi1.Organization getOrganization(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code organization} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getOrganization(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.account1.jmi1.Organization getOrganization(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code organization}.
*
* 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 organization The element to be appended.
*/
public void addOrganization (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Organization organization
);
/**
* Adds the specified element to the set of the values for the reference {@code organization} 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 organization The element to be appended.
*/
public void addOrganization (
java.lang.String id,
org.opencrx.kernel.account1.jmi1.Organization organization
);
/**
* Adds the specified element to the set of the values for the reference {@code organization} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param organization The element to be appended.
*/
public void addOrganization (
org.opencrx.kernel.account1.jmi1.Organization organization
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code searchIndexEntry} 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 getSearchIndexEntry(
org.opencrx.kernel.account1.cci2.SearchIndexEntryQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code searchIndexEntry} 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.account1.jmi1.SearchIndexEntry getSearchIndexEntry(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code searchIndexEntry} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getSearchIndexEntry(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.account1.jmi1.SearchIndexEntry getSearchIndexEntry(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}