org.opencrx.kernel.building1.cci2
Interface Segment

All Superinterfaces:

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

All Known Subinterfaces:

Segment

public interface Segment
extends 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.
<T extends Building> Collection<T>	getBuilding() Retrieves a set containing all the elements for the reference building.
Building	getBuilding(boolean idIsPersistent, String id) Retrieves the value for the reference building for the specified qualifier attribute value.
<T extends BuildingComplex> Collection<T>	getBuildingComplex() Retrieves a set containing all the elements for the reference buildingComplex.
BuildingComplex	getBuildingComplex(boolean idIsPersistent, String id) Retrieves the value for the reference buildingComplex for the specified qualifier attribute value.
<T extends AbstractBuildingUnit> Collection<T>	getBuildingUnit() Retrieves a set containing all the elements for the reference buildingUnit.
AbstractBuildingUnit	getBuildingUnit(boolean idIsPersistent, String id) Retrieves the value for the reference buildingUnit for the specified qualifier attribute value.
<T extends Facility> Collection<T>	getFacility() Retrieves a set containing all the elements for the reference facility.
Facility	getFacility(boolean idIsPersistent, String id) Retrieves the value for the reference facility for the specified qualifier attribute value.
<T extends InventoryItem> Collection<T>	getInventoryItem() Retrieves a set containing all the elements for the reference inventoryItem.
InventoryItem	getInventoryItem(boolean idIsPersistent, String id) Retrieves the value for the reference inventoryItem for the specified qualifier attribute value.

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

getDescription, getProvider, setDescription

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

getView, getView

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

getAudit, getAudit

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

importItem

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

getIndexEntry, getIndexEntry, updateIndex

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

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

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

executeWorkflow

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

exportXml

Method Detail

getBuilding

<T extends Building> Collection<T> getBuilding()

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

Returns:

A set containing all the elements for this reference.

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

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> Collection<T> getBuildingComplex()

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

Returns:

A set containing all the elements for this reference.

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

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> Collection<T> getBuildingUnit()

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

Returns:

A set containing all the elements for this reference.

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

getFacility

<T extends Facility> Collection<T> getFacility()

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

Returns:

A set containing all the elements for this reference.

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

getInventoryItem

<T extends InventoryItem> Collection<T> getInventoryItem()

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

Returns:

A set containing all the elements for this reference.

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

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.