org.openmdx.security.realm1.cci
Interface Principal

All Superinterfaces:

BasicObject, ContextCapable, ExtentCapable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, ViewCapable

All Known Subinterfaces:

Group

All Known Implementing Classes:

GroupImpl, PrincipalImpl

public interface Principal
extends BasicObject

Method Summary

void	addAuthCredential(Credential newValue) Appends the specified element to the list of all the values for the reference authCredential.
void	addAuthCredential(int index, Credential newValue) Appends the specified element to the list of all the values for the reference authCredential for a specified qualifier attribute value.
void	addIsMemberOf(Group newValue) Appends the specified element to the list of all the values for the reference isMemberOf.
void	addIsMemberOf(int index, Group newValue) Appends the specified element to the list of all the values for the reference isMemberOf for a specified qualifier attribute value.
Collection	getAuthCredential() Retrieves the objects referenced by authCredential.
Credential	getAuthCredential(int index) Retrieves the value for the reference authCredential for the specified qualifier attribute value.
Credential	getCredential() Retrieves the value for the optional reference credential.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
Collection	getIsMemberOf() Retrieves the objects referenced by isMemberOf.
Group	getIsMemberOf(int index) Retrieves the value for the reference isMemberOf for the specified qualifier attribute value.
String	getName() Retrieves the value for the attribute name.
Realm	getRealm() Retrieves the value for the reference realm.
Subject	getSubject() Retrieves the value for the reference subject.
boolean	isDisabled() Retrieves the value for the attribute disabled.
void	removeAuthCredential(int index) Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference authCredential.
void	removeCredential() Removes the value for the optional reference credential.
void	removeIsMemberOf(int index) Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference isMemberOf.
void	setCredential(Credential newValue) Sets a new value for the reference credential.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setDisabled(boolean newValue) Sets a new value for the attribute disabled.
void	setSubject(Subject newValue) Sets a new value for the reference subject.

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

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

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

getIdentity

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

getAuthCredential

Credential getAuthCredential(int index)

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

Parameters:

index - 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.

getAuthCredential

Collection getAuthCredential()

Retrieves the objects referenced by authCredential.

Returns:

The collection of referenced objects.

Throws:

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

addAuthCredential

void addAuthCredential(int index,
                       Credential newValue)

Appends the specified element to the list of all the values for the reference authCredential for a specified qualifier attribute value.

Parameters:

index - 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.

addAuthCredential

void addAuthCredential(Credential newValue)

Appends the specified element to the list of all the values for the reference authCredential.

Parameters:

newValue - The element to be appended.

Throws:

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

removeAuthCredential

void removeAuthCredential(int index)

Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference authCredential.

Parameters:

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

Throws:

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

getCredential

Credential getCredential()

Retrieves the value for the optional reference credential.

Returns:

The possibly null value for this reference.

Throws:

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

setCredential

void setCredential(Credential newValue)

Sets a new value for the reference credential.

Parameters:

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

Throws:

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

removeCredential

void removeCredential()

Removes the value for the optional reference credential.

Throws:

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

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

Throws:

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

setDescription

void setDescription(String newValue)

Sets a new value for the attribute description.

Parameters:

newValue - The possibly null new value for attribute description.

Throws:

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

isDisabled

boolean isDisabled()

Retrieves the value for the attribute disabled.

Returns:

The non-null value for attribute disabled.

Throws:

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

setDisabled

void setDisabled(boolean newValue)

Sets a new value for the attribute disabled.

Parameters:

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

Throws:

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

getIsMemberOf

Group getIsMemberOf(int index)

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

Parameters:

index - 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.

getIsMemberOf

Collection getIsMemberOf()

Retrieves the objects referenced by isMemberOf.

Returns:

The collection of referenced objects.

Throws:

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

addIsMemberOf

void addIsMemberOf(int index,
                   Group newValue)

Appends the specified element to the list of all the values for the reference isMemberOf for a specified qualifier attribute value.

Parameters:

index - 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.

addIsMemberOf

void addIsMemberOf(Group newValue)

Appends the specified element to the list of all the values for the reference isMemberOf.

Parameters:

newValue - The element to be appended.

Throws:

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

removeIsMemberOf

void removeIsMemberOf(int index)

Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference isMemberOf.

Parameters:

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

Throws:

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

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

Throws:

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

getRealm

Realm getRealm()

Retrieves the value for the reference realm.

Returns:

The non-null value for this reference.

Throws:

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

getSubject

Subject getSubject()

Retrieves the value for the reference subject.

Returns:

The non-null value for this reference.

Throws:

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

setSubject

void setSubject(Subject newValue)

Sets a new value for the reference subject.

Parameters:

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

Throws:

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