org.openmdx.security.realm1.jmi1
Interface Realm

All Superinterfaces:

org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, Realm, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, org.openmdx.compatibility.view1.cci2.ViewCapable

public interface Realm
extends Realm, org.openmdx.base.jmi1.BasicObject

Class Realm

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmdx.security.realm1.cci2.Realm

Realm.Identity

Method Summary

void	addPrincipal(boolean idIsPersistent, String id, Principal principal) Adds the specified element to the set of the values for the reference principal.
Principal	getPrincipal(boolean idIsPersistent, String id) Retrieves the value for the reference principal for the specified qualifier attribute value.
<T extends Principal> List<T>	getPrincipal(PrincipalQuery query) Retrieves the value for the reference principal for the specified query.
Principal	getPrincipal(String id) Retrieves the value for the reference principal for the specified qualifier attribute value.
Segment	getSegment() Retrieves the value for the reference segment.

Methods inherited from interface org.openmdx.security.realm1.cci2.Realm

addPrincipal, getDescription, getName, getPrincipal, setDescription

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

getCreatedBy, getModifiedBy

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

getCreatedAt, getModifiedAt

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

getIdentity

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

getPrincipal

<T extends Principal> List<T> getPrincipal(PrincipalQuery query)

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

getPrincipal

Principal getPrincipal(boolean idIsPersistent,
                       String id)

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

Specified by:

getPrincipal in interface Realm

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

getPrincipal

Principal getPrincipal(String id)

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

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

Parameters:

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

Returns:

The possibly null value for this qualifier

addPrincipal

void addPrincipal(boolean idIsPersistent,
                  String id,
                  Principal principal)

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

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.

principal - The element to be appended.

getSegment

Segment getSegment()

Retrieves the value for the reference segment.

Specified by:

getSegment in interface Realm

Returns:

The non-null value for this reference.