org.opencrx.kernel.admin1.cci
Interface Segment

All Superinterfaces:

ContextCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, Segment, ViewCapable

public interface Segment
extends Segment

Method Summary

void	addConfiguration(ComponentConfiguration newValue)
void	addConfiguration(String id, ComponentConfiguration newValue)
CreateAdministratorResult	createAdministrator(CreateAdministratorParams params)
CreateAdministratorResult	createAdministrator(String adminPrincipalName, String initialPassword, String initialPasswordVerification, String segmentName)
Collection	getConfiguration() Retrieves a collection containing all the elements for the reference configuration.
List	getConfiguration(ComponentConfigurationFilter filter) Retrieves the value for the reference configuration for the specified filter.
List	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)
void	removeConfiguration(String id)

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

Method Detail

getConfiguration

ComponentConfiguration getConfiguration(String id)

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

getConfiguration

Collection getConfiguration()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getConfiguration

List getConfiguration(ComponentConfigurationFilter filter)

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

getConfiguration

List getConfiguration(ComponentConfigurationQuery query)

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

addConfiguration

void addConfiguration(String id,
                      ComponentConfiguration 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.

addConfiguration

void addConfiguration(ComponentConfiguration newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeConfiguration

void removeConfiguration(String id)

Throws:

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

createAdministrator

CreateAdministratorResult createAdministrator(CreateAdministratorParams params)
                                              throws RefException

Throws:

RefException

createAdministrator

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

Throws:

RefException

importLoginPrincipals

ImportLoginPrincipalsResult importLoginPrincipals(ImportLoginPrincipalsParams params)
                                                  throws RefException

Throws:

RefException

importLoginPrincipals

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

Throws:

RefException