public class WorkbasketQueryImpl extends Object implements WorkbasketQuery
BaseQuery.SortDirection| Modifier and Type | Method and Description |
|---|---|
WorkbasketQuery |
accessIdsHavePermission(WorkbasketPermission permission,
String... accessIds)
Setting up the permission which should be granted on the result workbaskets and the users which
should be checked.
|
WorkbasketQuery |
callerHasPermission(WorkbasketPermission permission)
Add condition to query if the caller (one of the accessIds of the caller) has the given
permission on the workbasket.
|
long |
count() |
WorkbasketQuery |
createdWithin(TimeInterval... intervals)
Add the time intervals within which the workbasket was created to your query.
|
WorkbasketQuery |
customAttributeIn(WorkbasketCustomField customField,
String... searchArguments)
Add the values of custom attributes for exact matching to your query.
|
WorkbasketQuery |
customAttributeLike(WorkbasketCustomField customField,
String... searchArguments)
Add the values of custom attributes for pattern matching to your query.
|
WorkbasketQuery |
descriptionLike(String... description)
Add your description to your query.
|
WorkbasketQuery |
domainIn(String... domain)
Add your domains to your query.
|
WorkbasketQuery |
domainLike(String... domain)
Add the domains for pattern matching to your query.
|
String[] |
getAccessId() |
WorkbasketQueryColumnName |
getColumnName() |
TimeInterval[] |
getCreatedIn() |
String[] |
getCustom1In() |
String[] |
getCustom1Like() |
String[] |
getCustom2In() |
String[] |
getCustom2Like() |
String[] |
getCustom3In() |
String[] |
getCustom3Like() |
String[] |
getCustom4In() |
String[] |
getCustom4Like() |
String[] |
getDescriptionLike() |
String[] |
getDomainIn() |
String[] |
getDomainLike() |
String[] |
getIdIn() |
String[] |
getKeyIn() |
String[] |
getKeyLike() |
String[] |
getKeyOrNameLike() |
TimeInterval[] |
getModifiedIn() |
String[] |
getNameIn() |
String[] |
getNameLike() |
List<String> |
getOrderBy() |
List<String> |
getOrderColumns() |
String[] |
getOrgLevel1In() |
String[] |
getOrgLevel1Like() |
String[] |
getOrgLevel2In() |
String[] |
getOrgLevel2Like() |
String[] |
getOrgLevel3In() |
String[] |
getOrgLevel3Like() |
String[] |
getOrgLevel4In() |
String[] |
getOrgLevel4Like() |
String[] |
getOwnerIn() |
String[] |
getOwnerLike() |
WorkbasketPermission |
getPermission() |
WorkbasketType[] |
getType() |
WorkbasketQuery |
idIn(String... id)
Add your ids to your query.
|
boolean |
isCheckReadPermission() |
boolean |
isJoinWithAccessList() |
boolean |
isMarkedForDeletion() |
WorkbasketQuery |
keyIn(String... key)
Add your keys to your query.
|
WorkbasketQuery |
keyLike(String... keys)
Add keys to your query.
|
WorkbasketQuery |
keyOrNameLike(String... keysOrNames)
Add search strings to your query that are searched case-insensitively in the key and name
fields of workbaskets.
|
List<WorkbasketSummary> |
list() |
List<WorkbasketSummary> |
list(int offset,
int limit) |
List<String> |
listValues(WorkbasketQueryColumnName columnName,
BaseQuery.SortDirection sortDirection) |
static void |
lowercaseAccessIds(String[] accessIdArray) |
WorkbasketQuery |
markedForDeletion(boolean markedForDeletion)
Add to your query if the Workbasket shall be marked for deletion.
|
WorkbasketQuery |
modifiedWithin(TimeInterval... intervals)
Add the time intervals within which the workbasket was modified to your query.
|
WorkbasketQuery |
nameIn(String... names)
Add your names to your query.
|
WorkbasketQuery |
nameLike(String... names)
Add names to your query.
|
WorkbasketQuery |
orderByCustomAttribute(WorkbasketCustomField customField,
BaseQuery.SortDirection sortDirection)
This method sorts the query result according to the value of a custom field.
|
WorkbasketQuery |
orderByDescription(BaseQuery.SortDirection sortDirection)
Sort the query result by description.
|
WorkbasketQuery |
orderByDomain(BaseQuery.SortDirection sortDirection)
Sort the query result by domain.
|
WorkbasketQuery |
orderByKey(BaseQuery.SortDirection sortDirection)
Sort the query result by key.
|
WorkbasketQuery |
orderByName(BaseQuery.SortDirection sortDirection)
Sort the query result by name.
|
WorkbasketQuery |
orderByOrgLevel1(BaseQuery.SortDirection sortDirection)
Sort the query result by organization level 1.
|
WorkbasketQuery |
orderByOrgLevel2(BaseQuery.SortDirection sortDirection)
Sort the query result by organization level 2.
|
WorkbasketQuery |
orderByOrgLevel3(BaseQuery.SortDirection sortDirection)
Sort the query result by organization level 3.
|
WorkbasketQuery |
orderByOrgLevel4(BaseQuery.SortDirection sortDirection)
Sort the query result by organization level 4.
|
WorkbasketQuery |
orderByOwner(BaseQuery.SortDirection sortDirection)
Sort the query result by owner.
|
WorkbasketQuery |
orderByType(BaseQuery.SortDirection sortDirection)
Sort the query result by type.
|
WorkbasketQuery |
orgLevel1In(String... orgLevel1)
Add the 1st organization level to your query.
|
WorkbasketQuery |
orgLevel1Like(String... orgLevel1)
Add the 1st organization level for pattern matching to your query.
|
WorkbasketQuery |
orgLevel2In(String... orgLevel2)
Add the 2nd organization level to your query.
|
WorkbasketQuery |
orgLevel2Like(String... orgLevel2)
Add the 2nd organization level for pattern matching to your query.
|
WorkbasketQuery |
orgLevel3In(String... orgLevel3)
Add the 3rd organization level to your query.
|
WorkbasketQuery |
orgLevel3Like(String... orgLevel3)
Add the 3rd organization level for pattern matching to your query.
|
WorkbasketQuery |
orgLevel4In(String... orgLevel4)
Add the 4th organization level to your query.
|
WorkbasketQuery |
orgLevel4Like(String... orgLevel4)
Add the 4th organization level for pattern matching to your query.
|
WorkbasketQuery |
ownerIn(String... owners)
Add the owners to your query.
|
WorkbasketQuery |
ownerLike(String... owners)
Add the owners for pattern matching to your query.
|
void |
setUsedToAugmentTasks(boolean usedToAugmentTasks) |
WorkbasketSummary |
single() |
String |
toString() |
WorkbasketQuery |
typeIn(WorkbasketType... type)
Add your types to your query.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitlistPage, toUpperCopypublic WorkbasketQuery idIn(String... id)
WorkbasketQueryidIn in interface WorkbasketQueryid - the id as Stringspublic WorkbasketQuery keyIn(String... key)
WorkbasketQuerykeyIn in interface WorkbasketQuerykey - the keys as Stringspublic WorkbasketQuery keyLike(String... keys)
WorkbasketQuerykeyLike in interface WorkbasketQuerykeys - the keys as Stringspublic WorkbasketQuery nameIn(String... names)
WorkbasketQuerynameIn in interface WorkbasketQuerynames - the names as Stringspublic WorkbasketQuery nameLike(String... names)
WorkbasketQuerynameLike in interface WorkbasketQuerynames - the names as Stringspublic WorkbasketQuery keyOrNameLike(String... keysOrNames)
WorkbasketQuerykeyOrNameLike in interface WorkbasketQuerykeysOrNames - the seach stringspublic WorkbasketQuery domainIn(String... domain)
WorkbasketQuerydomainIn in interface WorkbasketQuerydomain - the domains as Stringspublic WorkbasketQuery typeIn(WorkbasketType... type)
WorkbasketQuerytypeIn in interface WorkbasketQuerytype - the typespublic WorkbasketQuery createdWithin(TimeInterval... intervals)
WorkbasketQuerycreatedWithin in interface WorkbasketQueryintervals - - the TimeIntervals within which the workbasket was createdpublic WorkbasketQuery modifiedWithin(TimeInterval... intervals)
WorkbasketQuerymodifiedWithin in interface WorkbasketQueryintervals - - the TimeIntervals within which the workbasket was createdpublic WorkbasketQuery descriptionLike(String... description)
WorkbasketQuerydescriptionLike in interface WorkbasketQuerydescription - your descriptionpublic WorkbasketQuery ownerIn(String... owners)
WorkbasketQueryownerIn in interface WorkbasketQueryowners - the owners as Stringpublic WorkbasketQuery ownerLike(String... owners)
WorkbasketQueryownerLike in interface WorkbasketQueryowners - the owners as Stringspublic WorkbasketQuery accessIdsHavePermission(WorkbasketPermission permission, String... accessIds) throws InvalidArgumentException, NotAuthorizedException
WorkbasketQueryaccessIdsHavePermission in interface WorkbasketQuerypermission - which should be used for results.accessIds - Users which sould be checked for given permissions on workbaskets.InvalidArgumentException - when permission OR the accessIds are NULL.NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or
ADMINpublic WorkbasketQuery callerHasPermission(WorkbasketPermission permission)
WorkbasketQuerycallerHasPermission in interface WorkbasketQuerypermission - the permission for the query condition.public WorkbasketQuery orderByName(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByName in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByKey(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByKey in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByDescription(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByDescription in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByOwner(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByOwner in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByType(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByType in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByDomain(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByDomain in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery domainLike(String... domain)
WorkbasketQuerydomainLike in interface WorkbasketQuerydomain - the domains of workbaskets as Stringspublic WorkbasketQuery orderByCustomAttribute(WorkbasketCustomField customField, BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByCustomAttribute in interface WorkbasketQuerycustomField - identifies which custom attribute is affected.sortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByOrgLevel1(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByOrgLevel1 in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByOrgLevel2(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByOrgLevel2 in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByOrgLevel3(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByOrgLevel3 in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery orderByOrgLevel4(BaseQuery.SortDirection sortDirection)
WorkbasketQueryorderByOrgLevel4 in interface WorkbasketQuerysortDirection - Determines whether the result is sorted in ascending or descending order.
If sortDirection is null, the result is sorted in ascending orderpublic WorkbasketQuery customAttributeIn(WorkbasketCustomField customField, String... searchArguments)
WorkbasketQuerycustomAttributeIn in interface WorkbasketQuerycustomField - identifies which custom attribute is affected.searchArguments - the customField values of the searched for taskspublic WorkbasketQuery customAttributeLike(WorkbasketCustomField customField, String... searchArguments)
WorkbasketQuerycustomAttributeLike in interface WorkbasketQuerycustomField - identifies which custom attribute is affected.searchArguments - the customField values of the searched-for taskspublic WorkbasketQuery orgLevel1In(String... orgLevel1)
WorkbasketQueryorgLevel1In in interface WorkbasketQueryorgLevel1 - the 1st organization level as Stringpublic WorkbasketQuery orgLevel1Like(String... orgLevel1)
WorkbasketQueryorgLevel1Like in interface WorkbasketQueryorgLevel1 - the 1st organization level as Stringspublic WorkbasketQuery orgLevel2In(String... orgLevel2)
WorkbasketQueryorgLevel2In in interface WorkbasketQueryorgLevel2 - the 2nd organization level as Stringpublic WorkbasketQuery orgLevel2Like(String... orgLevel2)
WorkbasketQueryorgLevel2Like in interface WorkbasketQueryorgLevel2 - the 2nd organization level as Stringspublic WorkbasketQuery orgLevel3In(String... orgLevel3)
WorkbasketQueryorgLevel3In in interface WorkbasketQueryorgLevel3 - the 3rd organization level as Stringpublic WorkbasketQuery orgLevel3Like(String... orgLevel3)
WorkbasketQueryorgLevel3Like in interface WorkbasketQueryorgLevel3 - the 3rd organization level as Stringspublic WorkbasketQuery orgLevel4In(String... orgLevel4)
WorkbasketQueryorgLevel4In in interface WorkbasketQueryorgLevel4 - the 4th organization level as Stringpublic WorkbasketQuery orgLevel4Like(String... orgLevel4)
WorkbasketQueryorgLevel4Like in interface WorkbasketQueryorgLevel4 - the 4th organization level as Stringspublic WorkbasketQuery markedForDeletion(boolean markedForDeletion)
WorkbasketQuerymarkedForDeletion in interface WorkbasketQuerymarkedForDeletion - a simple flag showing if the workbasket is marked for deletionpublic List<WorkbasketSummary> list()
list in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>public List<WorkbasketSummary> list(int offset, int limit)
list in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>public List<String> listValues(WorkbasketQueryColumnName columnName, BaseQuery.SortDirection sortDirection)
listValues in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>public WorkbasketSummary single()
single in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>public long count()
count in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>public String[] getAccessId()
public WorkbasketPermission getPermission()
public String[] getNameIn()
public String[] getNameLike()
public String[] getKeyIn()
public String[] getKeyLike()
public String[] getKeyOrNameLike()
public WorkbasketType[] getType()
public TimeInterval[] getCreatedIn()
public TimeInterval[] getModifiedIn()
public String[] getDescriptionLike()
public String[] getOwnerIn()
public String[] getDomainIn()
public String[] getDomainLike()
public String[] getCustom1In()
public String[] getCustom1Like()
public String[] getCustom2In()
public String[] getCustom2Like()
public String[] getCustom3In()
public String[] getCustom3Like()
public String[] getCustom4In()
public String[] getCustom4Like()
public String[] getOrgLevel1In()
public String[] getOrgLevel1Like()
public String[] getOrgLevel2In()
public String[] getOrgLevel2Like()
public String[] getOrgLevel3In()
public String[] getOrgLevel3Like()
public String[] getOrgLevel4In()
public String[] getOrgLevel4Like()
public boolean isMarkedForDeletion()
public String[] getOwnerLike()
public String[] getIdIn()
public WorkbasketQueryColumnName getColumnName()
public boolean isJoinWithAccessList()
public boolean isCheckReadPermission()
public void setUsedToAugmentTasks(boolean usedToAugmentTasks)
public static void lowercaseAccessIds(String[] accessIdArray)
Copyright © 2020. All rights reserved.