org.opencrx.kernel.home1.jmi1

Interface Segment

All Superinterfaces:

Auditee, org.openmdx.base.cci2.ContextCapable, Indexed, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject, org.openmdx.base.cci2.Segment

public interface Segment
extends Segment, Segment, Auditee, Indexed, SecureObject

Class Segment

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

org.openmdx.base.cci2.Segment.Identity

Method Summary

Modifier and Type	Method and Description
void	addUserHome(boolean principalIdIsPersistent, String principalId, UserHome userHome) Adds the specified element to the set of the values for the reference userHome.
void	addUserHome(String principalId, UserHome userHome) Adds the specified element to the set of the values for the reference userHome using a reassignable qualifier.
void	addUserHome(UserHome userHome) Adds the specified element to the set of the values for the reference userHome using an implementation-specific, reassignable qualifier.
CreateUserResult	createUser(CreateUserParams in)
UserHome	getUserHome(boolean principalIdIsPersistent, String principalId) Retrieves the value for the reference userHome for the specified qualifier attribute value.
UserHome	getUserHome(String principalId) Retrieves the value for the reference userHome for the specified qualifier attribute value.
<T extends UserHome> List<T>	getUserHome(UserHomeQuery query) Retrieves the value for the reference userHome for the specified query.
ImportUsersResult	importUsers(ImportUsersParams in)

Methods inherited from interface org.opencrx.kernel.home1.cci2.Segment

createUser, getUserHome, importUsers

Methods inherited from interface org.openmdx.base.jmi1.Segment

getExtent, getExtent, getExtent, getProvider

Methods inherited from interface org.openmdx.base.cci2.Segment

getDescription, getExtent, setDescription

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface org.opencrx.kernel.base.jmi1.Auditee

getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.jmi1.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject

addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser

Method Detail

createUser

CreateUserResult createUser(CreateUserParams in)

importUsers

ImportUsersResult importUsers(ImportUsersParams in)

getUserHome

<T extends UserHome> List<T> getUserHome(UserHomeQuery query)

Retrieves the value for the reference 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 java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getUserHome

UserHome getUserHome(boolean principalIdIsPersistent,
                     String principalId)

Retrieves the value for the reference userHome for the specified qualifier attribute value.

Parameters:

principalIdIsPersistent - Defines whether value for the qualifier is persistent or not

principalId - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getUserHome

UserHome getUserHome(String principalId)

Retrieves the value for the reference userHome for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getUserHome(false,principalId).

Parameters:

principalId - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addUserHome

void addUserHome(boolean principalIdIsPersistent,
                 String principalId,
                 UserHome userHome)

Adds the specified element to the set of the values for the reference userHome.

Note: This is an extension to the JMI 1 standard.

Parameters:

principalIdIsPersistent - true if principalId is persistent

principalId - The qualifier attribute value that qualifies the reference to get the element to be appended.

userHome - The element to be appended.

addUserHome

void addUserHome(String principalId,
                 UserHome userHome)

Adds the specified element to the set of the values for the reference userHome using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

principalId - The qualifier attribute value that qualifies the reference to get the element to be appended.

userHome - The element to be appended.

addUserHome

void addUserHome(UserHome userHome)

Adds the specified element to the set of the values for the reference userHome using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

userHome - The element to be appended.