org.openmdx.security.realm1.cci
Interface Policy

All Superinterfaces:

RefBaseObject, RefFeatured, RefObject, RefObject_1_0

All Known Subinterfaces:

Policy

All Known Implementing Classes:

PolicyImpl, PolicyImpl

public interface Policy
extends RefObject_1_0

Method Summary

void	addPrivilege(Privilege newValue)
void	addPrivilege(String id, Privilege newValue)
void	addRole(Role newValue)
void	addRole(String name, Role newValue)
String	getDescription()
String	getName() Retrieves the value for the attribute name.
Collection	getPrivilege() Retrieves a collection containing all the elements for the reference privilege.
List	getPrivilege(PrivilegeFilter filter) Retrieves the value for the reference privilege for the specified filter.
List	getPrivilege(PrivilegeQuery query) Retrieves the value for the reference privilege for the specified query.
Privilege	getPrivilege(String id) Retrieves the value for the reference privilege for the specified qualifier attribute value.
Collection	getRole() Retrieves a collection containing all the elements for the reference role.
List	getRole(RoleFilter filter) Retrieves the value for the reference role for the specified filter.
List	getRole(RoleQuery query) Retrieves the value for the reference role for the specified query.
Role	getRole(String name) Retrieves the value for the reference role for the specified qualifier attribute value.
void	removePrivilege(String id)
void	removeRole(String name)
void	setDescription(String newValue) Sets a new value for the attribute description.

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()

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.

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.

getPrivilege

Privilege getPrivilege(String id)

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

getPrivilege

Collection getPrivilege()

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

Returns:

A collection containing all the elements for this reference.

Throws:

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

getPrivilege

List getPrivilege(PrivilegeFilter filter)

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

getPrivilege

List getPrivilege(PrivilegeQuery query)

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

addPrivilege

void addPrivilege(String id,
                  Privilege newValue)

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.

addPrivilege

void addPrivilege(Privilege newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removePrivilege

void removePrivilege(String id)

Throws:

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

getRole

Role getRole(String name)

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

Parameters:

name - 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 a collection containing all the elements for the reference role.

Returns:

A collection containing all the elements for this reference.

Throws:

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

getRole

List getRole(RoleFilter filter)

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

getRole

List getRole(RoleQuery query)

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

addRole

void addRole(String name,
             Role newValue)

Parameters:

name - 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(Role newValue)

Parameters:

newValue - The element to be appended.

Throws:

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

removeRole

void removeRole(String name)

Throws:

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