org.opencrx.kernel.account1.jmi1
Interface Segment

All Superinterfaces:

Auditee, ContextCapable, Exporter, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, Segment

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

Class Segment

isFrozenisFrozen

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

Segment.Identity

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

Segment.Identity

Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment

Segment.Identity

Method Summary

void	addAccount(boolean idIsPersistent, String id, Account account) Adds the specified element to the set of the values for the reference account.
void	addAccount(String id, Account account) Adds the specified element to the set of the values for the reference account using a reassignable qualifier.
void	addAccountFilter(boolean idIsPersistent, String id, AccountFilterGlobal accountFilter) Adds the specified element to the set of the values for the reference accountFilter.
void	addAccountFilter(String id, AccountFilterGlobal accountFilter) Adds the specified element to the set of the values for the reference accountFilter using a reassignable qualifier.
void	addAddressFilter(boolean idIsPersistent, String id, AddressFilterGlobal addressFilter) Adds the specified element to the set of the values for the reference addressFilter.
void	addAddressFilter(String id, AddressFilterGlobal addressFilter) Adds the specified element to the set of the values for the reference addressFilter using a reassignable qualifier.
void	addCompetitor(boolean idIsPersistent, String id, Competitor competitor) Adds the specified element to the set of the values for the reference competitor.
void	addCompetitor(String id, Competitor competitor) Adds the specified element to the set of the values for the reference competitor using a reassignable qualifier.
void	addOrganization(boolean idIsPersistent, String id, Organization organization) Adds the specified element to the set of the values for the reference organization.
void	addOrganization(String id, Organization organization) Adds the specified element to the set of the values for the reference organization using a reassignable qualifier.
void	addSearchIndexEntry(boolean idIsPersistent, String id, SearchIndexEntry searchIndexEntry) Adds the specified element to the set of the values for the reference searchIndexEntry.
void	addSearchIndexEntry(String id, SearchIndexEntry searchIndexEntry) Adds the specified element to the set of the values for the reference searchIndexEntry using a reassignable qualifier.
<T extends Account> List<T>	getAccount(AccountQuery query) Retrieves the value for the reference account for the specified query.
Account	getAccount(boolean idIsPersistent, String id) Retrieves the value for the reference account for the specified qualifier attribute value.
Account	getAccount(String id) Retrieves the value for the reference account for the specified qualifier attribute value.
<T extends AccountFilterGlobal> List<T>	getAccountFilter(AccountFilterGlobalQuery query) Retrieves the value for the reference accountFilter for the specified query.
AccountFilterGlobal	getAccountFilter(boolean idIsPersistent, String id) Retrieves the value for the reference accountFilter for the specified qualifier attribute value.
AccountFilterGlobal	getAccountFilter(String id) Retrieves the value for the reference accountFilter for the specified qualifier attribute value.
<T extends AccountAddress> List<T>	getAddress(AccountAddressQuery query) Retrieves the value for the reference address for the specified query.
AccountAddress	getAddress(boolean idIsPersistent, String id) Retrieves the value for the reference address for the specified qualifier attribute value.
AccountAddress	getAddress(String id) Retrieves the value for the reference address for the specified qualifier attribute value.
<T extends AddressFilterGlobal> List<T>	getAddressFilter(AddressFilterGlobalQuery query) Retrieves the value for the reference addressFilter for the specified query.
AddressFilterGlobal	getAddressFilter(boolean idIsPersistent, String id) Retrieves the value for the reference addressFilter for the specified qualifier attribute value.
AddressFilterGlobal	getAddressFilter(String id) Retrieves the value for the reference addressFilter for the specified qualifier attribute value.
Competitor	getCompetitor(boolean idIsPersistent, String id) Retrieves the value for the reference competitor for the specified qualifier attribute value.
<T extends Competitor> List<T>	getCompetitor(CompetitorQuery query) Retrieves the value for the reference competitor for the specified query.
Competitor	getCompetitor(String id) Retrieves the value for the reference competitor for the specified qualifier attribute value.
Organization	getOrganization(boolean idIsPersistent, String id) Retrieves the value for the reference organization for the specified qualifier attribute value.
<T extends Organization> List<T>	getOrganization(OrganizationQuery query) Retrieves the value for the reference organization for the specified query.
Organization	getOrganization(String id) Retrieves the value for the reference organization for the specified qualifier attribute value.
SearchIndexEntry	getSearchIndexEntry(boolean idIsPersistent, String id) Retrieves the value for the reference searchIndexEntry for the specified qualifier attribute value.
<T extends SearchIndexEntry> List<T>	getSearchIndexEntry(SearchIndexEntryQuery query) Retrieves the value for the reference searchIndexEntry for the specified query.
SearchIndexEntry	getSearchIndexEntry(String id) Retrieves the value for the reference searchIndexEntry for the specified qualifier attribute value.

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

getAccount, getAccountFilter, getAddress, getAddressFilter, getCompetitor, getOrganization, getSearchIndexEntry

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

