org.opencrx.kernel.home1.cci
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment, ViewCapable

public interface Segment
extends Segment, Auditee, Indexed, SecureObject

Method Summary

void	addUserHome(String principalId, UserHome newValue)
void	addUserHome(UserHome newValue)
CreateUserResult	createUser(Contact contact, String initialPassword, String initialPasswordVerification, PrincipalGroup primaryUserGroup, String principalName)
CreateUserResult	createUser(CreateUserParams params)
Collection	getUserHome() Retrieves a collection containing all the elements for the reference userHome.
UserHome	getUserHome(String principalId) Retrieves the value for the optional reference userHome for the specified qualifier attribute value.
List	getUserHome(UserHomeFilter filter) Retrieves the value for the reference userHome for the specified filter.
List	getUserHome(UserHomeQuery query) Retrieves the value for the reference userHome for the specified query.
ImportUsersResult	importUsers(byte[] item, String itemMimeType, String itemName)
ImportUsersResult	importUsers(ImportUsersParams params)
void	removeUserHome(String principalId)

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

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

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

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

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.cci.Auditee

getAudit, getAudit, getAudit, getAudit

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Method Detail

createUser

CreateUserResult createUser(CreateUserParams params)
                            throws RefException

Throws:

RefException

createUser

CreateUserResult createUser(Contact contact,
                            String initialPassword,
                            String initialPasswordVerification,
                            PrincipalGroup primaryUserGroup,
                            String principalName)
                            throws RefException

Throws:

RefException

importUsers

ImportUsersResult importUsers(ImportUsersParams params)
                              throws RefException

Throws:

RefException

importUsers

ImportUsersResult importUsers(byte[] item,
                              String itemMimeType,
                              String itemName)
                              throws RefException

Throws:

RefException

getUserHome

UserHome getUserHome(String principalId)

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

Parameters:

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

Returns:

The non-null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getUserHome

Collection getUserHome()

Retrieves a collection containing all the elements for the reference userHome.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserHome

List getUserHome(UserHomeFilter filter)

Retrieves the value for the reference userHome for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getUserHome

List getUserHome(UserHomeQuery query)

Retrieves the value for the reference userHome for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addUserHome

void addUserHome(String principalId,
                 UserHome newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addUserHome

void addUserHome(UserHome newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeUserHome

void removeUserHome(String principalId)

Throws:

JmiException - If the value cannot be removed for some reason.