## Uses of Class
org.keycloak.storage.SearchableModelField

- Packages that use SearchableModelField
  Package | Description
  --- | ---
  org.keycloak.authorization.model | Provides the domain model and any other type related with it
  org.keycloak.models |
  org.keycloak.models.map.storage |
  org.keycloak.models.map.storage.chm |
  org.keycloak.sessions |

- - ### Uses of SearchableModelField in org.keycloak.authorization.model

    Fields in org.keycloak.authorization.model declared as SearchableModelField
    Modifier and Type | Field and Description
    --- | ---
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`ASSOCIATED_POLICY_ID`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`CONFIG`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`GRANTED_TIMESTAMP`
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`ID`
    `static SearchableModelField<ResourceServer>` | ResourceServer.SearchableFields.`ID`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`ID`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`ID`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`ID`
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`NAME`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`NAME`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`NAME`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`OWNER`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`OWNER`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`OWNER`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`OWNER_MANAGED_ACCESS`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`POLICY_ID`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`REQUESTER`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`RESOURCE_ID`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`RESOURCE_ID`
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`RESOURCE_SERVER_ID`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`RESOURCE_SERVER_ID`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`RESOURCE_SERVER_ID`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`RESOURCE_SERVER_ID`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`SCOPE_ID`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`SCOPE_ID`
    `static SearchableModelField<PermissionTicket>` | PermissionTicket.SearchableFields.`SCOPE_ID`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`TYPE`
    `static SearchableModelField<Policy>` | Policy.SearchableFields.`TYPE`
    `static SearchableModelField<Resource>` | Resource.SearchableFields.`URI`

    Methods in org.keycloak.authorization.model that return SearchableModelField
    Modifier and Type | Method and Description
    --- | ---
    `SearchableModelField<Scope>` | Scope.FilterOption.`getSearchableModelField()`
    `SearchableModelField<Resource>` | Resource.FilterOption.`getSearchableModelField()`
    `SearchableModelField<Policy>` | Policy.FilterOption.`getSearchableModelField()`
    `SearchableModelField<PermissionTicket>` | PermissionTicket.FilterOption.`getSearchableModelField()`

  - ### Uses of SearchableModelField in org.keycloak.models

    Fields in org.keycloak.models declared as SearchableModelField
    Modifier and Type | Field and Description
    --- | ---
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`ASSIGNED_GROUP`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`ASSIGNED_ROLE`
    `static SearchableModelField<GroupModel>` | GroupModel.SearchableFields.`ASSIGNED_ROLE` Field for comparison with roles granted to this group.
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`ATTRIBUTE` Search for attribute value.
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`ATTRIBUTE` Search for attribute value.
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`BROKER_SESSION_ID`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`BROKER_USER_ID`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`CLIENT_ID`
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`CLIENT_ID` If client role, ID of the client (not the clientId)
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`CLIENT_ID`
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`CLIENT_ID`
    `static SearchableModelField<RealmModel>` | RealmModel.SearchableFields.`CLIENT_INITIAL_ACCESS` Search for realms that have some client initial access set.
    `static SearchableModelField<RealmModel>` | RealmModel.SearchableFields.`COMPONENT_PROVIDER_TYPE` Search for realms that have some component with
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`CONSENT_CLIENT_FEDERATION_LINK` Search for users that have consent set for a particular client that originates in the given client provider.
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`CONSENT_FOR_CLIENT` Search for users that have consent set for a particular client.
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`CONSENT_WITH_CLIENT_SCOPE` Search for users that have consent that has given client scope.
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`CORRESPONDING_SESSION_ID` Represents the corresponding offline user session for the online user session.
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`DESCRIPTION`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`EMAIL`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`EMAIL_VERIFIED`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`ENABLED`
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`ENABLED`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`FEDERATION_LINK`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`FIRST_NAME`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`ID`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`ID`
    `static SearchableModelField<UserLoginFailureModel>` | UserLoginFailureModel.SearchableFields.`ID`
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`ID`
    `static SearchableModelField<RealmModel>` | RealmModel.SearchableFields.`ID`
    `static SearchableModelField<GroupModel>` | GroupModel.SearchableFields.`ID`
    `static SearchableModelField<ClientScopeModel>` | ClientScopeModel.SearchableFields.`ID`
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`ID`
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`ID`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`IDP_AND_USER` This field can only searched either for users coming from an IDP, then the operand is (idp_alias), or as user coming from a particular IDP with given username there, then the operand is a pair (idp_alias, idp_user_id).
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`IS_CLIENT_ROLE`
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`IS_COMPOSITE_ROLE`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`IS_OFFLINE`
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`IS_OFFLINE`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`LAST_NAME`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`LAST_SESSION_REFRESH`
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`NAME`
    `static SearchableModelField<RealmModel>` | RealmModel.SearchableFields.`NAME`
    `static SearchableModelField<GroupModel>` | GroupModel.SearchableFields.`NAME`
    `static SearchableModelField<ClientScopeModel>` | ClientScopeModel.SearchableFields.`NAME`
    `static SearchableModelField<GroupModel>` | GroupModel.SearchableFields.`PARENT_ID` Parent group ID
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<UserLoginFailureModel>` | UserLoginFailureModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<RoleModel>` | RoleModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<GroupModel>` | GroupModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<ClientScopeModel>` | ClientScopeModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<ClientModel>` | ClientModel.SearchableFields.`SCOPE_MAPPING_ROLE`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`SERVICE_ACCOUNT_CLIENT` ID of the client corresponding to the service account
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`TIMESTAMP`
    `static SearchableModelField<UserSessionModel>` | UserSessionModel.SearchableFields.`USER_ID`
    `static SearchableModelField<UserLoginFailureModel>` | UserLoginFailureModel.SearchableFields.`USER_ID`
    `static SearchableModelField<AuthenticatedClientSessionModel>` | AuthenticatedClientSessionModel.SearchableFields.`USER_SESSION_ID`
    `static SearchableModelField<UserModel>` | UserModel.SearchableFields.`USERNAME`

  - ### Uses of SearchableModelField in org.keycloak.models.map.storage

    Methods in org.keycloak.models.map.storage that return SearchableModelField
    Modifier and Type | Method and Description
    --- | ---
    `SearchableModelField` | CriterionNotSupportedException.`getField()`
    `SearchableModelField<M>` | QueryParameters.OrderBy.`getModelField()`

    Methods in org.keycloak.models.map.storage with parameters of type SearchableModelField
    Modifier and Type | Method and Description
    --- | ---
    `ModelCriteriaBuilder<M>` | ModelCriteriaBuilder.`compare(SearchableModelField<M> modelField, ModelCriteriaBuilder.Operator op, Object... value)` Adds a constraint for the given model field to this criteria builder and returns a criteria builder that is combined with the the new constraint.
    `QueryParameters<M>` | QueryParameters.`orderBy(SearchableModelField<M> searchableModelField, QueryParameters.Order order)` Sets orderBy parameter; can be called repeatedly; fields are stored in a list where the first field has highest priority when determining order; e.g.
    `QueryParameters<M>` | QueryParameters.`pagination(Integer offset, Integer limit, SearchableModelField<M> orderByAscField)` Sets pagination (offset, limit and orderBy) parameters to `QueryParameters`

    Constructors in org.keycloak.models.map.storage with parameters of type SearchableModelField
    Constructor and Description
    `CriterionNotSupportedException(SearchableModelField field, ModelCriteriaBuilder.Operator op)`
    `CriterionNotSupportedException(SearchableModelField field, ModelCriteriaBuilder.Operator op, String message)`
    `CriterionNotSupportedException(SearchableModelField field, ModelCriteriaBuilder.Operator op, String message, Throwable cause)`
    `OrderBy(SearchableModelField<M> modelField, QueryParameters.Order order)`

  - ### Uses of SearchableModelField in org.keycloak.models.map.storage.chm

    Fields in org.keycloak.models.map.storage.chm with type parameters of type SearchableModelField
    Modifier and Type | Field and Description
    --- | ---
    `static Map<SearchableModelField<RootAuthenticationSessionModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapRootAuthenticationSessionEntity,RootAuthenticationSessionModel>>` | MapFieldPredicates.`AUTHENTICATION_SESSION_PREDICATES`
    `static Map<SearchableModelField<PermissionTicket>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapPermissionTicketEntity,PermissionTicket>>` | MapFieldPredicates.`AUTHZ_PERMISSION_TICKET_PREDICATES`
    `static Map<SearchableModelField<Policy>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapPolicyEntity,Policy>>` | MapFieldPredicates.`AUTHZ_POLICY_PREDICATES`
    `static Map<SearchableModelField<Resource>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapResourceEntity,Resource>>` | MapFieldPredicates.`AUTHZ_RESOURCE_PREDICATES`
    `static Map<SearchableModelField<ResourceServer>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapResourceServerEntity,ResourceServer>>` | MapFieldPredicates.`AUTHZ_RESOURCE_SERVER_PREDICATES`
    `static Map<SearchableModelField<Scope>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapScopeEntity,Scope>>` | MapFieldPredicates.`AUTHZ_SCOPE_PREDICATES`
    `static Map<SearchableModelField<ClientModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapClientEntity,ClientModel>>` | MapFieldPredicates.`CLIENT_PREDICATES`
    `static Map<SearchableModelField<ClientScopeModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapClientScopeEntity,ClientScopeModel>>` | MapFieldPredicates.`CLIENT_SCOPE_PREDICATES`
    `static Map<SearchableModelField<AuthenticatedClientSessionModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapAuthenticatedClientSessionEntity,AuthenticatedClientSessionModel>>` | MapFieldPredicates.`CLIENT_SESSION_PREDICATES`
    `static Map<SearchableModelField<GroupModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapGroupEntity,GroupModel>>` | MapFieldPredicates.`GROUP_PREDICATES`
    `static Map<SearchableModelField<RealmModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapRealmEntity,RealmModel>>` | MapFieldPredicates.`REALM_PREDICATES`
    `static Map<SearchableModelField<RoleModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapRoleEntity,RoleModel>>` | MapFieldPredicates.`ROLE_PREDICATES`
    `static Map<SearchableModelField<UserLoginFailureModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapUserLoginFailureEntity,UserLoginFailureModel>>` | MapFieldPredicates.`USER_LOGIN_FAILURE_PREDICATES`
    `static Map<SearchableModelField<UserModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapUserEntity,UserModel>>` | MapFieldPredicates.`USER_PREDICATES`
    `static Map<SearchableModelField<UserSessionModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapUserSessionEntity,UserSessionModel>>` | MapFieldPredicates.`USER_SESSION_PREDICATES`

    Methods in org.keycloak.models.map.storage.chm that return types with arguments of type SearchableModelField
    Modifier and Type | Method and Description
    --- | ---
    `protected static <K,V extends AbstractEntity,M> Map<SearchableModelField<M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>>` | MapFieldPredicates.`basePredicates(SearchableModelField<M> idField)`
    `static <K,V extends AbstractEntity,M> Map<SearchableModelField<M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>>` | MapFieldPredicates.`getPredicates(Class<M> clazz)`

    Methods in org.keycloak.models.map.storage.chm with parameters of type SearchableModelField
    Modifier and Type | Method and Description
    --- | ---
    `protected static <K,V extends AbstractEntity,M> Map<SearchableModelField<M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>>` | MapFieldPredicates.`basePredicates(SearchableModelField<M> idField)`
    `MapModelCriteriaBuilder<K,V,M>` | MapModelCriteriaBuilder.`compare(SearchableModelField<M> modelField, ModelCriteriaBuilder.Operator op, Object... values)`

    Constructor parameters in org.keycloak.models.map.storage.chm with type arguments of type SearchableModelField
    Constructor and Description
    `MapModelCriteriaBuilder(StringKeyConvertor<K> keyConvertor, Map<SearchableModelField<M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<K,V,M>> fieldPredicates)`

  - ### Uses of SearchableModelField in org.keycloak.sessions

    Fields in org.keycloak.sessions declared as SearchableModelField
    Modifier and Type | Field and Description
    --- | ---
    `static SearchableModelField<RootAuthenticationSessionModel>` | RootAuthenticationSessionModel.SearchableFields.`ID`
    `static SearchableModelField<RootAuthenticationSessionModel>` | RootAuthenticationSessionModel.SearchableFields.`REALM_ID`
    `static SearchableModelField<RootAuthenticationSessionModel>` | RootAuthenticationSessionModel.SearchableFields.`TIMESTAMP`

Copyright © 2021 JBoss by Red Hat. All rights reserved.