org.openmdx.base.cci
Interface RoleCapable

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject, RefObject_1_0

All Known Implementing Classes:

RoleCapableImpl

public interface RoleCapable
extends RefObject_1_0

Method Summary

void	addRole(RoleCapable newValue) Appends the specified element to the list of all the values for the reference role.
void	addRole(String roleId, RoleCapable newValue) Appends the specified element to the list of all the values for the reference role for a specified qualifier attribute value.
Collection	getRole() Retrieves the objects referenced by role.
RoleCapable	getRole(String roleId) Retrieves the value for the reference role for the specified qualifier attribute value.
String	getRoleId() Retrieves the possibly null value for the optional attribute roleId.
void	removeRole(String roleId) Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference role.

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

getRole

RoleCapable getRole(String roleId)

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

Parameters:

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

getRole

Collection getRole()

Retrieves the objects referenced by role.

Returns:

The collection of referenced objects.

Throws:

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

addRole

void addRole(String roleId,
             RoleCapable newValue)

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

Parameters:

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

addRole

void addRole(RoleCapable newValue)

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

Parameters:

newValue - The element to be appended.

Throws:

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

removeRole

void removeRole(String roleId)

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

Parameters:

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

getRoleId

String getRoleId()

Retrieves the possibly null value for the optional attribute roleId.

Returns:

The possibly null value for attribute roleId.

Throws:

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