org.opencrx.kernel.account1.cci
Class SegmentImpl

java.lang.Object
  org.openmdx.base.accessor.jmi.spi.RefObject_1
      org.opencrx.kernel.account1.cci.SegmentImpl

All Implemented Interfaces:

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

public class SegmentImpl
extends RefObject_1
implements Segment

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.jdo.spi.PersistenceCapable

PersistenceCapable.ObjectIdFieldConsumer, PersistenceCapable.ObjectIdFieldManager, PersistenceCapable.ObjectIdFieldSupplier

Field Summary

Fields inherited from interface javax.jdo.spi.PersistenceCapable

CHECK_READ, CHECK_WRITE, LOAD_REQUIRED, MEDIATE_READ, MEDIATE_WRITE, READ_OK, READ_WRITE_OK, SERIALIZABLE

Constructor Summary

SegmentImpl(Object_1_0 object, RefClass refClass)

Method Summary

void	addAccount(Account newValue)
void	addAccount(String id, Account newValue)
void	addAccountFilter(AccountFilterGlobal newValue)
void	addAccountFilter(String id, AccountFilterGlobal newValue)
protected void	addAddress(AccountAddress newValue)
protected void	addAddress(String id, AccountAddress newValue)
void	addAddressFilter(AddressFilterGlobal newValue)
void	addAddressFilter(String id, AddressFilterGlobal newValue)
protected void	addAudit(AuditEntry newValue)
protected void	addAudit(String id, AuditEntry newValue)
void	addCompetitor(Competitor newValue)
void	addCompetitor(String id, Competitor newValue)
protected void	addContext(Context newValue)
protected void	addContext(String id, Context newValue)
protected void	addExtent(ExtentCapable newValue)
protected void	addExtent(String identity, ExtentCapable newValue)
protected void	addIndexEntry(IndexEntry newValue)
protected void	addIndexEntry(String id, IndexEntry newValue)
void	addOrganization(Organization newValue)
void	addOrganization(String id, Organization newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams params)
void	addOwningGroup(PrincipalGroup newValue)
ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
void	addSearchIndexEntry(SearchIndexEntry newValue)
void	addSearchIndexEntry(String id, SearchIndexEntry newValue)
protected void	addView(String namespace, View newValue)
protected void	addView(View newValue)
ExportResult	exportXml(String attributeFilter, String referenceFilter)
ExportResult	exportXml(XmlExportParams params)
BasicObject	getAccessGrantedByParent() Retrieves the value for the optional reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
protected short	getAccessLevelBrowse(int index)
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
protected short	getAccessLevelDelete(int index)
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
protected short	getAccessLevelUpdate(int index)
Collection	getAccount() Retrieves a collection containing all the elements for the reference account.
List	getAccount(AccountFilter filter) Retrieves the value for the reference account for the specified filter.
List	getAccount(AccountQuery query) Retrieves the value for the reference account for the specified query.
Account	getAccount(String id) Retrieves the value for the reference account for the specified qualifier attribute value.
Collection	getAccountFilter() Retrieves a collection containing all the elements for the reference accountFilter.
List	getAccountFilter(AccountFilterGlobalFilter filter) Retrieves the value for the reference accountFilter for the specified filter.
List	getAccountFilter(AccountFilterGlobalQuery query) Retrieves the value for the reference accountFilter for the specified query.
AccountFilterGlobal	getAccountFilter(String id) Retrieves the value for the reference accountFilter for the specified qualifier attribute value.
Collection	getAddress() Retrieves a collection containing all the elements for the reference address.
List	getAddress(AccountAddressFilter filter) Retrieves the value for the reference address for the specified filter.
List	getAddress(AccountAddressQuery query) Retrieves the value for the reference address for the specified query.
AccountAddress	getAddress(String id) Retrieves the value for the reference address for the specified qualifier attribute value.
Collection	getAddressFilter() Retrieves a collection containing all the elements for the reference addressFilter.
List	getAddressFilter(AddressFilterGlobalFilter filter) Retrieves the value for the reference addressFilter for the specified filter.
List	getAddressFilter(AddressFilterGlobalQuery query) Retrieves the value for the reference addressFilter for the specified query.
AddressFilterGlobal	getAddressFilter(String id) Retrieves the value for the reference addressFilter for the specified qualifier attribute value.
Collection	getAudit() Retrieves a collection containing all the elements for the reference audit.
List	getAudit(AuditEntryFilter filter) Retrieves the value for the reference audit for the specified filter.
List	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
AuditEntry	getAudit(String id) Retrieves the value for the reference audit for the specified qualifier attribute value.
Collection	getCompetitor() Retrieves a collection containing all the elements for the reference competitor.
List	getCompetitor(CompetitorFilter filter) Retrieves the value for the reference competitor for the specified filter.
List	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.
Collection	getContext() Retrieves the objects referenced by context.
Context	getContext(String id) Retrieves the value for the reference context for the specified qualifier attribute value.
String	getDescription()
Collection	getExtent() Retrieves a collection containing all the elements for the reference extent.
List	getExtent(ExtentCapableFilter filter) Retrieves the value for the reference extent for the specified filter.
List	getExtent(ExtentCapableQuery query) Retrieves the value for the reference extent for the specified query.
ExtentCapable	getExtent(String identity) Retrieves the value for the reference extent for the specified qualifier attribute value.
Collection	getIndexEntry() Retrieves a collection containing all the elements for the reference indexEntry.
List	getIndexEntry(IndexEntryFilter filter) Retrieves the value for the reference indexEntry for the specified filter.
List	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
IndexEntry	getIndexEntry(String id) Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
Collection	getOrganization() Retrieves a collection containing all the elements for the reference organization.
List	getOrganization(OrganizationFilter filter) Retrieves the value for the reference organization for the specified filter.
List	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.
List	getOwner()
String	getOwner(int index)
Collection	getOwningGroup() Retrieves the objects referenced by owningGroup.
PrincipalGroup	getOwningGroup(int index) Retrieves the value for the reference owningGroup for the specified qualifier attribute value.
User	getOwningUser() Retrieves the value for the optional reference owningUser.
Provider	getProvider() Retrieves the value for the reference provider.
Collection	getSearchIndexEntry() Retrieves a collection containing all the elements for the reference searchIndexEntry.
List	getSearchIndexEntry(SearchIndexEntryFilter filter) Retrieves the value for the reference searchIndexEntry for the specified filter.
List	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.
Collection	getView() Retrieves a collection containing all the elements for the reference view.
View	getView(String namespace) Retrieves the value for the reference view for the specified qualifier attribute value.
List	getView(ViewFilter filter) Retrieves the value for the reference view for the specified filter.
List	getView(ViewQuery query) Retrieves the value for the reference view for the specified query.
ImportResult	importItem(byte[] item, String itemMimeType, String itemName, short locale)
ImportResult	importItem(ImportParams params)
protected void	removeAccessGrantedByParent()
void	removeAccount(String id)
void	removeAccountFilter(String id)
protected void	removeAddress(String id)
void	removeAddressFilter(String id)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams params)
ModifySecureObjectResult	removeAllOwningGroup(short mode)
protected void	removeAudit(String id)
void	removeCompetitor(String id)
protected void	removeContext(String id)
protected void	removeExtent(String identity)
protected void	removeIndexEntry(String id)
void	removeOrganization(String id)
void	removeOwningGroup(int index)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams params)
ModifySecureObjectResult	removeOwningGroup(PrincipalGroup group, short mode)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeSearchIndexEntry(String id)
protected void	removeView(String namespace)
protected void	setAccessGrantedByParent(BasicObject newValue)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams params)
ModifySecureObjectResult	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
protected void	setAccessLevelBrowse(int index, short newValue)
void	setAccessLevelBrowse(short newValue) Sets a new value for the attribute accessLevelBrowse.
protected void	setAccessLevelDelete(int index, short newValue)
void	setAccessLevelDelete(short newValue) Sets a new value for the attribute accessLevelDelete.
protected void	setAccessLevelUpdate(int index, short newValue)
void	setAccessLevelUpdate(short newValue) Sets a new value for the attribute accessLevelUpdate.
void	setAccount(Account[] newValue)
void	setAccount(List newValue)
void	setAccountFilter(AccountFilterGlobal[] newValue)
void	setAccountFilter(List newValue)
protected void	setAddress(AccountAddress[] newValue)
protected void	setAddress(List newValue)
void	setAddressFilter(AddressFilterGlobal[] newValue)
void	setAddressFilter(List newValue)
protected void	setAudit(AuditEntry[] newValue)
protected void	setAudit(List newValue)
void	setCompetitor(Competitor[] newValue)
void	setCompetitor(List newValue)
protected void	setContext(Context[] newValue)
protected void	setContext(List newValue)
void	setDescription(String newValue) Sets a new value for the attribute description.
protected void	setExtent(ExtentCapable[] newValue)
protected void	setExtent(List newValue)
protected void	setIndexEntry(IndexEntry[] newValue)
protected void	setIndexEntry(List newValue)
void	setOrganization(List newValue)
void	setOrganization(Organization[] newValue)
protected void	setOwner(List newValue)
protected void	setOwner(String[] newValue)
void	setOwningGroup(List newValue)
void	setOwningGroup(PrincipalGroup[] newValue)
ModifySecureObjectResult	setOwningUser(SetOwningUserParams params)
ModifySecureObjectResult	setOwningUser(short mode, User user)
void	setOwningUser(User newValue) Sets a new value for the reference owningUser.
protected void	setProvider(Provider newValue)
void	setSearchIndexEntry(List newValue)
void	setSearchIndexEntry(SearchIndexEntry[] newValue)
protected void	setView(List newValue)
protected void	setView(View[] newValue)
Void	updateIndex()
Void	updateIndex(Void params)

