org.opencrx.kernel.building1.jmi1
Interface Segment

All Superinterfaces:

Auditee, org.openmdx.base.cci2.ContextCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, 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(boolean idIsPersistent, String id, Building building) Adds the specified element to the set of the values for the reference building.
void	addBuildingComplex(boolean idIsPersistent, String id, BuildingComplex buildingComplex) Adds the specified element to the set of the values for the reference buildingComplex.
void	addInventoryItem(boolean idIsPersistent, String id, InventoryItem inventoryItem) Adds the specified element to the set of the values for the reference inventoryItem.
Building	getBuilding(boolean idIsPersistent, String id) Retrieves the value for the reference building for the specified qualifier attribute value.
<T extends Building> List<T>	getBuilding(BuildingQuery query) Retrieves the value for the reference building for the specified query.
Building	getBuilding(String id) Retrieves the value for the reference building for the specified qualifier attribute value.
BuildingComplex	getBuildingComplex(boolean idIsPersistent, String id) Retrieves the value for the reference buildingComplex for the specified qualifier attribute value.
<T extends BuildingComplex> List<T>	getBuildingComplex(BuildingComplexQuery query) Retrieves the value for the reference buildingComplex for the specified query.
BuildingComplex	getBuildingComplex(String id) Retrieves the value for the reference buildingComplex for the specified qualifier attribute value.
<T extends AbstractBuildingUnit> List<T>	getBuildingUnit(AbstractBuildingUnitQuery query) Retrieves the value for the reference buildingUnit for the specified query.
AbstractBuildingUnit	getBuildingUnit(boolean idIsPersistent, String id) Retrieves the value for the reference buildingUnit for the specified qualifier attribute value.
AbstractBuildingUnit	getBuildingUnit(String id) Retrieves the value for the reference buildingUnit for the specified qualifier attribute value.
Facility	getFacility(boolean idIsPersistent, String id) Retrieves the value for the reference facility for the specified qualifier attribute value.
<T extends Facility> List<T>	getFacility(FacilityQuery query) Retrieves the value for the reference facility for the specified query.
Facility	getFacility(String id) Retrieves the value for the reference facility for the specified qualifier attribute value.
InventoryItem	getInventoryItem(boolean idIsPersistent, String id) Retrieves the value for the reference inventoryItem for the specified qualifier attribute value.
<T extends InventoryItem> List<T>	getInventoryItem(InventoryItemQuery query) Retrieves the value for the reference inventoryItem for the specified query.
InventoryItem	getInventoryItem(String id) Retrieves the value for the reference inventoryItem for the specified qualifier attribute value.

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

addBuilding, addBuildingComplex, addInventoryItem, getBuilding, getBuildingComplex, getBuildingUnit, getFacility, getInventoryItem

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

getExtent, getExtent, getExtent, getProvider

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

getDescription, setDescription

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

getView, getView, getView

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

getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

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

getAudit, getAudit, getAudit

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

getAudit

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

getIndexEntry

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

addOwningGroup, addOwningGroup, checkPermissions, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevel, setOwningUser, setOwningUser, setOwningUser

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

getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate

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

executeWorkflow, executeWorkflow

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

exportXml, exportXml

Method Detail

getBuilding

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

Retrieves the value for the reference building for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getBuilding

Building getBuilding(boolean idIsPersistent,
                     String id)

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

getBuilding

Building getBuilding(String id)

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

This method is equivalent to the preferred invocation getBuilding(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBuilding

void addBuilding(boolean idIsPersistent,
                 String id,
                 Building building)

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

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.

building - The element to be appended.

getBuildingComplex

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

Retrieves the value for the reference buildingComplex for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getBuildingComplex

BuildingComplex getBuildingComplex(boolean idIsPersistent,
                                   String id)

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

getBuildingComplex

BuildingComplex getBuildingComplex(String id)

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

This method is equivalent to the preferred invocation getBuildingComplex(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addBuildingComplex

void addBuildingComplex(boolean idIsPersistent,
                        String id,
                        BuildingComplex buildingComplex)

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

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.

buildingComplex - The element to be appended.

getBuildingUnit

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

Retrieves the value for the reference buildingUnit for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getBuildingUnit

AbstractBuildingUnit getBuildingUnit(boolean idIsPersistent,
                                     String id)

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

getBuildingUnit

AbstractBuildingUnit getBuildingUnit(String id)

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

This method is equivalent to the preferred invocation getBuildingUnit(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getFacility

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

Retrieves the value for the reference facility for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getFacility

Facility getFacility(boolean idIsPersistent,
                     String id)

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

getFacility

Facility getFacility(String id)

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

This method is equivalent to the preferred invocation getFacility(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

getInventoryItem

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

Retrieves the value for the reference inventoryItem for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getInventoryItem

InventoryItem getInventoryItem(boolean idIsPersistent,
                               String id)

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

getInventoryItem

InventoryItem getInventoryItem(String id)

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

This method is equivalent to the preferred invocation getInventoryItem(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addInventoryItem

void addInventoryItem(boolean idIsPersistent,
                      String id,
                      InventoryItem inventoryItem)

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

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.

inventoryItem - The element to be appended.