org.opencrx.kernel.admin1.jmi1
Interface Segment

All Superinterfaces:

org.openmdx.base.cci2.ContextCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

public interface Segment
extends Segment, Segment

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	addConfiguration(boolean idIsPersistent, String id, ComponentConfiguration configuration) Adds the specified element to the set of the values for the reference configuration.
CreateAdministratorResult	createAdministrator(CreateAdministratorParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..
CreateAdministratorResult	createAdministrator(String adminPrincipalName, String initialPassword, String initialPasswordVerification, String segmentName)
ComponentConfiguration	getConfiguration(boolean idIsPersistent, String id) Retrieves the value for the reference configuration for the specified qualifier attribute value.
<T extends ComponentConfiguration> List<T>	getConfiguration(ComponentConfigurationQuery query) Retrieves the value for the reference configuration for the specified query.
ComponentConfiguration	getConfiguration(String id) Retrieves the value for the reference configuration for the specified qualifier attribute value.
ImportLoginPrincipalsResult	importLoginPrincipals(byte[] item, String itemMimeType, String itemName)
ImportLoginPrincipalsResult	importLoginPrincipals(ImportLoginPrincipalsParams params) Note: This is an extension to the JMI 1 standard. In order to remain standard compliant you should use the non-struct signature..

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

addConfiguration, getConfiguration

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

Method Detail

getConfiguration

<T extends ComponentConfiguration> List<T> getConfiguration(ComponentConfigurationQuery query)

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

getConfiguration

ComponentConfiguration getConfiguration(boolean idIsPersistent,
                                        String id)

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

getConfiguration

ComponentConfiguration getConfiguration(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addConfiguration

void addConfiguration(boolean idIsPersistent,
                      String id,
                      ComponentConfiguration configuration)

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

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.

configuration - The element to be appended.

createAdministrator

CreateAdministratorResult createAdministrator(CreateAdministratorParams params)
                                              throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

createAdministrator

CreateAdministratorResult createAdministrator(String adminPrincipalName,
                                              String initialPassword,
                                              String initialPasswordVerification,
                                              String segmentName)

importLoginPrincipals

ImportLoginPrincipalsResult importLoginPrincipals(ImportLoginPrincipalsParams params)
                                                  throws RefException

Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature..

Throws:

RefException

importLoginPrincipals

ImportLoginPrincipalsResult importLoginPrincipals(byte[] item,
                                                  String itemMimeType,
                                                  String itemName)