org.openmdx.security.realm1.cci2
Interface Realm

All Superinterfaces:

org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

All Known Subinterfaces:

Realm

All Known Implementing Classes:

Realm

public interface Realm
extends org.openmdx.base.cci2.BasicObject

Class Realm

Nested Class Summary

static interface

Realm.Identity Object 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.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
String	getName() Retrieves the value for the attribute name.
<T extends Principal> Collection<T>	getPrincipal() Retrieves a set containing all the elements for the reference principal.
Principal	getPrincipal(boolean idIsPersistent, String id) Retrieves the value for the reference principal for the specified qualifier attribute value.
Segment	getSegment() Retrieves the value for the reference segment.
void	setDescription(String description) Sets a new value for the attribute description.

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable

getView, getView

Method Detail

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

getPrincipal

<T extends Principal> Collection<T> getPrincipal()

Retrieves a set containing all the elements for the reference principal.

Returns:

A set containing all the elements for this reference.

getPrincipal

Principal getPrincipal(boolean idIsPersistent,
                       String id)

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

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.

Returns:

The non-null value for this reference.