org.opencrx.kernel.forecast1.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	addBudget(boolean idIsPersistent, String id, Budget budget) Adds the specified element to the set of the values for the reference budget.
void	addForecast(boolean ouNameIsPersistent, String ouName, Forecast forecast) Adds the specified element to the set of the values for the reference forecast.
Budget	getBudget(boolean idIsPersistent, String id) Retrieves the value for the reference budget for the specified qualifier attribute value.
<T extends Budget> List<T>	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.
Forecast	getForecast(boolean ouNameIsPersistent, String ouName) Retrieves the value for the reference forecast for the specified qualifier attribute value.
<T extends Forecast> List<T>	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.

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

addBudget, addForecast, getBudget, getForecast

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

getBudget

<T extends Budget> List<T> getBudget(BudgetQuery query)

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

getBudget

Budget getBudget(boolean idIsPersistent,
                 String id)

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

getBudget

Budget getBudget(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addBudget

void addBudget(boolean idIsPersistent,
               String id,
               Budget budget)

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

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.

budget - The element to be appended.

getForecast

<T extends Forecast> List<T> getForecast(ForecastQuery query)

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

getForecast

Forecast getForecast(boolean ouNameIsPersistent,
                     String ouName)

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

Parameters:

ouNameIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getForecast

Forecast getForecast(String ouName)

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

This method is equivalent to the preferred invocation getForecast(false,ouName).

Parameters:

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

Returns:

The possibly null value for this qualifier

addForecast

void addForecast(boolean ouNameIsPersistent,
                 String ouName,
                 Forecast forecast)

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

Note: This is an extension to the JMI 1 standard.

Parameters:

ouNameIsPersistent - true if ouName is persistent

ouName - The qualifier attribute value that qualifies the reference to get the element to be appended.

forecast - The element to be appended.