org.opencrx.kernel.model1.jpa3
Class Segment

java.lang.Object
  org.w3c.jpa3.AbstractObject
      org.openmdx.base.jpa3.Segment
          org.opencrx.kernel.jpa3.Segment
              org.opencrx.kernel.model1.jpa3.Segment

All Implemented Interfaces:

Serializable, org.apache.openjpa.enhance.PersistenceCapable, Auditee, Exporter, Importer, Indexed, SecureObject, ContextCapable, Segment

public class Segment
extends Segment
implements Segment

Class Segment

Each segment contains exactly one model package.

See Also:

Serialized Form

Nested Class Summary

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

AbstractObject.AbstractStateAccessor, AbstractObject.EmbeddedList<E>, AbstractObject.EmbeddedSet<E>, AbstractObject.ObjectState, AbstractObject.SlicedList<E,S>, AbstractObject.SlicedMap<E,S>, AbstractObject.SlicedSet<E,S>

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

Segment.Identity

Field Summary

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

pcStateManager

Fields inherited from interface org.apache.openjpa.enhance.PersistenceCapable

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

Constructor Summary

Segment()
Constructor

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ExportItemResult	exportItem(ExportItemParams in)
ExportItemResult	exportItemAdvanced(ExportItemAdvancedParams in)
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> AuditeeHasAuditEntries.Audit<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
<T extends Element> SegmentContainsElement.Element<T>	getElement() Retrieves a set containing all the elements for the reference element.
<T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
List<String>	getOwningGroup_Id()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
String	getOwningUser_Id()
User	getOwningUser() Retrieves the value for the reference owningUser.
ImportResult	importItem(ImportParams in)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
ModifySecureObjectResult	replaceOwningGroup(ModifyOwningGroupsParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
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.
void	setOwner(String... owner) Clears owner and adds the given value(s).
void	setOwningUser_Id(String owningUser)
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
UpdateIndexResult	updateIndex()

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

openmdxjdoGetSlices

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

getDescription, getExtent, getOpenmdxjdoIdentity, getProvider_Id, getProvider, pcClearFields, pcCopyField, pcCopyFields, pcCopyKeyFieldsFromObjectId, pcCopyKeyFieldsFromObjectId, pcCopyKeyFieldsToObjectId, pcCopyKeyFieldsToObjectId, pcDirty, pcFetchObjectId, pcGetDetachedState, pcGetEnhancementContractVersion, pcGetGenericContext, pcGetManagedFieldCount, pcGetStateManager, pcGetVersion, pcIsDeleted, pcIsDetached, pcIsDirty, pcIsNew, pcIsPersistent, pcIsTransactional, pcNewInstance, pcNewInstance, pcNewObjectIdInstance, pcNewObjectIdInstance, pcProvideField, pcProvideFields, pcReplaceField, pcReplaceFields, pcReplaceStateManager, pcSerializing, pcSetDetachedState, setDescription, setOpenmdxjdoIdentity, setProvider_Id, setProvider

Methods inherited from class org.w3c.jpa3.AbstractObject

openmdxjdoMakeDirty, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray

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, getExtent, getProvider, setDescription

Constructor Detail

Segment

public Segment()

Constructor

Method Detail

exportItemAdvanced

public ExportItemResult exportItemAdvanced(ExportItemAdvancedParams in)

Specified by:

exportItemAdvanced in interface Exporter

getElement

public <T extends Element> SegmentContainsElement.Element<T> getElement()

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

Returns:

A set containing all the elements for this reference.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

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.

getAudit

public <T extends AuditEntry> AuditeeHasAuditEntries.Audit<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.

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

importItem

public ImportResult importItem(ImportParams in)

Specified by:

importItem in interface Importer

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

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

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getOwner

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

setOwner

public void setOwner(String... owner)

Clears owner and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Specified by:

setOwner in interface SecureObject

Parameters:

owner - value(s) to be added to owner

getIndexEntry

public <T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<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 ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

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.

getOwningUser_Id

public String getOwningUser_Id()

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

owningUser - The new – possibly null – value for this reference.

setOwningUser_Id

public void setOwningUser_Id(String owningUser)

exportItem

public ExportItemResult exportItem(ExportItemParams in)

Specified by:

exportItem in interface Exporter

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.

getOwningGroup_Id

public List<String> getOwningGroup_Id()