getDescription, getExtent, setDescription

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

getContext

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

getAudit

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

exportItem, exportItemAdvanced

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

importItem

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

getIndexEntry

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser

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

getDescription, getExtent, setDescription

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

getContext

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

getExtent, getExtent, getExtent, getProvider

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

getDescription, getExtent, setDescription

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

getContext

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

getContext

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refDefaultFetchGroup, refDelegate, refGetEventListeners, refGetPath, refGetValue, refInitialize, refInitialize, refRemoveEventListener, refSetValue

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

exportItem, exportItemAdvanced

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

exportItem, exportItemAdvanced

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

importItem

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

importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

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

getIndexEntry

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

addOwningGroup, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwningUser, setOwningUser

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser

Method Detail

getAccount

<T extends Account> List<T> getAccount(AccountQuery query)

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

getAccount

Account getAccount(boolean idIsPersistent,
                   String id)

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

getAccount

Account getAccount(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addAccount

void addAccount(boolean idIsPersistent,
                String id,
                Account account)

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

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.

account - The element to be appended.

addAccount

void addAccount(String id,
                Account account)

Adds the specified element to the set of the values for the reference account using a reassignable qualifier.

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

Parameters:

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

account - The element to be appended.

getAccountFilter

<T extends AccountFilterGlobal> List<T> getAccountFilter(AccountFilterGlobalQuery query)

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

getAccountFilter

AccountFilterGlobal getAccountFilter(boolean idIsPersistent,
                                     String id)

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

getAccountFilter

AccountFilterGlobal getAccountFilter(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addAccountFilter

void addAccountFilter(boolean idIsPersistent,
                      String id,
                      AccountFilterGlobal accountFilter)

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

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.

accountFilter - The element to be appended.

addAccountFilter

void addAccountFilter(String id,
                      AccountFilterGlobal accountFilter)

Adds the specified element to the set of the values for the reference accountFilter using a reassignable qualifier.

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

Parameters:

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

accountFilter - The element to be appended.

getAddress

<T extends AccountAddress> List<T> getAddress(AccountAddressQuery query)

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

getAddress

AccountAddress getAddress(boolean idIsPersistent,
                          String id)

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

getAddress

AccountAddress getAddress(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

getAddressFilter

<T extends AddressFilterGlobal> List<T> getAddressFilter(AddressFilterGlobalQuery query)

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

getAddressFilter

AddressFilterGlobal getAddressFilter(boolean idIsPersistent,
                                     String id)

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

getAddressFilter

AddressFilterGlobal getAddressFilter(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addAddressFilter

void addAddressFilter(boolean idIsPersistent,
                      String id,
                      AddressFilterGlobal addressFilter)

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

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.

addressFilter - The element to be appended.

addAddressFilter

void addAddressFilter(String id,
                      AddressFilterGlobal addressFilter)

Adds the specified element to the set of the values for the reference addressFilter using a reassignable qualifier.

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

Parameters:

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

addressFilter - The element to be appended.

getCompetitor

<T extends Competitor> List<T> getCompetitor(CompetitorQuery query)

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

getCompetitor

Competitor getCompetitor(boolean idIsPersistent,
                         String id)

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

getCompetitor

Competitor getCompetitor(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addCompetitor

void addCompetitor(boolean idIsPersistent,
                   String id,
                   Competitor competitor)

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

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.

competitor - The element to be appended.

addCompetitor

void addCompetitor(String id,
                   Competitor competitor)

Adds the specified element to the set of the values for the reference competitor using a reassignable qualifier.

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

Parameters:

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

competitor - The element to be appended.

getOrganization

<T extends Organization> List<T> getOrganization(OrganizationQuery query)

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

getOrganization

Organization getOrganization(boolean idIsPersistent,
                             String id)

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

getOrganization

Organization getOrganization(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addOrganization

void addOrganization(boolean idIsPersistent,
                     String id,
                     Organization organization)

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

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.

organization - The element to be appended.

addOrganization

void addOrganization(String id,
                     Organization organization)

Adds the specified element to the set of the values for the reference organization using a reassignable qualifier.

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

Parameters:

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

organization - The element to be appended.

getSearchIndexEntry

<T extends SearchIndexEntry> List<T> getSearchIndexEntry(SearchIndexEntryQuery query)

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

getSearchIndexEntry

SearchIndexEntry getSearchIndexEntry(boolean idIsPersistent,
                                     String id)

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

getSearchIndexEntry

SearchIndexEntry getSearchIndexEntry(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addSearchIndexEntry

void addSearchIndexEntry(boolean idIsPersistent,
                         String id,
                         SearchIndexEntry searchIndexEntry)

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

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.

searchIndexEntry - The element to be appended.

addSearchIndexEntry

void addSearchIndexEntry(String id,
                         SearchIndexEntry searchIndexEntry)

Adds the specified element to the set of the values for the reference searchIndexEntry using a reassignable qualifier.

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

Parameters:

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

searchIndexEntry - The element to be appended.