org.opencrx.kernel.home1.jdo2
Class Segment

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.openmdx.base.jdo2.Segment
              org.opencrx.kernel.jdo2.Segment
                  org.opencrx.kernel.home1.jdo2.Segment

All Implemented Interfaces:

Serializable, Detachable, PersistenceCapable, Auditee, Indexed, SecureObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

public class Segment
extends Segment
implements Segment

Class Segment

See Also:

Serialized Form

Nested Class Summary

static class

Segment.Slice

Nested classes/interfaces inherited from class org.openmdx.base.jdo2.Segment

org.openmdx.base.jdo2.Segment.Identity

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.BLOB, org.w3c.jdo2.AbstractObject.CLOB, org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

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

org.openmdx.base.cci2.Segment.Identity

Nested classes/interfaces inherited from interface javax.jdo.spi.PersistenceCapable

PersistenceCapable.ObjectIdFieldConsumer, PersistenceCapable.ObjectIdFieldManager, PersistenceCapable.ObjectIdFieldSupplier

Field Summary

static List<String>

CLASS Define the model class org::opencrx::kernel::home1::Segment

Fields inherited from class org.openmdx.base.jdo2.Segment

BASE_CLASS

Fields inherited from interface javax.jdo.spi.PersistenceCapable

CHECK_READ, CHECK_WRITE, LOAD_REQUIRED, MEDIATE_READ, MEDIATE_WRITE, READ_OK, READ_WRITE_OK, SERIALIZABLE

Constructor Summary

Segment()

Method Summary

<T extends ModifySecureObjectResult> T	addOwningGroup(PrincipalGroup group, short mode)
<T extends CreateUserResult> T	createUser(Contact contact, String initialPassword, String initialPasswordVerification, PrincipalGroup primaryUserGroup, String principalName)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
<T extends AuditEntry> Collection<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
<T extends IndexEntry> Collection<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
List<String>	getOwner()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends UserHome> Collection<T>	getUserHome() Retrieves a set containing all the elements for the reference userHome.
<T extends UserHome> T	getUserHome(String principalId) Retrieves the value for the optional reference userHome for the specified qualifier attribute value.
<T extends ImportUsersResult> T	importUsers(byte[] item, String itemMimeType, String itemName)
static org.openmdx.base.jdo2.Segment.Identity	newIdentity(org.openmdx.base.cci2.Provider.Identity provider, boolean qualifiedNameIsPersistent, String qualifiedName)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected int	openmdxjdoGetSize(int field)
protected void	openmdxjdoSetSize(int field, int size)
<T extends ModifySecureObjectResult> T	removeAllOwningGroup(short mode)
<T extends ModifySecureObjectResult> T	removeOwningGroup(PrincipalGroup group, short mode)
<T extends ModifySecureObjectResult> T	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
<T extends ModifySecureObjectResult> T	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
<T extends org.openmdx.base.cci2.Void> T	updateIndex()

Methods inherited from class org.opencrx.kernel.jdo2.Segment

openmdxjdoGetSlices

Methods inherited from class org.openmdx.base.jdo2.Segment

getDescription, getProvider, getView, jdoCopyFields, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsToObjectId, jdoCopyKeyFieldsToObjectId, jdoGetObjectId, jdoGetPersistenceManager, jdoGetTransactionalObjectId, jdoGetVersion, jdoIsDeleted, jdoIsDetached, jdoIsDetachedInternal, jdoIsDirty, jdoIsNew, jdoIsPersistent, jdoIsTransactional, jdoMakeDirty, jdoNewInstance, jdoNewInstance, jdoNewObjectIdInstance, jdoNewObjectIdInstance, jdoPreSerialize, jdoProvideField, jdoProvideFields, jdoReplaceDetachedState, jdoReplaceField, jdoReplaceFields, jdoReplaceFlags, jdoReplaceStateManager, openmdxjdoGetObjectId, openmdxjdoGetObjectsByParent, setDescription, setProvider, setProvider

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetIdentity, openmdxjdoGetIdentity, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDescription, getProvider, setDescription, setProvider, setProvider

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

getView

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::home1::Segment

Constructor Detail

Segment

public Segment()

Method Detail

addOwningGroup

public <T extends ModifySecureObjectResult> T addOwningGroup(PrincipalGroup group,
                                                             short mode)
                                                  throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

accessLevelDelete - The non-null new value for attribute accessLevelDelete.

getUserHome

public <T extends UserHome> Collection<T> getUserHome()

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

Returns:

A set containing all the elements for this reference.

getUserHome

public <T extends UserHome> T 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.

getAudit

public <T extends AuditEntry> Collection<T> getAudit()

Retrieves a set containing all the elements for the reference audit.

Specified by:

getAudit in interface Auditee

Returns:

A set containing all the elements for this reference.

removeOwningGroup

public <T extends ModifySecureObjectResult> T removeOwningGroup(PrincipalGroup group,
                                                                short mode)
                                                     throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.

updateIndex

public <T extends org.openmdx.base.cci2.Void> T updateIndex()
                                                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

accessLevelUpdate - The non-null new value for attribute accessLevelUpdate.

importUsers

public <T extends ImportUsersResult> T importUsers(byte[] item,
                                                   String itemMimeType,
                                                   String itemName)
                                        throws RefException

Throws:

RefException

createUser

public <T extends CreateUserResult> T createUser(Contact contact,
                                                 String initialPassword,
                                                 String initialPasswordVerification,
                                                 PrincipalGroup primaryUserGroup,
                                                 String principalName)
                                      throws RefException

Throws:

RefException

removeAllOwningGroup

public <T extends ModifySecureObjectResult> T removeAllOwningGroup(short mode)
                                                        throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

getAccessGrantedByParent

public 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.

setAccessLevel

public <T extends ModifySecureObjectResult> T setAccessLevel(short accessLevelBrowse,
                                                             short accessLevelDelete,
                                                             short accessLevelUpdate,
                                                             short mode)
                                                  throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

getOwner

public final List<String> getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getIndexEntry

public <T extends IndexEntry> Collection<T> getIndexEntry()

Retrieves a set containing all the elements for the reference indexEntry.

Specified by:

getIndexEntry in interface Indexed

Returns:

A set containing all the elements for this reference.

setOwningUser

public <T extends ModifySecureObjectResult> T setOwningUser(short mode,
                                                            User user)
                                                 throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public 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.

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class Segment

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class Segment

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

Overrides:

newSlice in class Segment

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Overrides:

openmdxjdoGetClass in class Segment

Returns:

the model class

See Also:

Segment.CLASS

newIdentity

public static org.openmdx.base.jdo2.Segment.Identity newIdentity(org.openmdx.base.cci2.Provider.Identity provider,
                                                                 boolean qualifiedNameIsPersistent,
                                                                 String qualifiedName)