org.opencrx.kernel.building1.jmi1
Interface Segment

All Superinterfaces:

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

public interface Segment
extends Segment, Segment, Auditee, Importer, Indexed, SecureObject, WorkflowTarget, XmlExporter

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	addBuilding(Building newValue)
void	addBuilding(String id, Building newValue)
void	addBuildingComplex(BuildingComplex newValue)
void	addBuildingComplex(String id, BuildingComplex newValue)
void	addInventoryItem(InventoryItem newValue)
void	addInventoryItem(String id, InventoryItem newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
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 Building> List<T>	getBuilding(BuildingQuery query) Retrieves the value for the reference building for the specified query.
<T extends BuildingComplex> List<T>	getBuildingComplex(BuildingComplexQuery query) Retrieves the value for the reference buildingComplex for the specified query.
<T extends AbstractBuildingUnit> List<T>	getBuildingUnit(AbstractBuildingUnitQuery query) Retrieves the value for the reference buildingUnit 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 Facility> List<T>	getFacility(FacilityQuery query) Retrieves the value for the reference facility for the specified query.
<T extends IndexEntry> List<T>	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
<T extends InventoryItem> List<T>	getInventoryItem(InventoryItemQuery query) Retrieves the value for the reference inventoryItem 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 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.
void	removeBuilding(String id)
void	removeBuildingComplex(String id)
void	removeInventoryItem(String id)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.

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

getBuilding, getBuildingComplex, getBuildingUnit, getFacility, getInventoryItem

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

importItem

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

importItem

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

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

executeWorkflow

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

executeWorkflow

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

exportXml

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

exportXml

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.

getBuilding

<T extends Building> List<T> getBuilding(BuildingQuery query)

Retrieves the value for the reference building 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.

addBuilding

void addBuilding(String id,
                 Building newValue)

Parameters:

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

newValue - The element to be appended.

addBuilding

void addBuilding(Building newValue)

Parameters:

newValue - The element to be appended.

removeBuilding

void removeBuilding(String id)

getBuildingComplex

<T extends BuildingComplex> List<T> getBuildingComplex(BuildingComplexQuery query)

Retrieves the value for the reference buildingComplex 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.

addBuildingComplex

void addBuildingComplex(String id,
                        BuildingComplex newValue)

Parameters:

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

newValue - The element to be appended.

addBuildingComplex

void addBuildingComplex(BuildingComplex newValue)

Parameters:

newValue - The element to be appended.

removeBuildingComplex

void removeBuildingComplex(String id)

getBuildingUnit

<T extends AbstractBuildingUnit> List<T> getBuildingUnit(AbstractBuildingUnitQuery query)

Retrieves the value for the reference buildingUnit 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.

getFacility

<T extends Facility> List<T> getFacility(FacilityQuery query)

Retrieves the value for the reference facility 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.

getInventoryItem

<T extends InventoryItem> List<T> getInventoryItem(InventoryItemQuery query)

Retrieves the value for the reference inventoryItem 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.

addInventoryItem

void addInventoryItem(String id,
                      InventoryItem newValue)

Parameters:

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

newValue - The element to be appended.

addInventoryItem

void addInventoryItem(InventoryItem newValue)

Parameters:

newValue - The element to be appended.

removeInventoryItem

void removeInventoryItem(String id)

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.