org.opencrx.kernel.building1.cci
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment, ViewCapable, WorkflowTarget, XmlExporter

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

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)
Collection	getBuilding() Retrieves a collection containing all the elements for the reference building.
List	getBuilding(BuildingFilter filter) Retrieves the value for the reference building for the specified filter.
List	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.
Collection	getBuildingComplex() Retrieves a collection containing all the elements for the reference buildingComplex.
List	getBuildingComplex(BuildingComplexFilter filter) Retrieves the value for the reference buildingComplex for the specified filter.
List	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.
Collection	getBuildingUnit() Retrieves a collection containing all the elements for the reference buildingUnit.
List	getBuildingUnit(AbstractBuildingUnitFilter filter) Retrieves the value for the reference buildingUnit for the specified filter.
List	getBuildingUnit(AbstractBuildingUnitQuery query) Retrieves the value for the reference buildingUnit for the specified query.
AbstractBuildingUnit	getBuildingUnit(String id) Retrieves the value for the reference buildingUnit for the specified qualifier attribute value.
Collection	getFacility() Retrieves a collection containing all the elements for the reference facility.
List	getFacility(FacilityFilter filter) Retrieves the value for the reference facility for the specified filter.
List	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.
Collection	getInventoryItem() Retrieves a collection containing all the elements for the reference inventoryItem.
List	getInventoryItem(InventoryItemFilter filter) Retrieves the value for the reference inventoryItem for the specified filter.
List	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.
void	removeBuilding(String id)
void	removeBuildingComplex(String id)
void	removeInventoryItem(String id)

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

getDescription, getExtent, getExtent, getExtent, getExtent, getProvider, setDescription

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

getContext, getContext

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

getView, getView, getView, 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.cci.Auditee

getAudit, getAudit, getAudit, getAudit

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

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

executeWorkflow, executeWorkflow

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

exportXml, exportXml

Method Detail

getBuilding

Building getBuilding(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuilding

Collection getBuilding()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getBuilding

List getBuilding(BuildingFilter filter)

Retrieves the value for the reference building for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuilding

List getBuilding(BuildingQuery query)

Retrieves the value for the reference building for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addBuilding

void addBuilding(Building newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeBuilding

void removeBuilding(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getBuildingComplex

BuildingComplex getBuildingComplex(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuildingComplex

Collection getBuildingComplex()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getBuildingComplex

List getBuildingComplex(BuildingComplexFilter filter)

Retrieves the value for the reference buildingComplex for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuildingComplex

List getBuildingComplex(BuildingComplexQuery query)

Retrieves the value for the reference buildingComplex for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addBuildingComplex

void addBuildingComplex(BuildingComplex newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeBuildingComplex

void removeBuildingComplex(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getBuildingUnit

AbstractBuildingUnit getBuildingUnit(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuildingUnit

Collection getBuildingUnit()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getBuildingUnit

List getBuildingUnit(AbstractBuildingUnitFilter filter)

Retrieves the value for the reference buildingUnit for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getBuildingUnit

List getBuildingUnit(AbstractBuildingUnitQuery query)

Retrieves the value for the reference buildingUnit for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFacility

Facility getFacility(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFacility

Collection getFacility()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getFacility

List getFacility(FacilityFilter filter)

Retrieves the value for the reference facility for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getFacility

List getFacility(FacilityQuery query)

Retrieves the value for the reference facility for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getInventoryItem

InventoryItem getInventoryItem(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getInventoryItem

Collection getInventoryItem()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getInventoryItem

List getInventoryItem(InventoryItemFilter filter)

Retrieves the value for the reference inventoryItem for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getInventoryItem

List getInventoryItem(InventoryItemQuery query)

Retrieves the value for the reference inventoryItem for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

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.

Throws:

JmiException - If the value cannot be appended for some reason.

addInventoryItem

void addInventoryItem(InventoryItem newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeInventoryItem

void removeInventoryItem(String id)

Throws:

JmiException - If the value cannot be removed for some reason.