org.opencrx.kernel.home1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.home1.jmi1;
/**
* Class {@code Segment}
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:37.926712542Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Segment
extends org.opencrx.kernel.home1.cci2.Segment,
org.opencrx.kernel.jmi1.Segment,
org.opencrx.kernel.base.jmi1.Auditee,
org.opencrx.kernel.base.jmi1.Indexed,
org.opencrx.kernel.base.jmi1.SecureObject{
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.home1.jmi1.CreateUserResult createUser(
org.opencrx.kernel.home1.jmi1.CreateUserParams in
);
// ----------------------------------------------------------------------------
// Instance/Operation
// ----------------------------------------------------------------------------
/**
*/
public org.opencrx.kernel.home1.jmi1.ImportUsersResult importUsers(
org.opencrx.kernel.home1.jmi1.ImportUsersParams in
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code userHome} 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 getUserHome(
org.opencrx.kernel.home1.cci2.UserHomeQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference {@code userHome} for the specified qualifier attribute value.
*
* @param principalIdIsPersistent Defines whether value for the qualifier is persistent or not
* @param principalId The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.home1.jmi1.UserHome getUserHome(
boolean principalIdIsPersistent,
java.lang.String principalId
);
/**
* Retrieves the value for the reference {@code userHome} for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation {@code getUserHome(false,principalId)}.
*
* @param principalId The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.opencrx.kernel.home1.jmi1.UserHome getUserHome(
java.lang.String principalId
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference {@code userHome}.
*
* Note: This is an extension to the JMI 1 standard.
* @param principalIdIsPersistent {@code true} if {@code principalId} is persistent
* @param principalId The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param userHome The element to be appended.
*/
public void addUserHome (
boolean principalIdIsPersistent,
java.lang.String principalId,
org.opencrx.kernel.home1.jmi1.UserHome userHome
);
/**
* Adds the specified element to the set of the values for the reference {@code userHome} using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param principalId The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param userHome The element to be appended.
*/
public void addUserHome (
java.lang.String principalId,
org.opencrx.kernel.home1.jmi1.UserHome userHome
);
/**
* Adds the specified element to the set of the values for the reference {@code userHome} using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param userHome The element to be appended.
*/
public void addUserHome (
org.opencrx.kernel.home1.jmi1.UserHome userHome
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}