Interface WorkbasketPriorityReport.Builder
- All Superinterfaces:
Report.Builder<PriorityQueryItem,PriorityColumnHeader>
- All Known Implementing Classes:
WorkbasketPriorityReportBuilderImpl
- Enclosing class:
- WorkbasketPriorityReport
-
Method Summary
Modifier and TypeMethodDescriptionclassificationCategoryIn(List<String> classificationCategory) Adds a list of classificationCategories to the builder.classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.customAttributeIn(TaskCustomField customField, String... strings) Adds the values of a certain TaskCustomField for exact matching to the builder.customAttributeLike(TaskCustomField customField, String... strings) Adds the values of a certain TaskCustomField for pattern matching to the builder.customAttributeNotIn(TaskCustomField customField, String... strings) Excludes the values of a certain TaskCustomField to the builder.customIntAttributeIn(TaskCustomIntField customIntField, Integer... values) Adds the values of a certain TaskCustomIntField for exact matching to the builder.customIntAttributeNotIn(TaskCustomIntField customIntField, Integer... values) Excludes the values of a certain TaskCustomIntField to the builder.customIntAttributeNotWithin(TaskCustomIntField customIntField, IntInterval... values) Exclude ranges of TaskCustomIntField for matching to the builder.customIntAttributeWithin(TaskCustomIntField customIntField, IntInterval... values) Adds ranges of TaskCustomIntField for matching to the builder.Adds a list of domains to the builder.excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.If this filter is used, the days of the report are counted in working days.Adds a list of states to the builder.withColumnHeaders(List<PriorityColumnHeader> columnHeaders) Adds a list of PriorityColumnHeaders to the builder to subdivide the report into clusters.workbasketIdIn(List<String> workbasketIds) Adds a list of workbasket ids to the builder.workbasketTypeIn(WorkbasketType... workbasketTypes) Adds WorkbasketTypes to the builder.
-
Method Details
-
buildReport
- Specified by:
buildReportin interfaceReport.Builder<PriorityQueryItem,PriorityColumnHeader> - Throws:
NotAuthorizedException
-
workbasketTypeIn
Adds WorkbasketTypes to the builder. The created report will only contain Tasks from Workbaskets with one of the provided types.- Parameters:
workbasketTypes- the workbasketTypes to include in the report- Returns:
- the WorkbasketPriorityReport.Builder
-
workbasketIdIn
Adds a list of workbasket ids to the builder. The created report contains only tasks with a workbasket id in this list.- Parameters:
workbasketIds- a list of workbasket ids- Returns:
- the WorkbasketPriorityReport.Builder
-
stateIn
Adds a list of states to the builder. The created report contains only tasks with a state in this list.- Parameters:
states- a list of states- Returns:
- the WorkbasketPriorityReport.Builder
-
classificationCategoryIn
Adds a list of classificationCategories to the builder. The created report contains only tasks with a category in this list.- Parameters:
classificationCategory- a list of classificationCategories- Returns:
- the WorkbasketPriorityReport.Builder
-
classificationIdIn
Adds a list of classificationIds to the builder. The created report contains only tasks with a classificationId in this list.- Parameters:
classificationIds- a list of classificationIds- Returns:
- the WorkbasketPriorityReport.Builder
-
excludedClassificationIdIn
Adds a list of excludedClassificationIds to the builder. The created report contains only tasks with a classificationId NOT in this list.- Parameters:
excludedClassificationIds- a list of excludedClassificationIds- Returns:
- the WorkbasketPriorityReport.Builder
-
domainIn
Adds a list of domains to the builder. The created report contains only tasks with a domain in this list.- Parameters:
domains- a list of domains- Returns:
- the WorkbasketPriorityReport.Builder
-
customAttributeIn
WorkbasketPriorityReport.Builder customAttributeIn(TaskCustomField customField, String... strings) throws InvalidArgumentException Adds the values of a certain TaskCustomField for exact matching to the builder.The created report contains only tasks with a custom attribute value exactly matching one of the items in the list.
- Parameters:
customField- the specified TaskCustomFieldstrings- the values the specified custom attribute should match- Returns:
- the modified the WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customAttributeNotIn
WorkbasketPriorityReport.Builder customAttributeNotIn(TaskCustomField customField, String... strings) throws InvalidArgumentException Excludes the values of a certain TaskCustomField to the builder.The created report contains only tasks with a custom attribute value not matching one of the items in the list.
- Parameters:
customField- the specified TaskCustomFieldstrings- the values the specified custom attribute should not match- Returns:
- the modified WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customAttributeLike
WorkbasketPriorityReport.Builder customAttributeLike(TaskCustomField customField, String... strings) throws InvalidArgumentException Adds the values of a certain TaskCustomField for pattern matching to the builder.The created report contains only tasks with a custom attribute value pattern-matching one of the items in the list. They will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
- Parameters:
customField- the specified TaskCustomFieldstrings- the values the specified custom attribute should match- Returns:
- the modified the WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customIntAttributeIn
WorkbasketPriorityReport.Builder customIntAttributeIn(TaskCustomIntField customIntField, Integer... values) throws InvalidArgumentException Adds the values of a certain TaskCustomIntField for exact matching to the builder.The created Report contains only Tasks with a customIntField value exactly matching one of the items in the list.
- Parameters:
customIntField- the specified TaskCustomIntFieldvalues- the values the specified customIntField should match- Returns:
- the modified WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customIntAttributeNotIn
WorkbasketPriorityReport.Builder customIntAttributeNotIn(TaskCustomIntField customIntField, Integer... values) throws InvalidArgumentException Excludes the values of a certain TaskCustomIntField to the builder.The created Report contains only Tasks with a customIntField value not matching one of the items in the list.
- Parameters:
customIntField- the specified TaskCustomIntFieldvalues- the values the specified customIntField should not match- Returns:
- the modified WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customIntAttributeWithin
WorkbasketPriorityReport.Builder customIntAttributeWithin(TaskCustomIntField customIntField, IntInterval... values) throws InvalidArgumentException Adds ranges of TaskCustomIntField for matching to the builder.The created report contains only Tasks with a customIntField value being inside the range of one of the items in the list.
- Parameters:
customIntField- the specified TaskCustomIntFieldvalues- the values the specified customIntField should match- Returns:
- the modified WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
customIntAttributeNotWithin
WorkbasketPriorityReport.Builder customIntAttributeNotWithin(TaskCustomIntField customIntField, IntInterval... values) throws InvalidArgumentException Exclude ranges of TaskCustomIntField for matching to the builder.The created report contains only Tasks with a customIntField value being not inside the range of one of the items in the list.
- Parameters:
customIntField- the specified TaskCustomIntFieldvalues- the values the specified customIntField should match- Returns:
- the modified WorkbasketPriorityReport.Builder
- Throws:
InvalidArgumentException- if filter values are not given
-
withColumnHeaders
Adds a list of PriorityColumnHeaders to the builder to subdivide the report into clusters.- Parameters:
columnHeaders- the column headers the report should consist of.- Returns:
- the WorkbasketPriorityReport.Builder
-
inWorkingDays
WorkbasketPriorityReport.Builder inWorkingDays()If this filter is used, the days of the report are counted in working days.- Returns:
- the WorkbasketPriorityReport.Builder
-