org.opencrx.kernel.activity1.jmi1.ActivityGroup Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.activity1.jmi1;
/**
* Abstract class {@code ActivityGroup}
*
* isFrozen
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.052594492Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface ActivityGroup
extends org.opencrx.kernel.activity1.cci2.ActivityGroup,
org.opencrx.kernel.activity1.jmi1.ActivitiesSource,
org.opencrx.kernel.base.jmi1.SecureObject,
org.openmdx.base.jmi1.BasicObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityCreator} 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 getActivityCreator(
org.opencrx.kernel.activity1.cci2.ActivityCreatorQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityCreator} 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.activity1.jmi1.ActivityCreator getActivityCreator(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code activityCreator} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getActivityCreator(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.activity1.jmi1.ActivityCreator getActivityCreator(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityFilter} 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 getActivityFilter(
org.opencrx.kernel.activity1.cci2.ActivityFilterGroupQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityFilter} 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.activity1.jmi1.ActivityFilterGroup getActivityFilter(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code activityFilter} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getActivityFilter(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.activity1.jmi1.ActivityFilterGroup getActivityFilter(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code activityFilter}.
*
* 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 activityFilter The element to be appended.
*/
public void addActivityFilter (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.ActivityFilterGroup activityFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code activityFilter} 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 activityFilter The element to be appended.
*/
public void addActivityFilter (
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.ActivityFilterGroup activityFilter
);
/**
* Adds the specified element to the set of the values for the reference {@code activityFilter} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param activityFilter The element to be appended.
*/
public void addActivityFilter (
org.opencrx.kernel.activity1.jmi1.ActivityFilterGroup activityFilter
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityGroupRelationship} 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 getActivityGroupRelationship(
org.opencrx.kernel.activity1.cci2.ActivityGroupRelationshipQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityGroupRelationship} 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.activity1.jmi1.ActivityGroupRelationship getActivityGroupRelationship(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code activityGroupRelationship} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getActivityGroupRelationship(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.activity1.jmi1.ActivityGroupRelationship getActivityGroupRelationship(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code activityGroupRelationship}.
*
* 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 activityGroupRelationship The element to be appended.
*/
public void addActivityGroupRelationship (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.ActivityGroupRelationship activityGroupRelationship
);
/**
* Adds the specified element to the set of the values for the reference {@code activityGroupRelationship} 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 activityGroupRelationship The element to be appended.
*/
public void addActivityGroupRelationship (
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.ActivityGroupRelationship activityGroupRelationship
);
/**
* Adds the specified element to the set of the values for the reference {@code activityGroupRelationship} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param activityGroupRelationship The element to be appended.
*/
public void addActivityGroupRelationship (
org.opencrx.kernel.activity1.jmi1.ActivityGroupRelationship activityGroupRelationship
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityNote} 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 getActivityNote(
org.opencrx.kernel.generic.cci2.NoteQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code activityNote} 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.generic.jmi1.Note getActivityNote(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code activityNote} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getActivityNote(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.generic.jmi1.Note getActivityNote(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code assignedAccount} 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 getAssignedAccount(
org.opencrx.kernel.activity1.cci2.AccountAssignmentActivityGroupQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code assignedAccount} 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.activity1.jmi1.AccountAssignmentActivityGroup getAssignedAccount(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code assignedAccount} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getAssignedAccount(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.activity1.jmi1.AccountAssignmentActivityGroup getAssignedAccount(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code assignedAccount}.
*
* 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 assignedAccount The element to be appended.
*/
public void addAssignedAccount (
boolean idIsPersistent,
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.AccountAssignmentActivityGroup assignedAccount
);
/**
* Adds the specified element to the set of the values for the reference {@code assignedAccount} 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 assignedAccount The element to be appended.
*/
public void addAssignedAccount (
java.lang.String id,
org.opencrx.kernel.activity1.jmi1.AccountAssignmentActivityGroup assignedAccount
);
/**
* Adds the specified element to the set of the values for the reference {@code assignedAccount} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param assignedAccount The element to be appended.
*/
public void addAssignedAccount (
org.opencrx.kernel.activity1.jmi1.AccountAssignmentActivityGroup assignedAccount
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.activity1.jmi1.CalcTotalQuantityResult calcTotalQuantity(
org.opencrx.kernel.activity1.jmi1.CalcTotalQuantityParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code creationContext}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.openmdx.base.jmi1.ContextCapable getCreationContext(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code creationContext}.
* @param creationContext The new—possibly {@code null}—value for this reference.
*/
public void setCreationContext(
org.openmdx.base.cci2.ContextCapable creationContext
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code defaultCreator}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.activity1.jmi1.ActivityCreator getDefaultCreator(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code defaultCreator}.
* @param defaultCreator The new—possibly {@code null}—value for this reference.
*/
public void setDefaultCreator(
org.opencrx.kernel.activity1.cci2.ActivityCreator defaultCreator
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code filteredActivity} 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 getFilteredActivity(
org.opencrx.kernel.activity1.cci2.ActivityQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code filteredActivity} 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.activity1.jmi1.Activity getFilteredActivity(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code filteredActivity} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFilteredActivity(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.activity1.jmi1.Activity getFilteredActivity(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code followUp} 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 getFollowUp(
org.opencrx.kernel.activity1.cci2.ActivityFollowUpQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code followUp} 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.activity1.jmi1.ActivityFollowUp getFollowUp(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code followUp} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getFollowUp(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.activity1.jmi1.ActivityFollowUp getFollowUp(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code mainActivity}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.activity1.jmi1.Activity getMainActivity(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code mainActivity}.
* @param mainActivity The new—possibly {@code null}—value for this reference.
*/
public void setMainActivity(
org.opencrx.kernel.activity1.cci2.Activity mainActivity
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code targetGroupAccounts}.
* @return The —possibly {@code null}— value for this reference.
*/
public org.opencrx.kernel.account1.jmi1.AbstractFilterAccount getTargetGroupAccounts(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference {@code targetGroupAccounts}.
* @param targetGroupAccounts The new—possibly {@code null}—value for this reference.
*/
public void setTargetGroupAccounts(
org.opencrx.kernel.account1.cci2.AbstractFilterAccount targetGroupAccounts
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code workReportEntry} 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 getWorkReportEntry(
org.opencrx.kernel.activity1.cci2.WorkAndExpenseRecordQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code workReportEntry} 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.activity1.jmi1.WorkAndExpenseRecord getWorkReportEntry(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference {@code workReportEntry} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getWorkReportEntry(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.activity1.jmi1.WorkAndExpenseRecord getWorkReportEntry(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}