org.opencrx.kernel.building1.jpa3
Class Segment

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

All Implemented Interfaces:

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

public class Segment
extends Segment
implements Segment

Class Segment

See Also:

Serialized Form

Nested Class Summary

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

org.w3c.jpa3.AbstractObject.EmbeddedList<E>, org.w3c.jpa3.AbstractObject.EmbeddedSet<E>, org.w3c.jpa3.AbstractObject.Slice

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

Segment.Identity

Field Summary

static List<String>

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

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

BASE_CLASS, 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)
ExecuteWorkflowResult	executeWorkflow(ExecuteWorkflowParams in)
ExportItemResult	exportItem(ExportItemParams in)
ExportItemResult	exportItemAdvanced(ExportItemAdvancedParams in)
String	getAccessGrantedByParent_Id()
ContextCapable	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> AuditeeHasAuditEntries.Audit<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
<T extends Building> SegmentContainsBuilding.Building<T>	getBuilding() Retrieves a set containing all the elements for the reference building.
<T extends BuildingComplex> SegmentContainsBuildingComplex.BuildingComplex<T>	getBuildingComplex() Retrieves a set containing all the elements for the reference buildingComplex.
<T extends AbstractBuildingUnit> SegmentContainsBuildingUnit.BuildingUnit<T>	getBuildingUnit() Retrieves a set containing all the elements for the reference buildingUnit.
<T extends Facility> SegmentContainsFacility.Facility<T>	getFacility() Retrieves a set containing all the elements for the reference facility.
<T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
<T extends InventoryItem> SegmentContainsInventoryItem.InventoryItem<T>	getInventoryItem() Retrieves a set containing all the elements for the reference inventoryItem.
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)
protected org.w3c.jpa3.AbstractObject.Slice	newSegment$Slice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected int	openmdxjdoGetSize(int field)
protected void	openmdxjdoSetSize(int field, int size)
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	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

getContext, getDescription, getExtent, getProvider_Id, getProvider, openmdxjdoGetObjectId, 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, setProvider_Id, setProvider

Methods inherited from class org.w3c.jpa3.AbstractObject

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

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet

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

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

getContext

Field Detail

CLASS

public static final List<String> CLASS

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

Constructor Detail

Segment

public Segment()

Constructor

Method Detail

getBuildingComplex

public <T extends BuildingComplex> SegmentContainsBuildingComplex.BuildingComplex<T> getBuildingComplex()

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

Returns:

A set containing all the elements for this reference.

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.

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.

getFacility

public <T extends Facility> SegmentContainsFacility.Facility<T> getFacility()

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

Returns:

A set containing all the elements for this reference.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

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.

getOwningGroup_Id

public List<String> getOwningGroup_Id()

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

exportItemAdvanced

public ExportItemResult exportItemAdvanced(ExportItemAdvancedParams in)

Specified by:

exportItemAdvanced in interface Exporter

getBuilding

public <T extends Building> SegmentContainsBuilding.Building<T> getBuilding()

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

Returns:

A set containing all the elements for this reference.

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

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.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

importItem

public ImportResult importItem(ImportParams in)

Specified by:

importItem in interface Importer

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.

getInventoryItem

public <T extends InventoryItem> SegmentContainsInventoryItem.InventoryItem<T> getInventoryItem()

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

Returns:

A set containing all the elements for this reference.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getAccessGrantedByParent

public ContextCapable getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

getAccessGrantedByParent_Id

public String getAccessGrantedByParent_Id()

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

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

getBuildingUnit

public <T extends AbstractBuildingUnit> SegmentContainsBuildingUnit.BuildingUnit<T> getBuildingUnit()

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

Returns:

A set containing all the elements for this reference.

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 non-null new value for this reference.

setOwningUser_Id

public void setOwningUser_Id(String owningUser)

executeWorkflow

public ExecuteWorkflowResult executeWorkflow(ExecuteWorkflowParams in)

Specified by:

executeWorkflow in interface WorkflowTarget

exportItem

public ExportItemResult exportItem(ExportItemParams in)

Specified by:

exportItem in interface Exporter

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class Segment

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class Segment

newSegment$Slice

protected org.w3c.jpa3.AbstractObject.Slice newSegment$Slice(int index)

Overrides:

newSegment$Slice 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