org.opencrx.kernel.depot1.cci
Interface Segment

All Superinterfaces:

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

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

Method Summary

void	addDepotType(DepotType newValue)
void	addDepotType(String id, DepotType newValue)
void	addEntity(DepotEntity newValue)
void	addEntity(String id, DepotEntity newValue)
void	addEntityRelationship(DepotEntityRelationship newValue)
void	addEntityRelationship(String id, DepotEntityRelationship newValue)
Collection	getBooking() Retrieves a collection containing all the elements for the reference booking.
List	getBooking(BookingFilter filter) Retrieves the value for the reference booking for the specified filter.
List	getBooking(BookingQuery query) Retrieves the value for the reference booking for the specified query.
Booking	getBooking(String id) Retrieves the value for the reference booking for the specified qualifier attribute value.
Collection	getCb() Retrieves a collection containing all the elements for the reference cb.
List	getCb(CompoundBookingFilter filter) Retrieves the value for the reference cb for the specified filter.
List	getCb(CompoundBookingQuery query) Retrieves the value for the reference cb for the specified query.
CompoundBooking	getCb(String id) Retrieves the value for the reference cb for the specified qualifier attribute value.
Collection	getDepotType() Retrieves a collection containing all the elements for the reference depotType.
List	getDepotType(DepotTypeFilter filter) Retrieves the value for the reference depotType for the specified filter.
List	getDepotType(DepotTypeQuery query) Retrieves the value for the reference depotType for the specified query.
DepotType	getDepotType(String id) Retrieves the value for the reference depotType for the specified qualifier attribute value.
Collection	getEntity() Retrieves a collection containing all the elements for the reference entity.
List	getEntity(DepotEntityFilter filter) Retrieves the value for the reference entity for the specified filter.
List	getEntity(DepotEntityQuery query) Retrieves the value for the reference entity for the specified query.
DepotEntity	getEntity(String id) Retrieves the value for the reference entity for the specified qualifier attribute value.
Collection	getEntityRelationship() Retrieves a collection containing all the elements for the reference entityRelationship.
List	getEntityRelationship(DepotEntityRelationshipFilter filter) Retrieves the value for the reference entityRelationship for the specified filter.
List	getEntityRelationship(DepotEntityRelationshipQuery query) Retrieves the value for the reference entityRelationship for the specified query.
DepotEntityRelationship	getEntityRelationship(String id) Retrieves the value for the reference entityRelationship for the specified qualifier attribute value.
void	removeDepotType(String id)
void	removeEntity(String id)
void	removeEntityRelationship(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.XmlExporter

exportXml, exportXml

Method Detail

getBooking

Booking getBooking(String id)

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

getBooking

Collection getBooking()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getBooking

List getBooking(BookingFilter filter)

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

getBooking

List getBooking(BookingQuery query)

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

getCb

CompoundBooking getCb(String id)

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

getCb

Collection getCb()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getCb

List getCb(CompoundBookingFilter filter)

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

getCb

List getCb(CompoundBookingQuery query)

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

getDepotType

DepotType getDepotType(String id)

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

getDepotType

Collection getDepotType()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getDepotType

List getDepotType(DepotTypeFilter filter)

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

getDepotType

List getDepotType(DepotTypeQuery query)

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

addDepotType

void addDepotType(String id,
                  DepotType 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.

addDepotType

void addDepotType(DepotType newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeDepotType

void removeDepotType(String id)

Throws:

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

getEntity

DepotEntity getEntity(String id)

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

getEntity

Collection getEntity()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getEntity

List getEntity(DepotEntityFilter filter)

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

getEntity

List getEntity(DepotEntityQuery query)

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

addEntity

void addEntity(String id,
               DepotEntity 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.

addEntity

void addEntity(DepotEntity newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeEntity

void removeEntity(String id)

Throws:

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

getEntityRelationship

DepotEntityRelationship getEntityRelationship(String id)

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

getEntityRelationship

Collection getEntityRelationship()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getEntityRelationship

List getEntityRelationship(DepotEntityRelationshipFilter filter)

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

getEntityRelationship

List getEntityRelationship(DepotEntityRelationshipQuery query)

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

addEntityRelationship

void addEntityRelationship(String id,
                           DepotEntityRelationship 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.

addEntityRelationship

void addEntityRelationship(DepotEntityRelationship newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeEntityRelationship

void removeEntityRelationship(String id)

Throws:

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