org.openmdx.security.realm1.cci
Interface Role

All Superinterfaces:

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

All Known Implementing Classes:

RoleImpl

public interface Role
extends BasicObject

Method Summary

void	addPermission(Permission newValue) Appends the specified element to the list of all the values for the reference permission.
void	addPermission(String id, Permission newValue) Appends the specified element to the list of all the values for the reference permission for a specified qualifier attribute value.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
String	getName() Retrieves the value for the attribute name.
Collection	getPermission() Retrieves a collection containing all the elements for the reference permission.
List	getPermission(PermissionFilter filter) Retrieves the value for the reference permission for the specified filter.
List	getPermission(PermissionQuery query) Retrieves the value for the reference permission for the specified query.
Permission	getPermission(String id) Retrieves the value for the reference permission for the specified qualifier attribute value.
Policy	getPolicy() Retrieves the value for the reference policy.
boolean	isDisabled() Retrieves the value for the attribute disabled.
void	removePermission(String id) Removes the qualified (by means of the specified qualifier attribute value) element from the list of all the values for the reference permission.
void	setDescription(String newValue) Sets a new value for the attribute description.
void	setDisabled(boolean newValue) Sets a new value for the attribute disabled.

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

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.

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.

getPermission

Permission getPermission(String id)

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

getPermission

Collection getPermission()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getPermission

List getPermission(PermissionFilter filter)

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

getPermission

List getPermission(PermissionQuery query)

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

addPermission

void addPermission(String id,
                   Permission newValue)

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

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.

addPermission

void addPermission(Permission newValue)

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

Parameters:

newValue - The element to be appended.

Throws:

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

removePermission

void removePermission(String id)

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

Parameters:

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

getPolicy

Policy getPolicy()

Retrieves the value for the reference policy.

Returns:

The non-null value for this reference.

Throws:

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