org.openmdx.security.authentication1.cci
Interface CredentialFilter

All Superinterfaces:

BasicObjectFilter, ContextCapableFilter, CredentialFilter, ExtentCapableFilter, RefFilter_1_0, Serializable, ViewCapableFilter

All Known Subinterfaces:

ChallengeResponseFilter, PasscodeFilter, PasswordFilter, SendPasscodeFilter

All Known Implementing Classes:

ChallengeResponseFilterImpl, PasscodeFilterImpl, PasswordFilterImpl, SendPasscodeFilterImpl

public interface CredentialFilter
extends BasicObjectFilter, CredentialFilter

A CredentialFilter selects a set of instances of class Credential based on conditions to be met by their attributes. For each attribute there can be set at most one constraint using either its thereExists or forAll clause. An instance must meet all constraints to be member of this set.

Method Summary

void	forAllId(short operator, Collection filterValues) Adds a constraint for the attribute id to the filter.
void	forAllId(short operator, String[] filterValues) Adds a constraint for the attribute id to the filter.
void	forAllResetCredential(short operator, Collection filterValues) Adds a constraint for the attribute resetCredential to the filter.
void	forAllResetCredential(short operator, Credential[] filterValues) Adds a constraint for the attribute resetCredential to the filter.
void	orderById(short order) Specifies the sort order of all the instances that match the filter criteria.
void	thereExistsId(short operator, Collection filterValues) Adds a constraint for the attribute id to the filter.
void	thereExistsId(short operator, String[] filterValues) Adds a constraint for the attribute id to the filter.
void	thereExistsResetCredential(short operator, Collection filterValues) Adds a constraint for the attribute resetCredential to the filter.
void	thereExistsResetCredential(short operator, Credential[] filterValues) Adds a constraint for the attribute resetCredential to the filter.

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

forAllCreatedAt, forAllCreatedAt, forAllCreatedBy, forAllCreatedBy, forAllModifiedAt, forAllModifiedAt, forAllModifiedBy, forAllModifiedBy, orderByCreatedAt, orderByCreatedBy, orderByModifiedAt, orderByModifiedBy, thereExistsCreatedAt, thereExistsCreatedAt, thereExistsCreatedBy, thereExistsCreatedBy, thereExistsModifiedAt, thereExistsModifiedAt, thereExistsModifiedBy, thereExistsModifiedBy

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

forAllContext, forAllContext, thereExistsContext, thereExistsContext

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

forAllIdentity, forAllIdentity, orderByIdentity, thereExistsIdentity, thereExistsIdentity

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefFilter_1_0

clear, refAddValue, refAddValue, refAddValue, refGetAttributeSpecifiers, refGetFilterProperties

Methods inherited from interface org.openmdx.security.realm1.cci.CredentialFilter

forAllLocked, forAllLocked, forAllSubject, forAllSubject, orderByLocked, thereExistsLocked, thereExistsLocked, thereExistsSubject, thereExistsSubject

Method Detail

forAllId

void forAllId(short operator,
              String[] filterValues)

Adds a constraint for the attribute id to the filter. An instance of class Credential is excluded from the result set unless its value of attribute id satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllId and thereExistsId for the same arguments.

You can set at most one thereExistsId or forAllId constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute id to be compared to.

See Also:

FilterOperators

thereExistsId

void thereExistsId(short operator,
                   String[] filterValues)

Adds a constraint for the attribute id to the filter. An instance of class Credential is excluded from the result set unless its value of attribute id satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllId and thereExistsId for the same arguments.

You can set at most one thereExistsId or forAllId constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute id to be compared to.

See Also:

FilterOperators

forAllId

void forAllId(short operator,
              Collection filterValues)

Adds a constraint for the attribute id to the filter. An instance of class Credential is excluded from the result set unless its value of attribute id satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllId and thereExistsId for the same arguments.

You can set at most one thereExistsId or forAllId constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute id to be compared to.

See Also:

FilterOperators

thereExistsId

void thereExistsId(short operator,
                   Collection filterValues)

Adds a constraint for the attribute id to the filter. An instance of class Credential is excluded from the result set unless its value of attribute id satisfies the given condition.

Since the multiplicity for this attribute is 1..1, there is no difference between the filter methods forAllId and thereExistsId for the same arguments.

You can set at most one thereExistsId or forAllId constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute id to be compared to.

See Also:

FilterOperators

orderById

void orderById(short order)

Specifies the sort order of all the instances that match the filter criteria.

Parameters:

order - The sort order for this filter.

See Also:

Directions

forAllResetCredential

void forAllResetCredential(short operator,
                           Credential[] filterValues)

Adds a constraint for the attribute resetCredential to the filter. An instance of class Credential is excluded from the result set unless its value of attribute resetCredential satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is met!

You can set at most one thereExistsResetCredential or forAllResetCredential constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute resetCredential to be compared to.

See Also:

FilterOperators

thereExistsResetCredential

void thereExistsResetCredential(short operator,
                                Credential[] filterValues)

Adds a constraint for the attribute resetCredential to the filter. An instance of class Credential is excluded from the result set unless its value of attribute resetCredential satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is not met!

You can set at most one thereExistsResetCredential or forAllResetCredential constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute resetCredential to be compared to.

See Also:

FilterOperators

forAllResetCredential

void forAllResetCredential(short operator,
                           Collection filterValues)

Adds a constraint for the attribute resetCredential to the filter. An instance of class Credential is excluded from the result set unless its value of attribute resetCredential satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is met!

You can set at most one thereExistsResetCredential or forAllResetCredential constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute resetCredential to be compared to.

See Also:

FilterOperators

thereExistsResetCredential

void thereExistsResetCredential(short operator,
                                Collection filterValues)

Adds a constraint for the attribute resetCredential to the filter. An instance of class Credential is excluded from the result set unless its value of attribute resetCredential satisfies the given condition.

Since the multiplicity for this attribute is 0..1, the attribute can have no value in which case the filter condition is not met!

You can set at most one thereExistsResetCredential or forAllResetCredential constraint for this attribute.

Parameters:

operator - The operator for this filter.

filterValues - The values you want the attribute resetCredential to be compared to.

See Also:

FilterOperators