@ProviderType public interface UserPropertiesQueryParams
Modifier and Type | Method and Description |
---|---|
AuthorizableTypes |
getAuthorizableTypes()
Returns the
AuthorizableTypes of the query. |
java.lang.String |
getFulltextQuery()
Returns the string used during fulltext search.
|
java.lang.Boolean |
getImpersonableUserFilter()
Returns whether to filter for the users that the provided user can impersonate:
Boolean.TRUE
Include only the users that the provided user can impersonate.
Boolean.FALSE
Currently not supported
null
No filtering is performed with regards to impersonation.
When this methods returns a non null value, it is guaranteed that a non null impersonator principal name has been set. |
java.lang.String |
getImpersonatorPrincipalName()
Gets the name of the user that can or cannot impersonate the users from the query.
|
long |
getLimit()
Returns the limit of the query.
|
long |
getOffset()
Returns the offset of the query.
|
UserPropertiesQueryParams |
withAuthorizableTypes(AuthorizableTypes authorizableTypes)
Sets the
AuthorizableTypes of the query. |
UserPropertiesQueryParams |
withFulltextQuery(java.lang.String fulltextQuery)
Sets the string used during fulltext search.
|
UserPropertiesQueryParams |
withLimit(long limit)
Sets the limit of the query.
|
UserPropertiesQueryParams |
withOffset(long offset)
Sets the offset of the query.
|
UserPropertiesQueryParams |
withOnlyUsersThatCanBeImpersonatedBy(java.lang.String impersonatorPrincipalName)
Sets whether to filter for the users that the provided user can
|
long getOffset()
@Nonnull UserPropertiesQueryParams withOffset(long offset)
offset
- The index of the first resulted item to be returned by the query.this
long getLimit()
@Nonnull UserPropertiesQueryParams withLimit(long limit)
limit
- The maximum count of items to be returned by the query.this
@Nullable java.lang.String getFulltextQuery()
@Nonnull UserPropertiesQueryParams withFulltextQuery(@Nullable java.lang.String fulltextQuery)
fulltextQuery
- The fulltext query string.this
@Nullable AuthorizableTypes getAuthorizableTypes()
AuthorizableTypes
of the query.AuthorizableTypes
.@Nonnull UserPropertiesQueryParams withAuthorizableTypes(@Nonnull AuthorizableTypes authorizableTypes)
AuthorizableTypes
of the query.authorizableTypes
- The AuthorizableTypes
.this
@Nullable java.lang.Boolean getImpersonableUserFilter()
Boolean.TRUE
Boolean.FALSE
null
jcr:read
permissions for the
authorizable node.@Nullable java.lang.String getImpersonatorPrincipalName()
null
if no filtering is performed with regards to impersonation.@Nonnull UserPropertiesQueryParams withOnlyUsersThatCanBeImpersonatedBy(@Nullable java.lang.String impersonatorPrincipalName)
impersonatorPrincipalName
- the name of the user that can impersonate the users from the query result.
If set to null
, no filter will be performed with regards to impersonationthis
Copyright © 2010 - 2020 Adobe. All Rights Reserved