org.opencrx.kernel.model1.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.model1.jdo2.Segment

All Implemented Interfaces:

Serializable, Detachable, PersistenceCapable, Auditee, Importer, Indexed, SecureObject, XmlExporter, 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 Slice object hold the Segment's multivalued attributes

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.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::model1::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

void	addElement(boolean idIsPersistent, String id, Element element) Adds the specified element to the set of the values for the reference element.
ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
CheckPermissionsResult	checkPermissions(String principalName)
ExportResult	exportXml(String attributeFilter, String referenceFilter)
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.
AuditEntry	getAudit(boolean idIsPersistent, String id) Retrieves the value for the reference audit for the specified qualifier attribute value.
<T extends Element> Collection<T>	getElement() Retrieves a set containing all the elements for the reference element.
Element	getElement(boolean idIsPersistent, String id) Retrieves the value for the reference element for the specified qualifier attribute value.
<T extends IndexEntry> Collection<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
IndexEntry	getIndexEntry(boolean idIsPersistent, String id) Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
ImportResult	importItem(byte[] item, String itemMimeType, String itemName, short locale)
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)
static org.openmdx.base.jdo2.Segment.Identity	openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(short mode)
ModifySecureObjectResult	removeOwningGroup(PrincipalGroup group, short mode)
ModifySecureObjectResult	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.
ModifySecureObjectResult	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
UpdateIndexResult	updateIndex()

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

openmdxjdoGetSlices

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

addToProvider, addToProvider, getDescription, getProvider, getView, 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

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

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

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

getView, getView

Field Detail

CLASS

public static final List<String> CLASS

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

Constructor Detail

Segment

public Segment()

Method Detail

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.

exportXml

public ExportResult exportXml(String attributeFilter,
                              String referenceFilter)

Specified by:

exportXml in interface XmlExporter

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.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(short mode)

Specified by:

removeAllOwningGroup in interface SecureObject

setOwningUser

public ModifySecureObjectResult setOwningUser(short mode,
                                              User user)

Specified by:

setOwningUser in interface SecureObject

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.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(PrincipalGroup group,
                                               short mode)

Specified by:

addOwningGroup in interface SecureObject

getElement

public <T extends Element> Collection<T> getElement()

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

Returns:

A set containing all the elements for this reference.

getElement

public Element getElement(boolean idIsPersistent,
                          String id)

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

Parameters:

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

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

Returns:

The possibly null value for this qualifier

addElement

public void addElement(boolean idIsPersistent,
                       String id,
                       Element element)

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

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

Parameters:

idIsPersistent - true if id is persistent

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

element - The element to be appended.

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.

getAudit

public AuditEntry getAudit(boolean idIsPersistent,
                           String id)

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

Specified by:

getAudit in interface Auditee

Parameters:

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

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

Returns:

The possibly null value for this qualifier

checkPermissions

public CheckPermissionsResult checkPermissions(String principalName)

Specified by:

checkPermissions in interface SecureObject

importItem

public ImportResult importItem(byte[] item,
                               String itemMimeType,
                               String itemName,
                               short locale)

Specified by:

importItem in interface Importer

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)

Specified by:

removeOwningGroup in interface SecureObject

updateIndex

public UpdateIndexResult updateIndex()

Specified by:

updateIndex in interface Indexed

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.

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 ModifySecureObjectResult setAccessLevel(short accessLevelBrowse,
                                               short accessLevelDelete,
                                               short accessLevelUpdate,
                                               short mode)

Specified by:

setAccessLevel in interface SecureObject

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

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.

getIndexEntry

public IndexEntry getIndexEntry(boolean idIsPersistent,
                                String id)

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

Specified by:

getIndexEntry in interface Indexed

Parameters:

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

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

Returns:

The possibly null value for this qualifier

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.

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)

openmdxjdoToIdentity

public static org.openmdx.base.jdo2.Segment.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)