Methods inherited from class org.openmdx.base.accessor.jmi.spi.RefObject_1

equals, jdoCopyFields, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsToObjectId, jdoCopyKeyFieldsToObjectId, jdoGetObjectId, jdoGetPersistenceManager, jdoGetTransactionalObjectId, jdoGetVersion, jdoIsDeleted, jdoIsDetached, jdoIsDirty, jdoIsNew, jdoIsPersistent, jdoIsTransactional, jdoMakeDirty, jdoNewInstance, jdoNewInstance, jdoNewObjectIdInstance, jdoNewObjectIdInstance, jdoProvideField, jdoProvideFields, jdoReplaceField, jdoReplaceFields, jdoReplaceFlags, jdoReplaceStateManager, refAddEventListener, refAddToUnitOfWork, refAddValue, refAddValue, refAddValue, refClass, refContext, refDefaultFetchGroup, refDelegate, refDelete, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refImmediateComposite, refImmediatePackage, refInitialize, refInitialize, refInvokeOperation, refInvokeOperation, refIsDeleted, refIsDirty, refIsInstanceOf, refIsNew, refIsPersistent, refIsWriteProtected, refMetaObject, refMofId, refOutermostComposite, refOutermostPackage, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refRemoveValue, refRemoveValue, refSetValue, refSetValue, refSetValue, refSetValue, refVerifyConstraints, refWriteProtect, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

