org.opencrx.kernel.forecast1.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	addBudget(Budget newValue)
void	addBudget(String id, Budget newValue)
void	addForecast(Forecast newValue)
void	addForecast(String ouName, Forecast newValue)
Collection	getBudget() Retrieves a collection containing all the elements for the reference budget.
List	getBudget(BudgetFilter filter) Retrieves the value for the reference budget for the specified filter.
List	getBudget(BudgetQuery query) Retrieves the value for the reference budget for the specified query.
Budget	getBudget(String id) Retrieves the value for the reference budget for the specified qualifier attribute value.
Collection	getForecast() Retrieves a collection containing all the elements for the reference forecast.
List	getForecast(ForecastFilter filter) Retrieves the value for the reference forecast for the specified filter.
List	getForecast(ForecastQuery query) Retrieves the value for the reference forecast for the specified query.
Forecast	getForecast(String ouName) Retrieves the value for the reference forecast for the specified qualifier attribute value.
void	removeBudget(String id)
void	removeForecast(String ouName)

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

getBudget

Budget getBudget(String id)

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

getBudget

Collection getBudget()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getBudget

List getBudget(BudgetFilter filter)

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

getBudget

List getBudget(BudgetQuery query)

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

addBudget

void addBudget(String id,
               Budget 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.

addBudget

void addBudget(Budget newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeBudget

void removeBudget(String id)

Throws:

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

getForecast

Forecast getForecast(String ouName)

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

Parameters:

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

getForecast

Collection getForecast()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getForecast

List getForecast(ForecastFilter filter)

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

getForecast

List getForecast(ForecastQuery query)

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

addForecast

void addForecast(String ouName,
                 Forecast newValue)

Parameters:

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

addForecast

void addForecast(Forecast newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeForecast

void removeForecast(String ouName)

Throws:

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