org.opencrx.kernel.home1.jmi1
Interface Segment

All Superinterfaces:

Auditee, org.openmdx.base.cci2.ContextCapable, Indexed, RefBaseObject, RefFeatured, RefObject, SecureObject, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

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

void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
void	addUserHome(String principalId, UserHome newValue)
void	addUserHome(UserHome newValue)
<T extends CreateUserResult> T	createUser(CreateUserParams params)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends AuditEntry> List<T>	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
<T extends org.openmdx.base.cci2.ExtentCapable> List<T>	getExtent(org.openmdx.base.cci2.ExtentCapableQuery query) Retrieves the value for the reference extent for the specified query.
<T extends IndexEntry> List<T>	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
User	getOwningUser() Retrieves the value for the reference owningUser.
org.openmdx.base.jdo2.Provider	getProvider() Retrieves the value for the reference provider.
<T extends UserHome> List<T>	getUserHome(UserHomeQuery query) Retrieves the value for the reference userHome for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View> List<T>	getView(org.openmdx.compatibility.view1.cci2.ViewQuery query) Retrieves the value for the reference view for the specified query.
<T extends ImportUsersResult> T	importUsers(ImportUsersParams params)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeUserHome(String principalId)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.

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

createUser, getUserHome, getUserHome, importUsers

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

setProvider, setProvider

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

getDescription, setDescription

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

getView

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

getAudit

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

updateIndex

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

getIndexEntry, updateIndex

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

addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser

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

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

Method Detail

getAudit

<T extends AuditEntry> List<T> getAudit(AuditEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getIndexEntry

<T extends IndexEntry> List<T> getIndexEntry(IndexEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getAccessGrantedByParent

org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:

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

newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:

newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)

getOwningUser

User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

owningUser - The non-null new value for this reference.

removeOwningUser

void removeOwningUser()

Removes the value for the optional reference owningUser.

createUser

<T extends CreateUserResult> T createUser(CreateUserParams params)
                                      throws RefException

Throws:

RefException

importUsers

<T extends ImportUsersResult> T importUsers(ImportUsersParams params)
                                        throws RefException

Throws:

RefException

getUserHome

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

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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.

addUserHome

void addUserHome(UserHome newValue)

Parameters:

newValue - The element to be appended.

removeUserHome

void removeUserHome(String principalId)

getExtent

<T extends org.openmdx.base.cci2.ExtentCapable> List<T> getExtent(org.openmdx.base.cci2.ExtentCapableQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getProvider

org.openmdx.base.jdo2.Provider getProvider()

Retrieves the value for the reference provider.

Specified by:

getProvider in interface org.openmdx.base.cci2.Segment

Returns:

The non-null value for this reference.

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.