|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.Query
org.eclipse.stardust.engine.api.query.PreferenceQuery
public class PreferenceQuery
| Field Summary | |
|---|---|
static FilterableAttribute |
MODULE_ID
Allows to define a filter on the moduleId. |
static FilterableAttribute |
PREFERENCES_ID
Allows to define a filter on the preferencesId. |
static FilterableAttribute |
REALM_ID
Allows to define a filter on the user realm id. |
static FilterableAttribute |
SCOPE
Allows to define a filter on the preference scope. |
static FilterableAttribute |
USER_ID
Allows to define a filter on the user user id. |
| Method Summary | |
|---|---|
static PreferenceQuery |
findAll(PreferenceScope scope)
Creates a query for finding all preferences existing. |
static PreferenceQuery |
findPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
Query for search of preferences. |
static PreferenceQuery |
findPreferencesForRealms(String realmId,
String moduleId,
String preferencesId)
Query for search of realm scoped preferences belonging to different realms. Users having the Administrator role may use wildcards for realmId. |
static PreferenceQuery |
findPreferencesForUsers(String realmId,
String userId,
String moduleId,
String preferencesId)
Query for search of user scoped preferences belonging to different users and user realms. Users having the Administrator role may use wildcards for realmId and userId. |
| Methods inherited from class org.eclipse.stardust.engine.api.query.Query |
|---|
getFilter, getOrderCriteria, getPolicy, orderBy, orderBy, orderBy, removePolicy, setPolicy, toString, where |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final FilterableAttribute SCOPE
public static final FilterableAttribute MODULE_ID
public static final FilterableAttribute PREFERENCES_ID
public static final FilterableAttribute REALM_ID
public static final FilterableAttribute USER_ID
| Method Detail |
|---|
public static PreferenceQuery findAll(PreferenceScope scope)
PreferenceScope.DEFAULT is not supported.
org.eclipse.stardust.common.error.InvalidArgumentException - if scope is null.
PublicException - if parameter scope is PreferenceScope.DEFAULT.
public static PreferenceQuery findPreferences(PreferenceScope scope,
String moduleId,
String preferencesId)
PreferenceScope.DEFAULT is not supported.
scope - the scope to search inmoduleId - the module id to search for (wildcard '*' is allowed)preferencesId - the preferences id to search for (wildcard '*' is allowed)
org.eclipse.stardust.common.error.InvalidArgumentException - if scope is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if moduleId is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferencesId is null.
PublicException - if parameter scope is PreferenceScope.DEFAULT.
public static PreferenceQuery findPreferencesForUsers(String realmId,
String userId,
String moduleId,
String preferencesId)
realmId - the realmId to search for (wildcard '*' is allowed for administrators).
Specifying null here is interpreted as '*'.userId - the userId to search for (wildcard '*' is allowed for administrators).
Specifying null here is interpreted as '*'.moduleId - the module id to search for (wildcard '*' is allowed)preferencesId - the preferences id to search for (wildcard '*' is allowed)
org.eclipse.stardust.common.error.InvalidArgumentException - if moduleId is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferencesId is null.
public static PreferenceQuery findPreferencesForRealms(String realmId,
String moduleId,
String preferencesId)
realmId - the realmId to search for (wildcard '*' is allowed for administrators).
Specifying null here is interpreted as '*'.moduleId - the module id to search for (wildcard '*' is allowed)preferencesId - the preferences id to search for (wildcard '*' is allowed)
org.eclipse.stardust.common.error.InvalidArgumentException - if moduleId is null.
org.eclipse.stardust.common.error.InvalidArgumentException - if preferencesId is null.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||