SegmentImpl

public SegmentImpl(Object_1_0 object,
                   RefClass refClass)

Method Detail

setAccount

public void setAccount(List newValue)

setAccount

public void setAccount(Account[] newValue)

getAccount

public Account getAccount(String id)

Description copied from interface: Segment

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

getAccount

public Collection getAccount()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getAccount

public List getAccount(AccountFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference account for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAccount

public List getAccount(AccountQuery query)

Description copied from interface: Segment

Retrieves the value for the reference account for the specified query.

Returns:

The filtered collection of referenced objects.

addAccount

public void addAccount(String id,
                       Account newValue)

Parameters:

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

newValue - The element to be appended.

addAccount

public void addAccount(Account newValue)

Parameters:

newValue - The element to be appended.

removeAccount

public void removeAccount(String id)

setAccountFilter

public void setAccountFilter(List newValue)

setAccountFilter

public void setAccountFilter(AccountFilterGlobal[] newValue)

getAccountFilter

public AccountFilterGlobal getAccountFilter(String id)

Description copied from interface: Segment

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

getAccountFilter

public Collection getAccountFilter()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getAccountFilter

public List getAccountFilter(AccountFilterGlobalFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference accountFilter for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAccountFilter

public List getAccountFilter(AccountFilterGlobalQuery query)

Description copied from interface: Segment

Retrieves the value for the reference accountFilter for the specified query.

Returns:

The filtered collection of referenced objects.

addAccountFilter

public void addAccountFilter(String id,
                             AccountFilterGlobal newValue)

Parameters:

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

newValue - The element to be appended.

addAccountFilter

public void addAccountFilter(AccountFilterGlobal newValue)

Parameters:

newValue - The element to be appended.

removeAccountFilter

public void removeAccountFilter(String id)

setAddress

protected void setAddress(List newValue)

setAddress

protected void setAddress(AccountAddress[] newValue)

getAddress

public AccountAddress getAddress(String id)

Description copied from interface: Segment

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

getAddress

public Collection getAddress()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getAddress

public List getAddress(AccountAddressFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference address for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAddress

public List getAddress(AccountAddressQuery query)

Description copied from interface: Segment

Retrieves the value for the reference address for the specified query.

Returns:

The filtered collection of referenced objects.

addAddress

protected void addAddress(String id,
                          AccountAddress newValue)

addAddress

protected void addAddress(AccountAddress newValue)

removeAddress

protected void removeAddress(String id)

setAddressFilter

public void setAddressFilter(List newValue)

setAddressFilter

public void setAddressFilter(AddressFilterGlobal[] newValue)

getAddressFilter

public AddressFilterGlobal getAddressFilter(String id)

Description copied from interface: Segment

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

getAddressFilter

public Collection getAddressFilter()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getAddressFilter

public List getAddressFilter(AddressFilterGlobalFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference addressFilter for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAddressFilter

public List getAddressFilter(AddressFilterGlobalQuery query)

Description copied from interface: Segment

Retrieves the value for the reference addressFilter for the specified query.

Returns:

The filtered collection of referenced objects.

addAddressFilter

public void addAddressFilter(String id,
                             AddressFilterGlobal newValue)

Parameters:

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

newValue - The element to be appended.

addAddressFilter

public void addAddressFilter(AddressFilterGlobal newValue)

Parameters:

newValue - The element to be appended.

removeAddressFilter

public void removeAddressFilter(String id)

setCompetitor

public void setCompetitor(List newValue)

setCompetitor

public void setCompetitor(Competitor[] newValue)

getCompetitor

public Competitor getCompetitor(String id)

Description copied from interface: Segment

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

getCompetitor

public Collection getCompetitor()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getCompetitor

public List getCompetitor(CompetitorFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference competitor for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getCompetitor

public List getCompetitor(CompetitorQuery query)

Description copied from interface: Segment

Retrieves the value for the reference competitor for the specified query.

Returns:

The filtered collection of referenced objects.

addCompetitor

public void addCompetitor(String id,
                          Competitor newValue)

Parameters:

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

newValue - The element to be appended.

addCompetitor

public void addCompetitor(Competitor newValue)

Parameters:

newValue - The element to be appended.

removeCompetitor

public void removeCompetitor(String id)

setOrganization

public void setOrganization(List newValue)

setOrganization

public void setOrganization(Organization[] newValue)

getOrganization

public Organization getOrganization(String id)

Description copied from interface: Segment

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

getOrganization

public Collection getOrganization()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getOrganization

public List getOrganization(OrganizationFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference organization for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getOrganization

public List getOrganization(OrganizationQuery query)

Description copied from interface: Segment

Retrieves the value for the reference organization for the specified query.

Returns:

The filtered collection of referenced objects.

addOrganization

public void addOrganization(String id,
                            Organization newValue)

Parameters:

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

newValue - The element to be appended.

addOrganization

public void addOrganization(Organization newValue)

Parameters:

newValue - The element to be appended.

removeOrganization

public void removeOrganization(String id)

setSearchIndexEntry

public void setSearchIndexEntry(List newValue)

setSearchIndexEntry

public void setSearchIndexEntry(SearchIndexEntry[] newValue)

getSearchIndexEntry

public SearchIndexEntry getSearchIndexEntry(String id)

Description copied from interface: Segment

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

getSearchIndexEntry

public Collection getSearchIndexEntry()

Description copied from interface: Segment

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

Returns:

A collection containing all the elements for this reference.

getSearchIndexEntry

public List getSearchIndexEntry(SearchIndexEntryFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference searchIndexEntry for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getSearchIndexEntry

public List getSearchIndexEntry(SearchIndexEntryQuery query)

Description copied from interface: Segment

Retrieves the value for the reference searchIndexEntry for the specified query.

Returns:

The filtered collection of referenced objects.

addSearchIndexEntry

public void addSearchIndexEntry(String id,
                                SearchIndexEntry newValue)

Parameters:

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

newValue - The element to be appended.

addSearchIndexEntry

public void addSearchIndexEntry(SearchIndexEntry newValue)

Parameters:

newValue - The element to be appended.

removeSearchIndexEntry

public void removeSearchIndexEntry(String id)

setAudit

protected void setAudit(List newValue)

setAudit

protected void setAudit(AuditEntry[] newValue)

getAudit

public AuditEntry getAudit(String id)

Description copied from interface: Auditee

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

Specified by:

getAudit in interface Auditee

Parameters:

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

Returns:

The possibly null value for this reference.

getAudit

public Collection getAudit()

Description copied from interface: Auditee

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

Specified by:

getAudit in interface Auditee

Returns:

A collection containing all the elements for this reference.

getAudit

public List getAudit(AuditEntryFilter filter)

Description copied from interface: Auditee

Retrieves the value for the reference audit for the specified filter.

Specified by:

getAudit in interface Auditee

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAudit

public List getAudit(AuditEntryQuery query)

Description copied from interface: Auditee

Retrieves the value for the reference audit for the specified query.

Specified by:

getAudit in interface Auditee

Returns:

The filtered collection of referenced objects.

addAudit

protected void addAudit(String id,
                        AuditEntry newValue)

addAudit

protected void addAudit(AuditEntry newValue)

removeAudit

protected void removeAudit(String id)

importItem

public ImportResult importItem(ImportParams params)
                        throws RefException

Specified by:

importItem in interface Importer

Throws:

RefException

importItem

public ImportResult importItem(byte[] item,
                               String itemMimeType,
                               String itemName,
                               short locale)
                        throws RefException

Specified by:

importItem in interface Importer

Throws:

RefException

setIndexEntry

protected void setIndexEntry(List newValue)

setIndexEntry

protected void setIndexEntry(IndexEntry[] newValue)

getIndexEntry

public IndexEntry getIndexEntry(String id)

Description copied from interface: Indexed

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

Specified by:

getIndexEntry in interface Indexed

Parameters:

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

Returns:

The possibly null value for this reference.

getIndexEntry

public Collection getIndexEntry()

Description copied from interface: Indexed

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

Specified by:

getIndexEntry in interface Indexed

Returns:

A collection containing all the elements for this reference.

getIndexEntry

public List getIndexEntry(IndexEntryFilter filter)

Description copied from interface: Indexed

Retrieves the value for the reference indexEntry for the specified filter.

Specified by:

getIndexEntry in interface Indexed

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getIndexEntry

public List getIndexEntry(IndexEntryQuery query)

Description copied from interface: Indexed

Retrieves the value for the reference indexEntry for the specified query.

Specified by:

getIndexEntry in interface Indexed

Returns:

The filtered collection of referenced objects.

addIndexEntry

protected void addIndexEntry(String id,
                             IndexEntry newValue)

addIndexEntry

protected void addIndexEntry(IndexEntry newValue)

removeIndexEntry

protected void removeIndexEntry(String id)

updateIndex

public Void updateIndex(Void params)
                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

updateIndex

public Void updateIndex()
                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

getAccessGrantedByParent

public BasicObject getAccessGrantedByParent()

Description copied from interface: SecureObject

Retrieves the value for the optional reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The possibly null value for this reference.

setAccessGrantedByParent

protected void setAccessGrantedByParent(BasicObject newValue)

removeAccessGrantedByParent

protected void removeAccessGrantedByParent()

getAccessLevelBrowse

public short getAccessLevelBrowse()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

getAccessLevelBrowse

protected short getAccessLevelBrowse(int index)

setAccessLevelBrowse

public void setAccessLevelBrowse(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelBrowse.

setAccessLevelBrowse

protected void setAccessLevelBrowse(int index,
                                    short newValue)

getAccessLevelDelete

public short getAccessLevelDelete()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

getAccessLevelDelete

protected short getAccessLevelDelete(int index)

setAccessLevelDelete

public void setAccessLevelDelete(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelDelete.

setAccessLevelDelete

protected void setAccessLevelDelete(int index,
                                    short newValue)

getAccessLevelUpdate

public short getAccessLevelUpdate()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

getAccessLevelUpdate

protected short getAccessLevelUpdate(int index)

setAccessLevelUpdate

public void setAccessLevelUpdate(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelUpdate.

setAccessLevelUpdate

protected void setAccessLevelUpdate(int index,
                                    short newValue)

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams params)
                                        throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

addOwningGroup

public ModifySecureObjectResult addOwningGroup(PrincipalGroup group,
                                               short mode)
                                        throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

getOwner

public List getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getOwner

public String getOwner(int index)

Specified by:

getOwner in interface SecureObject

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

setOwner

protected void setOwner(List newValue)

setOwner

protected void setOwner(String[] newValue)

setOwningGroup

public void setOwningGroup(List newValue)

setOwningGroup

public void setOwningGroup(PrincipalGroup[] newValue)

getOwningGroup

public PrincipalGroup getOwningGroup(int index)

Description copied from interface: SecureObject

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

Specified by:

getOwningGroup in interface SecureObject

Parameters:

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

Returns:

The possibly null value for this reference.

getOwningGroup

public Collection getOwningGroup()

Description copied from interface: SecureObject

Retrieves the objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The collection of referenced objects.

addOwningGroup

public void addOwningGroup(int index,
                           PrincipalGroup newValue)

Specified by:

addOwningGroup in interface SecureObject

Parameters:

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

newValue - The element to be appended.

addOwningGroup

public void addOwningGroup(PrincipalGroup newValue)

Specified by:

addOwningGroup in interface SecureObject

Parameters:

newValue - The element to be appended.

removeOwningGroup

public void removeOwningGroup(int index)

Specified by:

removeOwningGroup in interface SecureObject

getOwningUser

public User getOwningUser()

Description copied from interface: SecureObject

Retrieves the value for the optional reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The possibly null value for this reference.

setOwningUser

public void setOwningUser(User newValue)

Description copied from interface: SecureObject

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

newValue - The non-null new value for this reference.

removeOwningUser

public void removeOwningUser()

Description copied from interface: SecureObject

Removes the value for the optional reference owningUser.

Specified by:

removeOwningUser in interface SecureObject

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams params)
                                              throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(short mode)
                                              throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams params)
                                           throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)
                                           throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams params)
                                        throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

setAccessLevel

public ModifySecureObjectResult setAccessLevel(short accessLevelBrowse,
                                               short accessLevelDelete,
                                               short accessLevelUpdate,
                                               short mode)
                                        throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams params)
                                       throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

setOwningUser

public ModifySecureObjectResult setOwningUser(short mode,
                                              User user)
                                       throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

exportXml

public ExportResult exportXml(XmlExportParams params)
                       throws RefException

Specified by:

exportXml in interface XmlExporter

Throws:

RefException

exportXml

public ExportResult exportXml(String attributeFilter,
                              String referenceFilter)
                       throws RefException

Specified by:

exportXml in interface XmlExporter

Throws:

RefException

setContext

protected void setContext(List newValue)

setContext

protected void setContext(Context[] newValue)

getContext

public Context getContext(String id)

Description copied from interface: ContextCapable

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

Specified by:

getContext in interface ContextCapable

Parameters:

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

Returns:

The possibly null value for this reference.

getContext

public Collection getContext()

Description copied from interface: ContextCapable

Retrieves the objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The collection of referenced objects.

addContext

protected void addContext(String id,
                          Context newValue)

addContext

protected void addContext(Context newValue)

removeContext

protected void removeContext(String id)

getDescription

public String getDescription()

Specified by:

getDescription in interface Segment

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String newValue)

Description copied from interface: Segment

Sets a new value for the attribute description.

Specified by:

setDescription in interface Segment

Parameters:

newValue - The possibly null new value for attribute description.

setExtent

protected void setExtent(List newValue)

setExtent

protected void setExtent(ExtentCapable[] newValue)

getExtent

public ExtentCapable getExtent(String identity)

Description copied from interface: Segment

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

Specified by:

getExtent in interface Segment

Parameters:

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

Returns:

The possibly null value for this reference.

getExtent

public Collection getExtent()

Description copied from interface: Segment

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

Specified by:

getExtent in interface Segment

Returns:

A collection containing all the elements for this reference.

getExtent

public List getExtent(ExtentCapableFilter filter)

Description copied from interface: Segment

Retrieves the value for the reference extent for the specified filter.

Specified by:

getExtent in interface Segment

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getExtent

public List getExtent(ExtentCapableQuery query)

Description copied from interface: Segment

Retrieves the value for the reference extent for the specified query.

Specified by:

getExtent in interface Segment

Returns:

The filtered collection of referenced objects.

addExtent

protected void addExtent(String identity,
                         ExtentCapable newValue)

addExtent

protected void addExtent(ExtentCapable newValue)

removeExtent

protected void removeExtent(String identity)

getProvider

public Provider getProvider()

Description copied from interface: Segment

Retrieves the value for the reference provider.

Specified by:

getProvider in interface Segment

Returns:

The non-null value for this reference.

setProvider

protected void setProvider(Provider newValue)

setView

protected void setView(List newValue)

setView

protected void setView(View[] newValue)

getView

public View getView(String namespace)

Description copied from interface: ViewCapable

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

Specified by:

getView in interface ViewCapable

Parameters:

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

Returns:

The possibly null value for this reference.

getView

public Collection getView()

Description copied from interface: ViewCapable

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

Specified by:

getView in interface ViewCapable

Returns:

A collection containing all the elements for this reference.

getView

public List getView(ViewFilter filter)

Description copied from interface: ViewCapable

Retrieves the value for the reference view for the specified filter.

Specified by:

getView in interface ViewCapable

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getView

public List getView(ViewQuery query)

Description copied from interface: ViewCapable

Retrieves the value for the reference view for the specified query.

Specified by:

getView in interface ViewCapable

Returns:

The filtered collection of referenced objects.

addView

protected void addView(String namespace,
                       View newValue)

addView

protected void addView(View newValue)

removeView

protected void removeView(String namespace)