@aerokit/sdk 12.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +277 -0
- package/README.md +170 -0
- package/dist/cjs/bpm/deployer.js +57 -0
- package/dist/cjs/bpm/index.js +35 -0
- package/dist/cjs/bpm/process.js +636 -0
- package/dist/cjs/bpm/tasks.js +973 -0
- package/dist/cjs/bpm/values.js +82 -0
- package/dist/cjs/cache/cache.js +64 -0
- package/dist/cjs/cache/index.js +26 -0
- package/dist/cjs/cms/cmis.js +689 -0
- package/dist/cjs/cms/index.js +26 -0
- package/dist/cjs/component/decorators.js +126 -0
- package/dist/cjs/component/index.js +36 -0
- package/dist/cjs/core/configurations.js +110 -0
- package/dist/cjs/core/context.js +47 -0
- package/dist/cjs/core/env.js +45 -0
- package/dist/cjs/core/globals.js +54 -0
- package/dist/cjs/core/index.js +35 -0
- package/dist/cjs/db/dao.js +795 -0
- package/dist/cjs/db/database.js +904 -0
- package/dist/cjs/db/decorators.js +167 -0
- package/dist/cjs/db/index.js +72 -0
- package/dist/cjs/db/insert.js +51 -0
- package/dist/cjs/db/orm.js +245 -0
- package/dist/cjs/db/ormstatements.js +243 -0
- package/dist/cjs/db/procedure.js +112 -0
- package/dist/cjs/db/query.js +57 -0
- package/dist/cjs/db/repository.js +148 -0
- package/dist/cjs/db/sequence.js +59 -0
- package/dist/cjs/db/sql.js +516 -0
- package/dist/cjs/db/store.js +172 -0
- package/dist/cjs/db/translator.js +100 -0
- package/dist/cjs/db/update.js +43 -0
- package/dist/cjs/etcd/client.js +174 -0
- package/dist/cjs/etcd/index.js +26 -0
- package/dist/cjs/extensions/decorators.js +40 -0
- package/dist/cjs/extensions/extensions.js +108 -0
- package/dist/cjs/extensions/index.js +39 -0
- package/dist/cjs/git/client.js +277 -0
- package/dist/cjs/git/index.js +26 -0
- package/dist/cjs/http/client-async.js +224 -0
- package/dist/cjs/http/client.js +145 -0
- package/dist/cjs/http/decorators.js +76 -0
- package/dist/cjs/http/errors/ForbiddenError.js +41 -0
- package/dist/cjs/http/errors/ValidationError.js +41 -0
- package/dist/cjs/http/errors.js +26 -0
- package/dist/cjs/http/index.js +59 -0
- package/dist/cjs/http/request.js +281 -0
- package/dist/cjs/http/response.js +452 -0
- package/dist/cjs/http/rs/resource-common.js +32 -0
- package/dist/cjs/http/rs/resource-http-controller.js +306 -0
- package/dist/cjs/http/rs/resource-mappings.js +130 -0
- package/dist/cjs/http/rs/resource-method.js +218 -0
- package/dist/cjs/http/rs/resource.js +232 -0
- package/dist/cjs/http/rs.js +31 -0
- package/dist/cjs/http/session.js +124 -0
- package/dist/cjs/http/upload.js +144 -0
- package/dist/cjs/http/utils.js +106 -0
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/indexing/index.js +29 -0
- package/dist/cjs/indexing/searcher.js +70 -0
- package/dist/cjs/indexing/writer.js +45 -0
- package/dist/cjs/integrations/index.js +26 -0
- package/dist/cjs/integrations/integrations.js +55 -0
- package/dist/cjs/io/bytes.js +101 -0
- package/dist/cjs/io/files.js +344 -0
- package/dist/cjs/io/image.js +43 -0
- package/dist/cjs/io/index.js +38 -0
- package/dist/cjs/io/streams.js +243 -0
- package/dist/cjs/io/zip.js +251 -0
- package/dist/cjs/job/decorators.js +40 -0
- package/dist/cjs/job/index.js +39 -0
- package/dist/cjs/job/scheduler.js +347 -0
- package/dist/cjs/junit/index.js +18 -0
- package/dist/cjs/junit/junit.js +67 -0
- package/dist/cjs/kafka/consumer.js +70 -0
- package/dist/cjs/kafka/index.js +29 -0
- package/dist/cjs/kafka/producer.js +70 -0
- package/dist/cjs/log/index.js +26 -0
- package/dist/cjs/log/logging.js +174 -0
- package/dist/cjs/mail/client.js +153 -0
- package/dist/cjs/mail/index.js +26 -0
- package/dist/cjs/messaging/consumer.js +83 -0
- package/dist/cjs/messaging/decorators.js +40 -0
- package/dist/cjs/messaging/index.js +42 -0
- package/dist/cjs/messaging/producer.js +81 -0
- package/dist/cjs/mongodb/client.js +627 -0
- package/dist/cjs/mongodb/dao.js +390 -0
- package/dist/cjs/mongodb/index.js +36 -0
- package/dist/cjs/net/decorators.js +40 -0
- package/dist/cjs/net/index.js +42 -0
- package/dist/cjs/net/soap.js +228 -0
- package/dist/cjs/net/websockets.js +151 -0
- package/dist/cjs/net/wrappers/onClose.js +2 -0
- package/dist/cjs/net/wrappers/onError.js +2 -0
- package/dist/cjs/net/wrappers/onMessage.js +2 -0
- package/dist/cjs/net/wrappers/onOpen.js +2 -0
- package/dist/cjs/pdf/index.js +26 -0
- package/dist/cjs/pdf/pdf.js +160 -0
- package/dist/cjs/platform/command.js +47 -0
- package/dist/cjs/platform/engines.js +70 -0
- package/dist/cjs/platform/index.js +47 -0
- package/dist/cjs/platform/lifecycle.js +49 -0
- package/dist/cjs/platform/os.js +51 -0
- package/dist/cjs/platform/problems.js +127 -0
- package/dist/cjs/platform/registry.js +319 -0
- package/dist/cjs/platform/repository.js +498 -0
- package/dist/cjs/platform/workspace.js +574 -0
- package/dist/cjs/qldb/index.js +26 -0
- package/dist/cjs/qldb/qldb.js +24 -0
- package/dist/cjs/rabbitmq/consumer.js +50 -0
- package/dist/cjs/rabbitmq/index.js +29 -0
- package/dist/cjs/rabbitmq/producer.js +38 -0
- package/dist/cjs/redis/client.js +190 -0
- package/dist/cjs/redis/index.js +26 -0
- package/dist/cjs/security/decorators.js +48 -0
- package/dist/cjs/security/index.js +40 -0
- package/dist/cjs/security/oauth.js +75 -0
- package/dist/cjs/security/user.js +88 -0
- package/dist/cjs/template/engines.js +139 -0
- package/dist/cjs/template/index.js +26 -0
- package/dist/cjs/utils/alphanumeric.js +107 -0
- package/dist/cjs/utils/base64.js +104 -0
- package/dist/cjs/utils/converter.js +78 -0
- package/dist/cjs/utils/digest.js +167 -0
- package/dist/cjs/utils/escape.js +160 -0
- package/dist/cjs/utils/hex.js +104 -0
- package/dist/cjs/utils/index.js +68 -0
- package/dist/cjs/utils/jsonpath.js +489 -0
- package/dist/cjs/utils/qrcode.js +41 -0
- package/dist/cjs/utils/url.js +82 -0
- package/dist/cjs/utils/utf8.js +61 -0
- package/dist/cjs/utils/uuid.js +48 -0
- package/dist/cjs/utils/xml.js +57 -0
- package/dist/dts/bpm/deployer.d.ts +29 -0
- package/dist/dts/bpm/index.d.ts +8 -0
- package/dist/dts/bpm/process.d.ts +433 -0
- package/dist/dts/bpm/tasks.d.ts +2022 -0
- package/dist/dts/bpm/values.d.ts +38 -0
- package/dist/dts/cache/cache.d.ts +30 -0
- package/dist/dts/cache/index.d.ts +2 -0
- package/dist/dts/cms/cmis.d.ts +413 -0
- package/dist/dts/cms/index.d.ts +2 -0
- package/dist/dts/component/decorators.d.ts +52 -0
- package/dist/dts/component/index.d.ts +2 -0
- package/dist/dts/core/configurations.d.ts +65 -0
- package/dist/dts/core/context.d.ts +19 -0
- package/dist/dts/core/env.d.ts +23 -0
- package/dist/dts/core/globals.d.ts +30 -0
- package/dist/dts/core/index.d.ts +8 -0
- package/dist/dts/db/dao.d.ts +8 -0
- package/dist/dts/db/database.d.ts +507 -0
- package/dist/dts/db/decorators.d.ts +89 -0
- package/dist/dts/db/index.d.ts +25 -0
- package/dist/dts/db/insert.d.ts +32 -0
- package/dist/dts/db/orm.d.ts +44 -0
- package/dist/dts/db/ormstatements.d.ts +4 -0
- package/dist/dts/db/procedure.d.ts +25 -0
- package/dist/dts/db/query.d.ts +48 -0
- package/dist/dts/db/repository.d.ts +64 -0
- package/dist/dts/db/sequence.d.ts +34 -0
- package/dist/dts/db/sql.d.ts +267 -0
- package/dist/dts/db/store.d.ts +138 -0
- package/dist/dts/db/translator.d.ts +26 -0
- package/dist/dts/db/update.d.ts +21 -0
- package/dist/dts/etcd/client.d.ts +92 -0
- package/dist/dts/etcd/index.d.ts +2 -0
- package/dist/dts/extensions/decorators.d.ts +11 -0
- package/dist/dts/extensions/extensions.d.ts +41 -0
- package/dist/dts/extensions/index.d.ts +4 -0
- package/dist/dts/git/client.d.ts +478 -0
- package/dist/dts/git/index.d.ts +2 -0
- package/dist/dts/http/client-async.d.ts +158 -0
- package/dist/dts/http/client.d.ts +180 -0
- package/dist/dts/http/decorators.d.ts +11 -0
- package/dist/dts/http/errors/ForbiddenError.d.ts +20 -0
- package/dist/dts/http/errors/ValidationError.d.ts +20 -0
- package/dist/dts/http/errors.d.ts +2 -0
- package/dist/dts/http/index.d.ts +16 -0
- package/dist/dts/http/request.d.ts +158 -0
- package/dist/dts/http/response.d.ts +281 -0
- package/dist/dts/http/rs/resource-common.d.ts +11 -0
- package/dist/dts/http/rs/resource-http-controller.d.ts +43 -0
- package/dist/dts/http/rs/resource-mappings.d.ts +70 -0
- package/dist/dts/http/rs/resource-method.d.ts +206 -0
- package/dist/dts/http/rs/resource.d.ts +126 -0
- package/dist/dts/http/rs.d.ts +4 -0
- package/dist/dts/http/session.d.ts +81 -0
- package/dist/dts/http/upload.d.ts +100 -0
- package/dist/dts/http/utils.d.ts +54 -0
- package/dist/dts/index.d.ts +0 -0
- package/dist/dts/indexing/index.d.ts +4 -0
- package/dist/dts/indexing/searcher.d.ts +47 -0
- package/dist/dts/indexing/writer.d.ts +22 -0
- package/dist/dts/integrations/index.d.ts +2 -0
- package/dist/dts/integrations/integrations.d.ts +118 -0
- package/dist/dts/io/bytes.d.ts +56 -0
- package/dist/dts/io/files.d.ts +261 -0
- package/dist/dts/io/image.d.ts +22 -0
- package/dist/dts/io/index.d.ts +10 -0
- package/dist/dts/io/streams.d.ts +172 -0
- package/dist/dts/io/zip.d.ts +178 -0
- package/dist/dts/job/decorators.d.ts +11 -0
- package/dist/dts/job/index.d.ts +4 -0
- package/dist/dts/job/scheduler.d.ts +250 -0
- package/dist/dts/junit/index.d.ts +1 -0
- package/dist/dts/junit/junit.d.ts +50 -0
- package/dist/dts/kafka/consumer.d.ts +48 -0
- package/dist/dts/kafka/index.d.ts +4 -0
- package/dist/dts/kafka/producer.d.ts +50 -0
- package/dist/dts/log/index.d.ts +2 -0
- package/dist/dts/log/logging.d.ts +102 -0
- package/dist/dts/mail/client.d.ts +90 -0
- package/dist/dts/mail/index.d.ts +2 -0
- package/dist/dts/messaging/consumer.d.ts +61 -0
- package/dist/dts/messaging/decorators.d.ts +11 -0
- package/dist/dts/messaging/index.d.ts +6 -0
- package/dist/dts/messaging/producer.d.ts +59 -0
- package/dist/dts/mongodb/client.d.ts +367 -0
- package/dist/dts/mongodb/dao.d.ts +24 -0
- package/dist/dts/mongodb/index.d.ts +2 -0
- package/dist/dts/net/decorators.d.ts +11 -0
- package/dist/dts/net/index.d.ts +6 -0
- package/dist/dts/net/soap.d.ts +115 -0
- package/dist/dts/net/websockets.d.ts +100 -0
- package/dist/dts/net/wrappers/onClose.d.ts +0 -0
- package/dist/dts/net/wrappers/onError.d.ts +0 -0
- package/dist/dts/net/wrappers/onMessage.d.ts +0 -0
- package/dist/dts/net/wrappers/onOpen.d.ts +0 -0
- package/dist/dts/pdf/index.d.ts +2 -0
- package/dist/dts/pdf/pdf.d.ts +72 -0
- package/dist/dts/platform/command.d.ts +41 -0
- package/dist/dts/platform/engines.d.ts +35 -0
- package/dist/dts/platform/index.d.ts +16 -0
- package/dist/dts/platform/lifecycle.d.ts +22 -0
- package/dist/dts/platform/os.d.ts +23 -0
- package/dist/dts/platform/problems.d.ts +114 -0
- package/dist/dts/platform/registry.d.ts +227 -0
- package/dist/dts/platform/repository.d.ts +354 -0
- package/dist/dts/platform/workspace.d.ts +421 -0
- package/dist/dts/qldb/index.d.ts +2 -0
- package/dist/dts/qldb/qldb.d.ts +1 -0
- package/dist/dts/rabbitmq/consumer.d.ts +25 -0
- package/dist/dts/rabbitmq/index.d.ts +4 -0
- package/dist/dts/rabbitmq/producer.d.ts +15 -0
- package/dist/dts/redis/client.d.ts +134 -0
- package/dist/dts/redis/index.d.ts +2 -0
- package/dist/dts/security/decorators.d.ts +4 -0
- package/dist/dts/security/index.d.ts +5 -0
- package/dist/dts/security/oauth.d.ts +39 -0
- package/dist/dts/security/user.d.ts +51 -0
- package/dist/dts/template/engines.d.ts +98 -0
- package/dist/dts/template/index.d.ts +2 -0
- package/dist/dts/utils/alphanumeric.d.ts +39 -0
- package/dist/dts/utils/base64.d.ts +48 -0
- package/dist/dts/utils/converter.d.ts +44 -0
- package/dist/dts/utils/digest.d.ts +50 -0
- package/dist/dts/utils/escape.d.ts +110 -0
- package/dist/dts/utils/hex.d.ts +48 -0
- package/dist/dts/utils/index.d.ts +23 -0
- package/dist/dts/utils/jsonpath.d.ts +22 -0
- package/dist/dts/utils/qrcode.d.ts +16 -0
- package/dist/dts/utils/url.d.ts +50 -0
- package/dist/dts/utils/utf8.d.ts +33 -0
- package/dist/dts/utils/uuid.d.ts +21 -0
- package/dist/dts/utils/xml.d.ts +22 -0
- package/dist/esm/bpm/deployer.mjs +38 -0
- package/dist/esm/bpm/index.mjs +15 -0
- package/dist/esm/bpm/process.mjs +617 -0
- package/dist/esm/bpm/tasks.mjs +954 -0
- package/dist/esm/bpm/values.mjs +63 -0
- package/dist/esm/cache/cache.mjs +45 -0
- package/dist/esm/cache/index.mjs +6 -0
- package/dist/esm/cms/cmis.mjs +660 -0
- package/dist/esm/cms/index.mjs +6 -0
- package/dist/esm/component/decorators.mjs +107 -0
- package/dist/esm/component/index.mjs +6 -0
- package/dist/esm/core/configurations.mjs +91 -0
- package/dist/esm/core/context.mjs +28 -0
- package/dist/esm/core/env.mjs +26 -0
- package/dist/esm/core/globals.mjs +35 -0
- package/dist/esm/core/index.mjs +15 -0
- package/dist/esm/db/dao.mjs +775 -0
- package/dist/esm/db/database.mjs +885 -0
- package/dist/esm/db/decorators.mjs +148 -0
- package/dist/esm/db/index.mjs +42 -0
- package/dist/esm/db/insert.mjs +32 -0
- package/dist/esm/db/orm.mjs +225 -0
- package/dist/esm/db/ormstatements.mjs +223 -0
- package/dist/esm/db/procedure.mjs +93 -0
- package/dist/esm/db/query.mjs +38 -0
- package/dist/esm/db/repository.mjs +129 -0
- package/dist/esm/db/sequence.mjs +40 -0
- package/dist/esm/db/sql.mjs +497 -0
- package/dist/esm/db/store.mjs +153 -0
- package/dist/esm/db/translator.mjs +81 -0
- package/dist/esm/db/update.mjs +24 -0
- package/dist/esm/etcd/client.mjs +155 -0
- package/dist/esm/etcd/index.mjs +6 -0
- package/dist/esm/extensions/decorators.mjs +21 -0
- package/dist/esm/extensions/extensions.mjs +89 -0
- package/dist/esm/extensions/index.mjs +9 -0
- package/dist/esm/git/client.mjs +258 -0
- package/dist/esm/git/index.mjs +6 -0
- package/dist/esm/http/client-async.mjs +205 -0
- package/dist/esm/http/client.mjs +126 -0
- package/dist/esm/http/decorators.mjs +47 -0
- package/dist/esm/http/errors/ForbiddenError.mjs +22 -0
- package/dist/esm/http/errors/ValidationError.mjs +22 -0
- package/dist/esm/http/errors.mjs +7 -0
- package/dist/esm/http/index.mjs +29 -0
- package/dist/esm/http/request.mjs +262 -0
- package/dist/esm/http/response.mjs +433 -0
- package/dist/esm/http/rs/resource-common.mjs +13 -0
- package/dist/esm/http/rs/resource-http-controller.mjs +287 -0
- package/dist/esm/http/rs/resource-mappings.mjs +111 -0
- package/dist/esm/http/rs/resource-method.mjs +199 -0
- package/dist/esm/http/rs/resource.mjs +213 -0
- package/dist/esm/http/rs.mjs +12 -0
- package/dist/esm/http/session.mjs +105 -0
- package/dist/esm/http/upload.mjs +125 -0
- package/dist/esm/http/utils.mjs +87 -0
- package/dist/esm/index.mjs +1 -0
- package/dist/esm/indexing/index.mjs +9 -0
- package/dist/esm/indexing/searcher.mjs +51 -0
- package/dist/esm/indexing/writer.mjs +26 -0
- package/dist/esm/integrations/index.mjs +6 -0
- package/dist/esm/integrations/integrations.mjs +36 -0
- package/dist/esm/io/bytes.mjs +82 -0
- package/dist/esm/io/files.mjs +325 -0
- package/dist/esm/io/image.mjs +24 -0
- package/dist/esm/io/index.mjs +18 -0
- package/dist/esm/io/streams.mjs +224 -0
- package/dist/esm/io/zip.mjs +232 -0
- package/dist/esm/job/decorators.mjs +21 -0
- package/dist/esm/job/index.mjs +9 -0
- package/dist/esm/job/scheduler.mjs +328 -0
- package/dist/esm/junit/index.mjs +2 -0
- package/dist/esm/junit/junit.mjs +48 -0
- package/dist/esm/kafka/consumer.mjs +51 -0
- package/dist/esm/kafka/index.mjs +9 -0
- package/dist/esm/kafka/producer.mjs +51 -0
- package/dist/esm/log/index.mjs +6 -0
- package/dist/esm/log/logging.mjs +155 -0
- package/dist/esm/mail/client.mjs +134 -0
- package/dist/esm/mail/index.mjs +6 -0
- package/dist/esm/messaging/consumer.mjs +64 -0
- package/dist/esm/messaging/decorators.mjs +21 -0
- package/dist/esm/messaging/index.mjs +12 -0
- package/dist/esm/messaging/producer.mjs +62 -0
- package/dist/esm/mongodb/client.mjs +608 -0
- package/dist/esm/mongodb/dao.mjs +360 -0
- package/dist/esm/mongodb/index.mjs +7 -0
- package/dist/esm/net/decorators.mjs +21 -0
- package/dist/esm/net/index.mjs +12 -0
- package/dist/esm/net/soap.mjs +209 -0
- package/dist/esm/net/websockets.mjs +132 -0
- package/dist/esm/net/wrappers/onClose.mjs +2 -0
- package/dist/esm/net/wrappers/onError.mjs +2 -0
- package/dist/esm/net/wrappers/onMessage.mjs +2 -0
- package/dist/esm/net/wrappers/onOpen.mjs +2 -0
- package/dist/esm/pdf/index.mjs +6 -0
- package/dist/esm/pdf/pdf.mjs +141 -0
- package/dist/esm/platform/command.mjs +28 -0
- package/dist/esm/platform/engines.mjs +51 -0
- package/dist/esm/platform/index.mjs +27 -0
- package/dist/esm/platform/lifecycle.mjs +30 -0
- package/dist/esm/platform/os.mjs +32 -0
- package/dist/esm/platform/problems.mjs +108 -0
- package/dist/esm/platform/registry.mjs +300 -0
- package/dist/esm/platform/repository.mjs +479 -0
- package/dist/esm/platform/workspace.mjs +555 -0
- package/dist/esm/qldb/index.mjs +6 -0
- package/dist/esm/qldb/qldb.mjs +5 -0
- package/dist/esm/rabbitmq/consumer.mjs +31 -0
- package/dist/esm/rabbitmq/index.mjs +9 -0
- package/dist/esm/rabbitmq/producer.mjs +19 -0
- package/dist/esm/redis/client.mjs +171 -0
- package/dist/esm/redis/index.mjs +6 -0
- package/dist/esm/security/decorators.mjs +29 -0
- package/dist/esm/security/index.mjs +10 -0
- package/dist/esm/security/oauth.mjs +56 -0
- package/dist/esm/security/user.mjs +69 -0
- package/dist/esm/template/engines.mjs +120 -0
- package/dist/esm/template/index.mjs +6 -0
- package/dist/esm/utils/alphanumeric.mjs +88 -0
- package/dist/esm/utils/base64.mjs +85 -0
- package/dist/esm/utils/converter.mjs +59 -0
- package/dist/esm/utils/digest.mjs +148 -0
- package/dist/esm/utils/escape.mjs +141 -0
- package/dist/esm/utils/hex.mjs +85 -0
- package/dist/esm/utils/index.mjs +38 -0
- package/dist/esm/utils/jsonpath.mjs +470 -0
- package/dist/esm/utils/qrcode.mjs +22 -0
- package/dist/esm/utils/url.mjs +63 -0
- package/dist/esm/utils/utf8.mjs +42 -0
- package/dist/esm/utils/uuid.mjs +29 -0
- package/dist/esm/utils/xml.mjs +38 -0
- package/package.json +58 -0
|
@@ -0,0 +1,2022 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* API Tasks
|
|
3
|
+
*/
|
|
4
|
+
export declare class Tasks {
|
|
5
|
+
static list(): TaskData[];
|
|
6
|
+
static getVariable(taskId: string, variableName: string): any;
|
|
7
|
+
/**
|
|
8
|
+
* Returns all variables. This will include all variables of parent scopes too.
|
|
9
|
+
*/
|
|
10
|
+
static getVariables(taskId: string): Map<string, any>;
|
|
11
|
+
static setVariable(taskId: string, variableName: string, value: any): void;
|
|
12
|
+
static setVariables(taskId: string, variables: Map<string, any>): void;
|
|
13
|
+
static complete(taskId: string, variables?: {
|
|
14
|
+
[key: string]: any;
|
|
15
|
+
}): void;
|
|
16
|
+
static getTaskService(): TaskService;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Service which provides access to {@link Task} and form related operations.
|
|
20
|
+
*
|
|
21
|
+
*/
|
|
22
|
+
export declare class TaskService {
|
|
23
|
+
private readonly taskService;
|
|
24
|
+
constructor(taskService: any);
|
|
25
|
+
/**
|
|
26
|
+
* Creates a new task that is not related to any process instance.
|
|
27
|
+
*
|
|
28
|
+
* The returned task is transient and must be saved with {@link #saveTask(Task)} 'manually'.
|
|
29
|
+
*/
|
|
30
|
+
newTask(taskId?: string): Task;
|
|
31
|
+
/**
|
|
32
|
+
* Create a builder for the task
|
|
33
|
+
*
|
|
34
|
+
* @return task builder
|
|
35
|
+
*/
|
|
36
|
+
createTaskBuilder(): TaskBuilder;
|
|
37
|
+
/**
|
|
38
|
+
* Saves the given task to the persistent data store. If the task is already present in the persistent store, it is updated. After a new task has been saved, the task instance passed into this
|
|
39
|
+
* method is updated with the id of the newly created task.
|
|
40
|
+
*
|
|
41
|
+
* @param task
|
|
42
|
+
* the task, cannot be null.
|
|
43
|
+
*/
|
|
44
|
+
saveTask(task: Task): void;
|
|
45
|
+
/**
|
|
46
|
+
* Saves the given tasks to the persistent data store. If the tasks are already present in the persistent store, it is updated. After a new task has been saved, the task instance passed into this
|
|
47
|
+
* method is updated with the id of the newly created task.
|
|
48
|
+
*
|
|
49
|
+
* @param taskList the list of task instances, cannot be null.
|
|
50
|
+
*/
|
|
51
|
+
bulkSaveTasks(taskList: Task[]): void;
|
|
52
|
+
/**
|
|
53
|
+
* Deletes the given task, not deleting historic information that is related to this task.
|
|
54
|
+
*
|
|
55
|
+
* @param taskId
|
|
56
|
+
* The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.
|
|
57
|
+
* @param cascade
|
|
58
|
+
* If cascade is true, also the historic information related to this task is deleted.
|
|
59
|
+
* @throws FlowableObjectNotFoundException
|
|
60
|
+
* when the task with given id does not exist.
|
|
61
|
+
* @throws FlowableException
|
|
62
|
+
* when an error occurs while deleting the task or in case the task is part of a running process.
|
|
63
|
+
*/
|
|
64
|
+
deleteTask(taskId: string, cascade?: boolean): void;
|
|
65
|
+
/**
|
|
66
|
+
* Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.
|
|
67
|
+
*
|
|
68
|
+
* @param taskIds
|
|
69
|
+
* The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.
|
|
70
|
+
* @param cascade
|
|
71
|
+
* If cascade is true, also the historic information related to this task is deleted.
|
|
72
|
+
* @throws FlowableObjectNotFoundException
|
|
73
|
+
* when one of the task does not exist.
|
|
74
|
+
* @throws FlowableException
|
|
75
|
+
* when an error occurs while deleting the tasks or in case one of the tasks is part of a running process.
|
|
76
|
+
*/
|
|
77
|
+
deleteTasks(taskIds: string[], cascade?: boolean): void;
|
|
78
|
+
/**
|
|
79
|
+
* Deletes the given task, not deleting historic information that is related to this task..
|
|
80
|
+
*
|
|
81
|
+
* @param taskId
|
|
82
|
+
* The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.
|
|
83
|
+
* @param deleteReason
|
|
84
|
+
* reason the task is deleted. Is recorded in history, if enabled.
|
|
85
|
+
* @throws FlowableObjectNotFoundException
|
|
86
|
+
* when the task with given id does not exist.
|
|
87
|
+
* @throws FlowableException
|
|
88
|
+
* when an error occurs while deleting the task or in case the task is part of a running process
|
|
89
|
+
*/
|
|
90
|
+
deleteTaskWithReason(taskId: string, deleteReason: string): void;
|
|
91
|
+
/**
|
|
92
|
+
* Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.
|
|
93
|
+
*
|
|
94
|
+
* @param taskIds
|
|
95
|
+
* The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.
|
|
96
|
+
* @param deleteReason
|
|
97
|
+
* reason the task is deleted. Is recorded in history, if enabled.
|
|
98
|
+
* @throws FlowableObjectNotFoundException
|
|
99
|
+
* when one of the tasks does not exist.
|
|
100
|
+
* @throws FlowableException
|
|
101
|
+
* when an error occurs while deleting the tasks or in case one of the tasks is part of a running process.
|
|
102
|
+
*/
|
|
103
|
+
deleteTasksWithReason(taskIds: string[], deleteReason: string): void;
|
|
104
|
+
/**
|
|
105
|
+
* Claim responsibility for a task: the given user is made assignee for the task. The difference with {@link #setAssignee(String, String)} is that here a check is done if the task already has a
|
|
106
|
+
* user assigned to it. No check is done whether the user is known by the identity component.
|
|
107
|
+
*
|
|
108
|
+
* @param taskId
|
|
109
|
+
* task to claim, cannot be null.
|
|
110
|
+
* @param userId
|
|
111
|
+
* user that claims the task. When userId is null the task is unclaimed, assigned to no one.
|
|
112
|
+
* @throws FlowableObjectNotFoundException
|
|
113
|
+
* when the task doesn't exist.
|
|
114
|
+
* @throws org.flowable.common.engine.api.FlowableTaskAlreadyClaimedException
|
|
115
|
+
* when the task is already claimed by another user
|
|
116
|
+
*/
|
|
117
|
+
claim(taskId: string, userId: string): void;
|
|
118
|
+
/**
|
|
119
|
+
* A shortcut to {@link #claim} with null user in order to unclaim the task
|
|
120
|
+
*
|
|
121
|
+
* @param taskId
|
|
122
|
+
* task to unclaim, cannot be null.
|
|
123
|
+
* @throws FlowableObjectNotFoundException
|
|
124
|
+
* when the task doesn't exist.
|
|
125
|
+
*/
|
|
126
|
+
unclaim(taskId: string): void;
|
|
127
|
+
/**
|
|
128
|
+
* Set the task state to in progress. No check is done whether the user is known by the identity component.
|
|
129
|
+
*
|
|
130
|
+
* @param taskId
|
|
131
|
+
* task to change the state, cannot be null.
|
|
132
|
+
* @param userId
|
|
133
|
+
* user that puts the task in progress.
|
|
134
|
+
* @throws FlowableObjectNotFoundException
|
|
135
|
+
* when the task doesn't exist.
|
|
136
|
+
*/
|
|
137
|
+
startProgress(taskId: string, userId: string): void;
|
|
138
|
+
/**
|
|
139
|
+
* Suspends the task. No check is done whether the user is known by the identity component.
|
|
140
|
+
*
|
|
141
|
+
* @param taskId
|
|
142
|
+
* task to suspend, cannot be null.
|
|
143
|
+
* @param userId
|
|
144
|
+
* user that suspends the task.
|
|
145
|
+
* @throws FlowableObjectNotFoundException
|
|
146
|
+
* when the task doesn't exist.
|
|
147
|
+
*/
|
|
148
|
+
suspendTask(taskId: string, userId: string): void;
|
|
149
|
+
/**
|
|
150
|
+
* Activates the task. No check is done whether the user is known by the identity component.
|
|
151
|
+
*
|
|
152
|
+
* @param taskId
|
|
153
|
+
* task to activate, cannot be null.
|
|
154
|
+
* @param userId
|
|
155
|
+
* user that activates the task.
|
|
156
|
+
* @throws FlowableObjectNotFoundException
|
|
157
|
+
* when the task doesn't exist.
|
|
158
|
+
*/
|
|
159
|
+
activateTask(taskId: string, userId: string): void;
|
|
160
|
+
/**
|
|
161
|
+
* Delegates the task to another user. This means that the assignee is set and the delegation state is set to {@link DelegationState#PENDING}. If no owner is set on the task, the owner is set to
|
|
162
|
+
* the current assignee of the task.
|
|
163
|
+
*
|
|
164
|
+
* @param taskId
|
|
165
|
+
* The id of the task that will be delegated.
|
|
166
|
+
* @param userId
|
|
167
|
+
* The id of the user that will be set as assignee.
|
|
168
|
+
* @throws FlowableObjectNotFoundException
|
|
169
|
+
* when no task exists with the given id.
|
|
170
|
+
*/
|
|
171
|
+
delegateTask(taskId: string, userId: string): void;
|
|
172
|
+
/**
|
|
173
|
+
* Marks that the assignee is done with this task and that it can be send back to the owner. Can only be called when this task is {@link DelegationState#PENDING} delegation. After this method
|
|
174
|
+
* returns, the {@link Task#getDelegationState() delegationState} is set to {@link DelegationState#RESOLVED}.
|
|
175
|
+
*
|
|
176
|
+
* @param taskId
|
|
177
|
+
* the id of the task to resolve, cannot be null.
|
|
178
|
+
* @param variables
|
|
179
|
+
* @param transientVariables
|
|
180
|
+
* @throws FlowableObjectNotFoundException
|
|
181
|
+
* when no task exists with the given id.
|
|
182
|
+
*/
|
|
183
|
+
resolveTask(taskId: string, variables?: Map<string, any>, transientVariables?: Map<string, any>): void;
|
|
184
|
+
/**
|
|
185
|
+
* Called when the task is successfully executed.
|
|
186
|
+
*
|
|
187
|
+
* @param taskId
|
|
188
|
+
* the id of the task to complete, cannot be null.
|
|
189
|
+
* @param userId
|
|
190
|
+
* user that completes the task.
|
|
191
|
+
* @param variables
|
|
192
|
+
* task parameters. May be null or empty.
|
|
193
|
+
* @param transientVariables
|
|
194
|
+
* task parameters. May be null or empty.
|
|
195
|
+
* @param localScope
|
|
196
|
+
* If true, the provided variables will be stored task-local, instead of process instance wide (which is the default behaviour).
|
|
197
|
+
* @throws FlowableObjectNotFoundException
|
|
198
|
+
* when no task exists with the given id.
|
|
199
|
+
* @throws FlowableException
|
|
200
|
+
* when this task is {@link DelegationState#PENDING} delegation.
|
|
201
|
+
*/
|
|
202
|
+
complete(taskId: string, userId?: string, variables?: Map<string, any>, transientVariables?: Map<string, any>, localScope?: boolean): void;
|
|
203
|
+
/**
|
|
204
|
+
* Called when the task is successfully executed, and the task form has been submitted.
|
|
205
|
+
*
|
|
206
|
+
* @param taskId
|
|
207
|
+
* the id of the task to complete, cannot be null.
|
|
208
|
+
* @param formDefinitionId
|
|
209
|
+
* the id of the form definition that is filled-in to complete the task, cannot be null.
|
|
210
|
+
* @param outcome
|
|
211
|
+
* the outcome of the completed form, can be null.
|
|
212
|
+
* @param variables
|
|
213
|
+
* values of the completed form. May be null or empty.
|
|
214
|
+
* @param userId
|
|
215
|
+
* user that completes the task.
|
|
216
|
+
* @param transientVariables
|
|
217
|
+
* additional transient values that need to added to the process instance transient variables. May be null or empty.
|
|
218
|
+
* @param localScope
|
|
219
|
+
* If true, the provided variables will be stored task-local, instead of process instance wide (which is the default for {@link #complete(String, Map)}).
|
|
220
|
+
* @throws FlowableObjectNotFoundException
|
|
221
|
+
* when no task exists with the given id.
|
|
222
|
+
*/
|
|
223
|
+
completeTaskWithForm(taskId: string, formDefinitionId: string, outcome: string, variables: Map<String, any>, userId?: string, transientVariables?: Map<String, any>, localScope?: boolean): void;
|
|
224
|
+
/**
|
|
225
|
+
* Gets a Form model instance of the task form of a specific task
|
|
226
|
+
*
|
|
227
|
+
* @param taskId
|
|
228
|
+
* id of the task, cannot be null.
|
|
229
|
+
* @param ignoreVariables
|
|
230
|
+
* should the variables be ignored when fetching the form model?
|
|
231
|
+
* @throws FlowableObjectNotFoundException
|
|
232
|
+
* when the task or form definition doesn't exist.
|
|
233
|
+
*/
|
|
234
|
+
getTaskFormModel(taskId: string, ignoreVariables?: boolean): FormInfo;
|
|
235
|
+
/**
|
|
236
|
+
* Changes the assignee of the given task to the given userId. No check is done whether the user is known by the identity component.
|
|
237
|
+
*
|
|
238
|
+
* @param taskId
|
|
239
|
+
* id of the task, cannot be null.
|
|
240
|
+
* @param userId
|
|
241
|
+
* id of the user to use as assignee.
|
|
242
|
+
* @throws FlowableObjectNotFoundException
|
|
243
|
+
* when the task or user doesn't exist.
|
|
244
|
+
*/
|
|
245
|
+
setAssignee(taskId: string, userId: string): void;
|
|
246
|
+
/**
|
|
247
|
+
* Transfers ownership of this task to another user. No check is done whether the user is known by the identity component.
|
|
248
|
+
*
|
|
249
|
+
* @param taskId
|
|
250
|
+
* id of the task, cannot be null.
|
|
251
|
+
* @param userId
|
|
252
|
+
* of the person that is receiving ownership.
|
|
253
|
+
* @throws FlowableObjectNotFoundException
|
|
254
|
+
* when the task or user doesn't exist.
|
|
255
|
+
*/
|
|
256
|
+
setOwner(taskId: string, userId: string): void;
|
|
257
|
+
/**
|
|
258
|
+
* Retrieves the {@link IdentityLink}s associated with the given task. Such an {@link IdentityLink} informs how a certain identity (eg. group or user) is associated with a certain task (eg. as
|
|
259
|
+
* candidate, assignee, etc.)
|
|
260
|
+
*/
|
|
261
|
+
getIdentityLinksForTask(taskId: string): IdentityLink[];
|
|
262
|
+
/**
|
|
263
|
+
* Convenience shorthand for {@link #addUserIdentityLink(String, String, String)}; with type {@link IdentityLinkType#CANDIDATE}
|
|
264
|
+
*
|
|
265
|
+
* @param taskId
|
|
266
|
+
* id of the task, cannot be null.
|
|
267
|
+
* @param userId
|
|
268
|
+
* id of the user to use as candidate, cannot be null.
|
|
269
|
+
* @throws FlowableObjectNotFoundException
|
|
270
|
+
* when the task or user doesn't exist.
|
|
271
|
+
*/
|
|
272
|
+
addCandidateUser(taskId: string, userId: string): void;
|
|
273
|
+
/**
|
|
274
|
+
* Convenience shorthand for {@link #addGroupIdentityLink(String, String, String)}; with type {@link IdentityLinkType#CANDIDATE}
|
|
275
|
+
*
|
|
276
|
+
* @param taskId
|
|
277
|
+
* id of the task, cannot be null.
|
|
278
|
+
* @param groupId
|
|
279
|
+
* id of the group to use as candidate, cannot be null.
|
|
280
|
+
* @throws FlowableObjectNotFoundException
|
|
281
|
+
* when the task or group doesn't exist.
|
|
282
|
+
*/
|
|
283
|
+
addCandidateGroup(taskId: string, groupId: string): void;
|
|
284
|
+
/**
|
|
285
|
+
* Involves a user with a task. The type of identity link is defined by the given identityLinkType.
|
|
286
|
+
*
|
|
287
|
+
* @param taskId
|
|
288
|
+
* id of the task, cannot be null.
|
|
289
|
+
* @param userId
|
|
290
|
+
* id of the user involve, cannot be null.
|
|
291
|
+
* @param identityLinkType
|
|
292
|
+
* type of identityLink, cannot be null (@see {@link IdentityLinkType}).
|
|
293
|
+
* @throws FlowableObjectNotFoundException
|
|
294
|
+
* when the task or user doesn't exist.
|
|
295
|
+
*/
|
|
296
|
+
addUserIdentityLink(taskId: string, userId: string, identityLinkType: string): void;
|
|
297
|
+
/**
|
|
298
|
+
* Involves a group with a task. The type of identityLink is defined by the given identityLink.
|
|
299
|
+
*
|
|
300
|
+
* @param taskId
|
|
301
|
+
* id of the task, cannot be null.
|
|
302
|
+
* @param groupId
|
|
303
|
+
* id of the group to involve, cannot be null.
|
|
304
|
+
* @param identityLinkType
|
|
305
|
+
* type of identity, cannot be null (@see {@link IdentityLinkType}).
|
|
306
|
+
* @throws FlowableObjectNotFoundException
|
|
307
|
+
* when the task or group doesn't exist.
|
|
308
|
+
*/
|
|
309
|
+
addGroupIdentityLink(taskId: string, groupId: string, identityLinkType: string): void;
|
|
310
|
+
/**
|
|
311
|
+
* Convenience shorthand for {@link #deleteUserIdentityLink(String, String, String)}; with type {@link IdentityLinkType#CANDIDATE}
|
|
312
|
+
*
|
|
313
|
+
* @param taskId
|
|
314
|
+
* id of the task, cannot be null.
|
|
315
|
+
* @param userId
|
|
316
|
+
* id of the user to use as candidate, cannot be null.
|
|
317
|
+
* @throws FlowableObjectNotFoundException
|
|
318
|
+
* when the task or user doesn't exist.
|
|
319
|
+
*/
|
|
320
|
+
deleteCandidateUser(taskId: string, userId: string): void;
|
|
321
|
+
/**
|
|
322
|
+
* Convenience shorthand for {@link #deleteGroupIdentityLink(String, String, String)}; with type {@link IdentityLinkType#CANDIDATE}
|
|
323
|
+
*
|
|
324
|
+
* @param taskId
|
|
325
|
+
* id of the task, cannot be null.
|
|
326
|
+
* @param groupId
|
|
327
|
+
* id of the group to use as candidate, cannot be null.
|
|
328
|
+
* @throws FlowableObjectNotFoundException
|
|
329
|
+
* when the task or group doesn't exist.
|
|
330
|
+
*/
|
|
331
|
+
deleteCandidateGroup(taskId: string, groupId: string): void;
|
|
332
|
+
/**
|
|
333
|
+
* Removes the association between a user and a task for the given identityLinkType.
|
|
334
|
+
*
|
|
335
|
+
* @param taskId
|
|
336
|
+
* id of the task, cannot be null.
|
|
337
|
+
* @param userId
|
|
338
|
+
* id of the user involve, cannot be null.
|
|
339
|
+
* @param identityLinkType
|
|
340
|
+
* type of identityLink, cannot be null (@see {@link IdentityLinkType}).
|
|
341
|
+
* @throws FlowableObjectNotFoundException
|
|
342
|
+
* when the task or user doesn't exist.
|
|
343
|
+
*/
|
|
344
|
+
deleteUserIdentityLink(taskId: string, userId: string, identityLinkType: string): void;
|
|
345
|
+
/**
|
|
346
|
+
* Removes the association between a group and a task for the given identityLinkType.
|
|
347
|
+
*
|
|
348
|
+
* @param taskId
|
|
349
|
+
* id of the task, cannot be null.
|
|
350
|
+
* @param groupId
|
|
351
|
+
* id of the group to involve, cannot be null.
|
|
352
|
+
* @param identityLinkType
|
|
353
|
+
* type of identity, cannot be null (@see {@link IdentityLinkType}).
|
|
354
|
+
* @throws FlowableObjectNotFoundException
|
|
355
|
+
* when the task or group doesn't exist.
|
|
356
|
+
*/
|
|
357
|
+
deleteGroupIdentityLink(taskId: string, groupId: string, identityLinkType: string): void;
|
|
358
|
+
/**
|
|
359
|
+
* Changes the priority of the task.
|
|
360
|
+
*
|
|
361
|
+
* Authorization: actual owner / business admin
|
|
362
|
+
*
|
|
363
|
+
* @param taskId
|
|
364
|
+
* id of the task, cannot be null.
|
|
365
|
+
* @param priority
|
|
366
|
+
* the new priority for the task.
|
|
367
|
+
* @throws FlowableObjectNotFoundException
|
|
368
|
+
* when the task doesn't exist.
|
|
369
|
+
*/
|
|
370
|
+
setPriority(taskId: string, priority: number): void;
|
|
371
|
+
/**
|
|
372
|
+
* Changes the due date of the task
|
|
373
|
+
*
|
|
374
|
+
* @param taskId
|
|
375
|
+
* id of the task, cannot be null.
|
|
376
|
+
* @param dueDate
|
|
377
|
+
* the new due date for the task
|
|
378
|
+
* @throws FlowableException
|
|
379
|
+
* when the task doesn't exist.
|
|
380
|
+
*/
|
|
381
|
+
setDueDate(taskId: string, dueDate: Date): void;
|
|
382
|
+
/**
|
|
383
|
+
* set variable on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.
|
|
384
|
+
*/
|
|
385
|
+
setVariable(taskId: string, variableName: string, value: any): void;
|
|
386
|
+
/**
|
|
387
|
+
* set variables on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.
|
|
388
|
+
*/
|
|
389
|
+
setVariables(taskId: string, variables: Map<string, any>): void;
|
|
390
|
+
/**
|
|
391
|
+
* set variable on a task. If the variable is not already existing, it will be created in the task.
|
|
392
|
+
*/
|
|
393
|
+
setVariableLocal(taskId: string, variableName: string, value: any): void;
|
|
394
|
+
/**
|
|
395
|
+
* set variables on a task. If the variable is not already existing, it will be created in the task.
|
|
396
|
+
*/
|
|
397
|
+
setVariablesLocal(taskId: string, variables: Map<string, any>): void;
|
|
398
|
+
/**
|
|
399
|
+
* get a variables and search in the task scope and if available also the execution scopes.
|
|
400
|
+
*/
|
|
401
|
+
getVariable(taskId: string, variableName: string): any;
|
|
402
|
+
/**
|
|
403
|
+
* The variable. Searching for the variable is done in all scopes that are visible to the given task (including parent scopes). Returns null when no variable value is found with the given name.
|
|
404
|
+
*
|
|
405
|
+
* @param taskId
|
|
406
|
+
* id of task, cannot be null.
|
|
407
|
+
* @param variableName
|
|
408
|
+
* name of variable, cannot be null.
|
|
409
|
+
* @return the variable or null if the variable is undefined.
|
|
410
|
+
* @throws FlowableObjectNotFoundException
|
|
411
|
+
* when no execution is found for the given taskId.
|
|
412
|
+
*/
|
|
413
|
+
getVariableInstance(taskId: string, variableName: string): VariableInstance;
|
|
414
|
+
/**
|
|
415
|
+
* checks whether or not the task has a variable defined with the given name, in the task scope and if available also the execution scopes.
|
|
416
|
+
*/
|
|
417
|
+
hasVariable(taskId: string, variableName: string): boolean;
|
|
418
|
+
/**
|
|
419
|
+
* checks whether or not the task has a variable defined with the given name.
|
|
420
|
+
*/
|
|
421
|
+
getVariableLocal(taskId: string, variableName: string): any;
|
|
422
|
+
/**
|
|
423
|
+
* The variable for a task. Returns the variable when it is set for the task (and not searching parent scopes). Returns null when no variable is found with the given name.
|
|
424
|
+
*
|
|
425
|
+
* @param taskId
|
|
426
|
+
* id of task, cannot be null.
|
|
427
|
+
* @param variableName
|
|
428
|
+
* name of variable, cannot be null.
|
|
429
|
+
* @return the variable or null if the variable is undefined.
|
|
430
|
+
* @throws FlowableObjectNotFoundException
|
|
431
|
+
* when no task is found for the given taskId.
|
|
432
|
+
*/
|
|
433
|
+
getVariableInstanceLocal(taskId: string, variableName: string): VariableInstance;
|
|
434
|
+
/**
|
|
435
|
+
* checks whether or not the task has a variable defined with the given name, local task scope only.
|
|
436
|
+
*/
|
|
437
|
+
hasVariableLocal(taskId: string, variableName: string): boolean;
|
|
438
|
+
/**
|
|
439
|
+
* get all variables and search in the task scope and if available also the execution scopes. If you have many variables and you only need a few, consider using
|
|
440
|
+
* {@link #getVariables(String, Collection)} for better performance.
|
|
441
|
+
*/
|
|
442
|
+
getVariables(taskId: string, variableNames?: string[]): Map<string, any>;
|
|
443
|
+
/**
|
|
444
|
+
* All variables visible from the given task scope (including parent scopes).
|
|
445
|
+
*
|
|
446
|
+
* @param taskId
|
|
447
|
+
* id of task, cannot be null.
|
|
448
|
+
* @param variableNames
|
|
449
|
+
* the collection of variable names that should be retrieved.
|
|
450
|
+
* @return the variable instances or an empty map if no such variables are found.
|
|
451
|
+
* @throws FlowableObjectNotFoundException
|
|
452
|
+
* when no task is found for the given taskId.
|
|
453
|
+
*/
|
|
454
|
+
getVariableInstances(taskId: string, variableNames?: string[]): Map<string, VariableInstance>;
|
|
455
|
+
/**
|
|
456
|
+
* get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider using {@link #getVariablesLocal(String, Collection)} for better
|
|
457
|
+
* performance.
|
|
458
|
+
*/
|
|
459
|
+
getVariablesLocal(taskId: string, variableNames?: string[]): Map<string, any>;
|
|
460
|
+
/** get all variables and search only in the task scope. */
|
|
461
|
+
getVariableInstancesLocalByTaskIds(taskIds: Set<string>): VariableInstance[];
|
|
462
|
+
/**
|
|
463
|
+
* All variable values that are defined in the task scope, without taking outer scopes into account. If you have many task local variables and you only need a few, consider using
|
|
464
|
+
* {@link #getVariableInstancesLocal(String, Collection)} for better performance.
|
|
465
|
+
*
|
|
466
|
+
* @param taskId
|
|
467
|
+
* id of task, cannot be null.
|
|
468
|
+
* @return the variables or an empty map if no such variables are found.
|
|
469
|
+
* @throws FlowableObjectNotFoundException
|
|
470
|
+
* when no task is found for the given taskId.
|
|
471
|
+
*/
|
|
472
|
+
getVariableInstancesLocal(taskId: string, variableNames?: string[]): Map<string, VariableInstance>;
|
|
473
|
+
/**
|
|
474
|
+
* Removes the variable from the task. When the variable does not exist, nothing happens.
|
|
475
|
+
*/
|
|
476
|
+
removeVariable(taskId: string, variableName: string): void;
|
|
477
|
+
/**
|
|
478
|
+
* Removes the variable from the task (not considering parent scopes). When the variable does not exist, nothing happens.
|
|
479
|
+
*/
|
|
480
|
+
removeVariableLocal(taskId: string, variableName: string): void;
|
|
481
|
+
/**
|
|
482
|
+
* Removes all variables in the given collection from the task. Non existing variable names are simply ignored.
|
|
483
|
+
*/
|
|
484
|
+
removeVariables(taskId: string, variableNames: string[]): void;
|
|
485
|
+
/**
|
|
486
|
+
* Removes all variables in the given collection from the task (not considering parent scopes). Non existing variable names are simply ignored.
|
|
487
|
+
*/
|
|
488
|
+
removeVariablesLocal(taskId: string, variableNames: string[]): void;
|
|
489
|
+
/**
|
|
490
|
+
* All DataObjects visible from the given execution scope (including parent scopes).
|
|
491
|
+
*
|
|
492
|
+
* @param taskId
|
|
493
|
+
* id of task, cannot be null.
|
|
494
|
+
* @param dataObjectNames
|
|
495
|
+
* the collection of DataObject names that should be retrieved.
|
|
496
|
+
* @param locale
|
|
497
|
+
* locale the DataObject name and description should be returned in (if available).
|
|
498
|
+
* @param withLocalizationFallback
|
|
499
|
+
* When true localization will fallback to more general locales if the specified locale is not found.
|
|
500
|
+
* @return the DataObjects or an empty map if no such variables are found.
|
|
501
|
+
* @throws FlowableObjectNotFoundException
|
|
502
|
+
* when no task is found for the given taskId.
|
|
503
|
+
*/
|
|
504
|
+
getDataObjects(taskId: string, dataObjectNames?: string[], locale?: string, withLocalizationFallback?: boolean): Map<string, DataObject>;
|
|
505
|
+
/**
|
|
506
|
+
* The DataObject. Searching for the DataObject is done in all scopes that are visible to the given task (including parent scopes). Returns null when no DataObject value is found with the given
|
|
507
|
+
* name.
|
|
508
|
+
*
|
|
509
|
+
* @param taskId
|
|
510
|
+
* id of task, cannot be null.
|
|
511
|
+
* @param dataObject
|
|
512
|
+
* name of DataObject, cannot be null.
|
|
513
|
+
* @param locale
|
|
514
|
+
* locale the DataObject name and description should be returned in (if available).
|
|
515
|
+
* @param withLocalizationFallback
|
|
516
|
+
* When true localization will fallback to more general locales including the default locale of the JVM if the specified locale is not found.
|
|
517
|
+
* @return the DataObject or null if the variable is undefined.
|
|
518
|
+
* @throws FlowableObjectNotFoundException
|
|
519
|
+
* when no task is found for the given taskId.
|
|
520
|
+
*/
|
|
521
|
+
getDataObject(taskId: string, dataObject: string, locale?: string, withLocalizationFallback?: boolean): DataObject;
|
|
522
|
+
/** Add a comment to a task and/or process instance. */
|
|
523
|
+
addComment(taskId: string, processInstanceId: string, message: string, type?: string): Comment;
|
|
524
|
+
/** Update a comment to a task and/or process instance. */
|
|
525
|
+
saveComment(comment: Comment): void;
|
|
526
|
+
/**
|
|
527
|
+
* Returns an individual comment with the given id. Returns null if no comment exists with the given id.
|
|
528
|
+
*/
|
|
529
|
+
getComment(commentId: string): Comment;
|
|
530
|
+
/** Removes all comments from the provided task and/or process instance */
|
|
531
|
+
deleteComments(taskId: string, processInstanceId: string): void;
|
|
532
|
+
/**
|
|
533
|
+
* Removes an individual comment with the given id.
|
|
534
|
+
*
|
|
535
|
+
* @throws FlowableObjectNotFoundException
|
|
536
|
+
* when no comment exists with the given id.
|
|
537
|
+
*/
|
|
538
|
+
deleteComment(commentId: string): void;
|
|
539
|
+
/** The comments related to the given task. */
|
|
540
|
+
getTaskComments(taskId: string, type?: string): Comment[];
|
|
541
|
+
/** All comments of a given type. */
|
|
542
|
+
getCommentsByType(type: string): Comment[];
|
|
543
|
+
/** The all events related to the given task. */
|
|
544
|
+
getTaskEvents(taskId: string): TaskEvent[];
|
|
545
|
+
/**
|
|
546
|
+
* Returns an individual event with the given id. Returns null if no event exists with the given id.
|
|
547
|
+
*/
|
|
548
|
+
getEvent(eventId: string): TaskEvent;
|
|
549
|
+
/** The comments related to the given process instance. */
|
|
550
|
+
getProcessInstanceComments(processInstanceId: string, type?: string): Comment[];
|
|
551
|
+
/**
|
|
552
|
+
* Add a new attachment to a task and/or a process instance and use an input stream to provide the content
|
|
553
|
+
*/
|
|
554
|
+
createAttachment(attachmentType: string, taskId: string, processInstanceId: string, attachmentName: string, attachmentDescription: string, content?: any[], url?: string): Attachment;
|
|
555
|
+
/** Update the name and description of an attachment */
|
|
556
|
+
saveAttachment(attachment: Attachment): void;
|
|
557
|
+
/** Retrieve a particular attachment */
|
|
558
|
+
getAttachment(attachmentId: string): Attachment;
|
|
559
|
+
/** Retrieve stream content of a particular attachment */
|
|
560
|
+
getAttachmentContent(attachmentId: string): any[];
|
|
561
|
+
/** The list of attachments associated to a task */
|
|
562
|
+
getTaskAttachments(taskId: string): Attachment[];
|
|
563
|
+
/** The list of attachments associated to a process instance */
|
|
564
|
+
getProcessInstanceAttachments(processInstanceId: string): Attachment[];
|
|
565
|
+
/** Delete an attachment */
|
|
566
|
+
deleteAttachment(attachmentId: string): void;
|
|
567
|
+
/** The list of subtasks for this parent task */
|
|
568
|
+
getSubTasks(parentTaskId: string): Task[];
|
|
569
|
+
private isNotNull;
|
|
570
|
+
}
|
|
571
|
+
declare class TaskData {
|
|
572
|
+
private data;
|
|
573
|
+
constructor(data: any);
|
|
574
|
+
getId(): string | undefined;
|
|
575
|
+
getRevision(): number;
|
|
576
|
+
getOwner(): string | undefined;
|
|
577
|
+
getAssigneeUpdatedCount(): number;
|
|
578
|
+
getOriginalAssignee(): string | undefined;
|
|
579
|
+
getAssignee(): string | undefined;
|
|
580
|
+
getDelegationState(): string | undefined;
|
|
581
|
+
getParentTaskId(): string | undefined;
|
|
582
|
+
getName(): string | undefined;
|
|
583
|
+
getLocalizedName(): string | undefined;
|
|
584
|
+
getDescription(): string | undefined;
|
|
585
|
+
getLocalizedDescription(): string | undefined;
|
|
586
|
+
getPriority(): number;
|
|
587
|
+
getCreateTime(): Date | undefined;
|
|
588
|
+
getDueDate(): Date | undefined;
|
|
589
|
+
getSuspensionState(): number;
|
|
590
|
+
getCategory(): string | undefined;
|
|
591
|
+
isIdentityLinksInitialized(): boolean;
|
|
592
|
+
getExecutionId(): string | undefined;
|
|
593
|
+
getProcessInstanceId(): string | undefined;
|
|
594
|
+
getProcessDefinitionId(): string | undefined;
|
|
595
|
+
getScopeId(): string | undefined;
|
|
596
|
+
getSubScopeId(): string | undefined;
|
|
597
|
+
getScopeType(): string | undefined;
|
|
598
|
+
getScopeDefinitionId(): string | undefined;
|
|
599
|
+
getTaskDefinitionKey(): string | undefined;
|
|
600
|
+
getFormKey(): string | undefined;
|
|
601
|
+
isDeleted(): boolean;
|
|
602
|
+
isCanceled(): boolean;
|
|
603
|
+
isCountEnabled(): boolean;
|
|
604
|
+
getVariableCount(): number;
|
|
605
|
+
getIdentityLinkCount(): number;
|
|
606
|
+
getClaimTime(): Date | undefined;
|
|
607
|
+
getTenantId(): string;
|
|
608
|
+
getEventName(): string | undefined;
|
|
609
|
+
getEventHandlerId(): string | undefined;
|
|
610
|
+
isForcedUpdate(): boolean;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* Represents one task for a human user.
|
|
614
|
+
*/
|
|
615
|
+
export interface Task extends TaskInfo {
|
|
616
|
+
/** Name or title of the task. */
|
|
617
|
+
setName(name: string): void;
|
|
618
|
+
/** Sets an optional localized name for the task. */
|
|
619
|
+
setLocalizedName(name: string): void;
|
|
620
|
+
/** Change the description of the task */
|
|
621
|
+
setDescription(description: string): void;
|
|
622
|
+
/** Sets an optional localized description for the task. */
|
|
623
|
+
setLocalizedDescription(description: string): void;
|
|
624
|
+
/** Sets the indication of how important/urgent this task is */
|
|
625
|
+
setPriority(priority: number): void;
|
|
626
|
+
/**
|
|
627
|
+
* The user id of the person that is responsible for this task.
|
|
628
|
+
*/
|
|
629
|
+
setOwner(owner: string): void;
|
|
630
|
+
/**
|
|
631
|
+
* The user id of the person to which this task is delegated.
|
|
632
|
+
*/
|
|
633
|
+
setAssignee(assignee: string): void;
|
|
634
|
+
/** The current {@link DelegationState} for this task. */
|
|
635
|
+
getDelegationState(): DelegationState;
|
|
636
|
+
/** The current {@link DelegationState} for this task. */
|
|
637
|
+
setDelegationState(delegationState: DelegationState): void;
|
|
638
|
+
/** Change due date of the task. */
|
|
639
|
+
setDueDate(dueDate: Date): void;
|
|
640
|
+
/**
|
|
641
|
+
* Change the category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
|
|
642
|
+
*/
|
|
643
|
+
setCategory(category: string): void;
|
|
644
|
+
/** the parent task for which this task is a subtask */
|
|
645
|
+
setParentTaskId(parentTaskId: string): void;
|
|
646
|
+
/** Change the tenantId of the task */
|
|
647
|
+
setTenantId(tenantId: string): void;
|
|
648
|
+
/** Change the form key of the task */
|
|
649
|
+
setFormKey(formKey: string): void;
|
|
650
|
+
/** Indicates whether this task is suspended or not. */
|
|
651
|
+
isSuspended(): boolean;
|
|
652
|
+
}
|
|
653
|
+
export interface TaskInfo {
|
|
654
|
+
/** DB id of the task. */
|
|
655
|
+
getId(): string;
|
|
656
|
+
/**
|
|
657
|
+
* Name or title of the task.
|
|
658
|
+
*/
|
|
659
|
+
getName(): string;
|
|
660
|
+
/**
|
|
661
|
+
* Free text description of the task.
|
|
662
|
+
*/
|
|
663
|
+
getDescription(): string;
|
|
664
|
+
/**
|
|
665
|
+
* Indication of how important/urgent this task is
|
|
666
|
+
*/
|
|
667
|
+
getPriority(): number;
|
|
668
|
+
/**
|
|
669
|
+
* The user id of the person that is responsible for this task.
|
|
670
|
+
*/
|
|
671
|
+
getOwner(): string;
|
|
672
|
+
/**
|
|
673
|
+
* The user id of the person to which this task is delegated.
|
|
674
|
+
*/
|
|
675
|
+
getAssignee(): string;
|
|
676
|
+
/**
|
|
677
|
+
* Reference to the process instance or null if it is not related to a process instance.
|
|
678
|
+
*/
|
|
679
|
+
getProcessInstanceId(): string;
|
|
680
|
+
/**
|
|
681
|
+
* Reference to the path of execution or null if it is not related to a process instance.
|
|
682
|
+
*/
|
|
683
|
+
getExecutionId(): string;
|
|
684
|
+
/**
|
|
685
|
+
* Reference to the task definition or null if it is not related to any task definition.
|
|
686
|
+
*/
|
|
687
|
+
getTaskDefinitionId(): string;
|
|
688
|
+
/**
|
|
689
|
+
* Reference to the process definition or null if it is not related to a process.
|
|
690
|
+
*/
|
|
691
|
+
getProcessDefinitionId(): string;
|
|
692
|
+
/**
|
|
693
|
+
* Reference to a scope identifier or null if none is set (e.g. for bpmn process task it is null)
|
|
694
|
+
*/
|
|
695
|
+
getScopeId(): string;
|
|
696
|
+
/**
|
|
697
|
+
* Reference to a sub scope identifier or null if none is set (e.g. for bpmn process task it is null)
|
|
698
|
+
*/
|
|
699
|
+
getSubScopeId(): string;
|
|
700
|
+
/**
|
|
701
|
+
* Reference to a scope type or null if none is set (e.g. for bpmn process task it is null)
|
|
702
|
+
*/
|
|
703
|
+
getScopeType(): string;
|
|
704
|
+
/**
|
|
705
|
+
* Reference to a scope definition identifier or null if none is set (e.g. for bpmn process task it is null)
|
|
706
|
+
*/
|
|
707
|
+
getScopeDefinitionId(): string;
|
|
708
|
+
/**
|
|
709
|
+
* If this task runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be
|
|
710
|
+
* precise). Even if the direct parent of the task is a process which itself might have been created out of a process task of a case, its stage instance
|
|
711
|
+
* is reflected in the task.
|
|
712
|
+
*
|
|
713
|
+
* @return the stage instance id this task belongs to or null, if this task is not part of a case at all or is not a child element of a stage
|
|
714
|
+
*/
|
|
715
|
+
getPropagatedStageInstanceId(): string;
|
|
716
|
+
/**
|
|
717
|
+
* The state of this task
|
|
718
|
+
*/
|
|
719
|
+
getState(): string;
|
|
720
|
+
/** The date/time when this task was created */
|
|
721
|
+
getCreateTime(): Date;
|
|
722
|
+
/** The date/time when this task was put in progress */
|
|
723
|
+
getInProgressStartTime(): Date;
|
|
724
|
+
/**
|
|
725
|
+
* The user reference that put this task in progress
|
|
726
|
+
*/
|
|
727
|
+
getInProgressStartedBy(): string;
|
|
728
|
+
/**
|
|
729
|
+
* The claim time of this task
|
|
730
|
+
*/
|
|
731
|
+
getClaimTime(): Date;
|
|
732
|
+
/**
|
|
733
|
+
* The user reference that claimed this task
|
|
734
|
+
*/
|
|
735
|
+
getClaimedBy(): String;
|
|
736
|
+
/**
|
|
737
|
+
* The suspended time of this task
|
|
738
|
+
*/
|
|
739
|
+
getSuspendedTime(): Date;
|
|
740
|
+
/**
|
|
741
|
+
* The user reference that suspended this task
|
|
742
|
+
*/
|
|
743
|
+
getSuspendedBy(): string;
|
|
744
|
+
/**
|
|
745
|
+
* The id of the activity in the process defining this task or null if this is not related to a process
|
|
746
|
+
*/
|
|
747
|
+
getTaskDefinitionKey(): string;
|
|
748
|
+
/**
|
|
749
|
+
* In progress start due date of the task.
|
|
750
|
+
*/
|
|
751
|
+
getInProgressStartDueDate(): Date;
|
|
752
|
+
/**
|
|
753
|
+
* Due date of the task.
|
|
754
|
+
*/
|
|
755
|
+
getDueDate(): Date;
|
|
756
|
+
/**
|
|
757
|
+
* The category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
|
|
758
|
+
*/
|
|
759
|
+
getCategory(): any;
|
|
760
|
+
string: any;
|
|
761
|
+
/**
|
|
762
|
+
* The parent task for which this task is a subtask
|
|
763
|
+
*/
|
|
764
|
+
getParentTaskId(): string;
|
|
765
|
+
/**
|
|
766
|
+
* The tenant identifier of this task
|
|
767
|
+
*/
|
|
768
|
+
getTenantId(): string;
|
|
769
|
+
/**
|
|
770
|
+
* The form key for the user task
|
|
771
|
+
*/
|
|
772
|
+
getFormKey(): string;
|
|
773
|
+
/**
|
|
774
|
+
* Returns the local task variables if requested in the task query
|
|
775
|
+
*/
|
|
776
|
+
getTaskLocalVariables(): Map<string, Object>;
|
|
777
|
+
/**
|
|
778
|
+
* Returns the process variables if requested in the task query
|
|
779
|
+
*/
|
|
780
|
+
getProcessVariables(): Map<string, Object>;
|
|
781
|
+
/**
|
|
782
|
+
* Returns the case variables if requested in the task query
|
|
783
|
+
*/
|
|
784
|
+
getCaseVariables(): Map<string, Object>;
|
|
785
|
+
/**
|
|
786
|
+
* Returns the identity links.
|
|
787
|
+
*/
|
|
788
|
+
getIdentityLinks(): IdentityLinkInfo[];
|
|
789
|
+
}
|
|
790
|
+
export interface IdentityLinkInfo {
|
|
791
|
+
getType(): string;
|
|
792
|
+
getUserId(): string;
|
|
793
|
+
getGroupId(): string;
|
|
794
|
+
getTaskId(): string;
|
|
795
|
+
getProcessInstanceId(): string;
|
|
796
|
+
getScopeId(): string;
|
|
797
|
+
getSubScopeId(): string;
|
|
798
|
+
getScopeType(): string;
|
|
799
|
+
getScopeDefinitionId(): string;
|
|
800
|
+
}
|
|
801
|
+
export interface IdentityLink extends IdentityLinkInfo {
|
|
802
|
+
/**
|
|
803
|
+
* The process definition id associated with this identity link.
|
|
804
|
+
*/
|
|
805
|
+
getProcessDefinitionId(): string;
|
|
806
|
+
}
|
|
807
|
+
export declare enum DelegationState {
|
|
808
|
+
/**
|
|
809
|
+
* The owner delegated the task and wants to review the result after the assignee has resolved the task. When the assignee completes the task, the task is marked as {@link #RESOLVED} and sent back
|
|
810
|
+
* to the owner. When that happens, the owner is set as the assignee so that the owner gets this task back in the ToDo.
|
|
811
|
+
*/
|
|
812
|
+
PENDING = 0,
|
|
813
|
+
/**
|
|
814
|
+
* The assignee has resolved the task, the assignee was set to the owner again and the owner now finds this task back in the ToDo list for review. The owner now is able to complete the task.
|
|
815
|
+
*/
|
|
816
|
+
RESOLVED = 1
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* Wraps {@link TaskInfo} to the builder.
|
|
820
|
+
*
|
|
821
|
+
*/
|
|
822
|
+
export interface TaskBuilder {
|
|
823
|
+
/**
|
|
824
|
+
* Creates task instance according values set in the builder
|
|
825
|
+
*
|
|
826
|
+
* @return task instance
|
|
827
|
+
*/
|
|
828
|
+
create(): Task;
|
|
829
|
+
/**
|
|
830
|
+
* DB id of the task.
|
|
831
|
+
*/
|
|
832
|
+
id(id: string): TaskBuilder;
|
|
833
|
+
getId(): string;
|
|
834
|
+
/**
|
|
835
|
+
* Name or title of the task.
|
|
836
|
+
*/
|
|
837
|
+
name(name: string): TaskBuilder;
|
|
838
|
+
getName(): string;
|
|
839
|
+
/**
|
|
840
|
+
* Free text description of the task.
|
|
841
|
+
*/
|
|
842
|
+
description(description: string): TaskBuilder;
|
|
843
|
+
getDescription(): string;
|
|
844
|
+
/**
|
|
845
|
+
* Indication of how important/urgent this task is
|
|
846
|
+
*/
|
|
847
|
+
priority(priority: number): TaskBuilder;
|
|
848
|
+
getPriority(): number;
|
|
849
|
+
/**
|
|
850
|
+
* The userId of the person that is responsible for this task.
|
|
851
|
+
*/
|
|
852
|
+
owner(ownerId: string): TaskBuilder;
|
|
853
|
+
getOwner(): string;
|
|
854
|
+
/**
|
|
855
|
+
* The userId of the person to which this task is delegated.
|
|
856
|
+
*/
|
|
857
|
+
assignee(assigneId: string): TaskBuilder;
|
|
858
|
+
getAssignee(): string;
|
|
859
|
+
/**
|
|
860
|
+
* Change due date of the task.
|
|
861
|
+
*/
|
|
862
|
+
dueDate(dueDate: Date): TaskBuilder;
|
|
863
|
+
getDueDate(): Date;
|
|
864
|
+
/**
|
|
865
|
+
* Change the category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
|
|
866
|
+
*/
|
|
867
|
+
category(category: string): TaskBuilder;
|
|
868
|
+
getCategory(): string;
|
|
869
|
+
/**
|
|
870
|
+
* the parent task for which this task is a subtask
|
|
871
|
+
*/
|
|
872
|
+
parentTaskId(parentTaskId: string): TaskBuilder;
|
|
873
|
+
getParentTaskId(): string;
|
|
874
|
+
/**
|
|
875
|
+
* Change the tenantId of the task
|
|
876
|
+
*/
|
|
877
|
+
tenantId(tenantId: string): TaskBuilder;
|
|
878
|
+
getTenantId(): string;
|
|
879
|
+
/**
|
|
880
|
+
* Change the form key of the task
|
|
881
|
+
*/
|
|
882
|
+
formKey(formKey: string): TaskBuilder;
|
|
883
|
+
getFormKey(): string;
|
|
884
|
+
/**
|
|
885
|
+
* task definition id to create task from
|
|
886
|
+
*/
|
|
887
|
+
taskDefinitionId(taskDefinitionId: string): TaskBuilder;
|
|
888
|
+
getTaskDefinitionId(): string;
|
|
889
|
+
/**
|
|
890
|
+
* task definition key to create task from
|
|
891
|
+
*/
|
|
892
|
+
taskDefinitionKey(taskDefinitionKey: string): TaskBuilder;
|
|
893
|
+
getTaskDefinitionKey(): string;
|
|
894
|
+
/**
|
|
895
|
+
* add identity links to the task
|
|
896
|
+
*/
|
|
897
|
+
identityLinks(identityLinks: Set<IdentityLinkInfo>): TaskBuilder;
|
|
898
|
+
getIdentityLinks(): Set<IdentityLinkInfo>;
|
|
899
|
+
/**
|
|
900
|
+
* add task scopeId
|
|
901
|
+
*/
|
|
902
|
+
scopeId(scopeId: string): TaskBuilder;
|
|
903
|
+
getScopeId(): string;
|
|
904
|
+
/**
|
|
905
|
+
* Add scope type
|
|
906
|
+
*/
|
|
907
|
+
scopeType(scopeType: string): TaskBuilder;
|
|
908
|
+
getScopeType(): string;
|
|
909
|
+
}
|
|
910
|
+
export interface FormInfo {
|
|
911
|
+
getId(): string;
|
|
912
|
+
setId(id: string): void;
|
|
913
|
+
getName(): string;
|
|
914
|
+
setName(name: string): void;
|
|
915
|
+
getDescription(): string;
|
|
916
|
+
setDescription(description: string): void;
|
|
917
|
+
getKey(): string;
|
|
918
|
+
setKey(key: string): void;
|
|
919
|
+
getVersion(): number;
|
|
920
|
+
setVersion(version: number): void;
|
|
921
|
+
getFormModel(): any;
|
|
922
|
+
setFormModel(formModel: any): void;
|
|
923
|
+
}
|
|
924
|
+
export interface ValueFields {
|
|
925
|
+
/**
|
|
926
|
+
* @return the name of the variable
|
|
927
|
+
*/
|
|
928
|
+
getName(): string;
|
|
929
|
+
/**
|
|
930
|
+
* @return the process instance id of the variable
|
|
931
|
+
*/
|
|
932
|
+
getProcessInstanceId(): string;
|
|
933
|
+
/**
|
|
934
|
+
* @return the execution id of the variable
|
|
935
|
+
*/
|
|
936
|
+
getExecutionId(): string;
|
|
937
|
+
/**
|
|
938
|
+
* @return the scope id of the variable
|
|
939
|
+
*/
|
|
940
|
+
getScopeId(): string;
|
|
941
|
+
/**
|
|
942
|
+
* @return the sub scope id of the variable
|
|
943
|
+
*/
|
|
944
|
+
getSubScopeId(): string;
|
|
945
|
+
/**
|
|
946
|
+
* @return the scope type of the variable
|
|
947
|
+
*/
|
|
948
|
+
getScopeType(): string;
|
|
949
|
+
/**
|
|
950
|
+
* @return the task id of the variable
|
|
951
|
+
*/
|
|
952
|
+
getTaskId(): string;
|
|
953
|
+
/**
|
|
954
|
+
* @return the first text value, if any, or null.
|
|
955
|
+
*/
|
|
956
|
+
getTextValue(): string;
|
|
957
|
+
/**
|
|
958
|
+
* Sets the first text value. A value of null is allowed.
|
|
959
|
+
*/
|
|
960
|
+
setTextValue(textValue: string): void;
|
|
961
|
+
/**
|
|
962
|
+
* @return the second text value, if any, or null.
|
|
963
|
+
*/
|
|
964
|
+
getTextValue2(): string;
|
|
965
|
+
/**
|
|
966
|
+
* Sets second text value. A value of null is allowed.
|
|
967
|
+
*/
|
|
968
|
+
setTextValue2(textValue2: string): void;
|
|
969
|
+
/**
|
|
970
|
+
* @return the long value, if any, or null.
|
|
971
|
+
*/
|
|
972
|
+
getLongValue(): number;
|
|
973
|
+
/**
|
|
974
|
+
* Sets the long value. A value of null is allowed.
|
|
975
|
+
*/
|
|
976
|
+
setLongValue(longValue: number): void;
|
|
977
|
+
/**
|
|
978
|
+
* @return the double value, if any, or null.
|
|
979
|
+
*/
|
|
980
|
+
getDoubleValue(): number;
|
|
981
|
+
/**
|
|
982
|
+
* Sets the double value. A value of null is allowed.
|
|
983
|
+
*/
|
|
984
|
+
setDoubleValue(doubleValue: number): void;
|
|
985
|
+
/**
|
|
986
|
+
* @return the byte array value, if any, or null.
|
|
987
|
+
*/
|
|
988
|
+
getBytes(): any[];
|
|
989
|
+
/**
|
|
990
|
+
* Sets the byte array value. A value of null is allowed.
|
|
991
|
+
*/
|
|
992
|
+
setBytes(bytes: any[]): void;
|
|
993
|
+
getCachedValue(): any;
|
|
994
|
+
setCachedValue(cachedValue: any): void;
|
|
995
|
+
}
|
|
996
|
+
export interface VariableInstance extends ValueFields {
|
|
997
|
+
getId(): string;
|
|
998
|
+
setId(id: string): void;
|
|
999
|
+
setName(name: string): void;
|
|
1000
|
+
setExecutionId(executionId: string): void;
|
|
1001
|
+
setProcessInstanceId(processInstanceId: string): void;
|
|
1002
|
+
setProcessDefinitionId(processDefinitionId: string): void;
|
|
1003
|
+
getProcessDefinitionId(): string;
|
|
1004
|
+
getValue(): any;
|
|
1005
|
+
setValue(value: any): void;
|
|
1006
|
+
getTypeName(): string;
|
|
1007
|
+
setTypeName(typeName: string): void;
|
|
1008
|
+
isReadOnly(): boolean;
|
|
1009
|
+
setTaskId(taskId: string): void;
|
|
1010
|
+
setScopeId(scopeId: string): void;
|
|
1011
|
+
setSubScopeId(subScopeId: string): void;
|
|
1012
|
+
setScopeType(scopeType: string): void;
|
|
1013
|
+
setScopeDefinitionId(scopeDefinitionId: string): void;
|
|
1014
|
+
getScopeDefinitionId(): string;
|
|
1015
|
+
getMetaInfo(): string;
|
|
1016
|
+
setMetaInfo(metaInfo: string): void;
|
|
1017
|
+
}
|
|
1018
|
+
export interface DataObject {
|
|
1019
|
+
/**
|
|
1020
|
+
* The unique id of this Data Object.
|
|
1021
|
+
*/
|
|
1022
|
+
getId(): string;
|
|
1023
|
+
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* The id of the process instance that this Data Object is associated with.
|
|
1026
|
+
*/
|
|
1027
|
+
getProcessInstanceId(): string;
|
|
1028
|
+
/**
|
|
1029
|
+
* The id of the execution in which this Data Object resides. A DataObject only resides on a process instance
|
|
1030
|
+
* execution or a subprocess execution.
|
|
1031
|
+
*/
|
|
1032
|
+
getExecutionId(): string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Name of the DataObject.
|
|
1035
|
+
*/
|
|
1036
|
+
getName(): string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Localized Name of the DataObject.
|
|
1039
|
+
*/
|
|
1040
|
+
getLocalizedName(): string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Description of the DataObject.
|
|
1043
|
+
*/
|
|
1044
|
+
getDescription(): string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Value of the DataObject.
|
|
1047
|
+
*/
|
|
1048
|
+
getValue(): any;
|
|
1049
|
+
/**
|
|
1050
|
+
* Type of the DataObject.
|
|
1051
|
+
*/
|
|
1052
|
+
getType(): string;
|
|
1053
|
+
/**
|
|
1054
|
+
* The id of the flow element in the process defining this data object.
|
|
1055
|
+
*/
|
|
1056
|
+
getDataObjectDefinitionKey(): string;
|
|
1057
|
+
}
|
|
1058
|
+
export interface Comment {
|
|
1059
|
+
/** unique identifier for this comment */
|
|
1060
|
+
getId(): string;
|
|
1061
|
+
/** reference to the user that made the comment */
|
|
1062
|
+
getUserId(): string;
|
|
1063
|
+
setUserId(userId: string): void;
|
|
1064
|
+
getTime(): Date;
|
|
1065
|
+
setTime(time: Date): any;
|
|
1066
|
+
/** reference to the task on which this comment was made */
|
|
1067
|
+
getTaskId(): string;
|
|
1068
|
+
setTaskId(taskId: string): void;
|
|
1069
|
+
/** reference to the process instance on which this comment was made */
|
|
1070
|
+
getProcessInstanceId(): string;
|
|
1071
|
+
setProcessInstanceId(processInstanceId: string): void;
|
|
1072
|
+
/** reference to the type given to the comment */
|
|
1073
|
+
getType(): string;
|
|
1074
|
+
setType(type: string): void;
|
|
1075
|
+
/**
|
|
1076
|
+
* the full comment message the user had related to the task and/or process instance
|
|
1077
|
+
*
|
|
1078
|
+
* @see TaskService#getTaskComments(String)
|
|
1079
|
+
*/
|
|
1080
|
+
getFullMessage(): string;
|
|
1081
|
+
setFullMessage(fullMessage: string): void;
|
|
1082
|
+
}
|
|
1083
|
+
export interface TaskEvent {
|
|
1084
|
+
/** Unique identifier for this event */
|
|
1085
|
+
getId(): string;
|
|
1086
|
+
/**
|
|
1087
|
+
* Indicates the type of of action and also indicates the meaning of the parts as exposed in {@link #getMessageParts()}
|
|
1088
|
+
*/
|
|
1089
|
+
getAction(): string;
|
|
1090
|
+
/**
|
|
1091
|
+
* The meaning of the message parts is defined by the action as you can find in {@link #getAction()}
|
|
1092
|
+
*/
|
|
1093
|
+
getMessageParts(): string[];
|
|
1094
|
+
/**
|
|
1095
|
+
* The message that can be used in case this action only has a single message part.
|
|
1096
|
+
*/
|
|
1097
|
+
getMessage(): string;
|
|
1098
|
+
/** reference to the user that made the comment */
|
|
1099
|
+
getUserId(): string;
|
|
1100
|
+
/** time and date when the user made the comment */
|
|
1101
|
+
getTime(): Date;
|
|
1102
|
+
/** reference to the task on which this comment was made */
|
|
1103
|
+
getTaskId(): string;
|
|
1104
|
+
/** reference to the process instance on which this comment was made */
|
|
1105
|
+
getProcessInstanceId(): string;
|
|
1106
|
+
}
|
|
1107
|
+
export interface Attachment {
|
|
1108
|
+
/** unique id for this attachment */
|
|
1109
|
+
getId(): string;
|
|
1110
|
+
/** free user defined short (max 255 chars) name for this attachment */
|
|
1111
|
+
getName(): string;
|
|
1112
|
+
/** free user defined short (max 255 chars) name for this attachment */
|
|
1113
|
+
setName(name: string): void;
|
|
1114
|
+
/**
|
|
1115
|
+
* long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
|
|
1116
|
+
*/
|
|
1117
|
+
getDescription(): string;
|
|
1118
|
+
/**
|
|
1119
|
+
* long (max 255 chars) explanation what this attachment is about in context of the task and/or process instance it's linked to.
|
|
1120
|
+
*/
|
|
1121
|
+
setDescription(description: string): void;
|
|
1122
|
+
/**
|
|
1123
|
+
* indication of the type of content that this attachment refers to. Can be mime type or any other indication.
|
|
1124
|
+
*/
|
|
1125
|
+
getType(): string;
|
|
1126
|
+
/** reference to the task to which this attachment is associated. */
|
|
1127
|
+
getTaskId(): string;
|
|
1128
|
+
/**
|
|
1129
|
+
* reference to the process instance to which this attachment is associated.
|
|
1130
|
+
*/
|
|
1131
|
+
getProcessInstanceId(): string;
|
|
1132
|
+
/**
|
|
1133
|
+
* the remote URL in case this is remote content. If the attachment content was {@link TaskService#createAttachment(String, String, String, String, String, java.io.InputStream) uploaded with an
|
|
1134
|
+
* input stream}, then this method returns null and the content can be fetched with {@link TaskService#getAttachmentContent(String)}.
|
|
1135
|
+
*/
|
|
1136
|
+
getUrl(): string;
|
|
1137
|
+
/** reference to the user who created this attachment. */
|
|
1138
|
+
getUserId(): string;
|
|
1139
|
+
/** timestamp when this attachment was created */
|
|
1140
|
+
getTime(): Date;
|
|
1141
|
+
/** timestamp when this attachment was created */
|
|
1142
|
+
setTime(time: Date): void;
|
|
1143
|
+
/** the id of the byte array entity storing the content */
|
|
1144
|
+
getContentId(): string;
|
|
1145
|
+
}
|
|
1146
|
+
export declare enum NullHandlingOnOrder {
|
|
1147
|
+
NULLS_FIRST = 0,
|
|
1148
|
+
NULLS_LAST = 1
|
|
1149
|
+
}
|
|
1150
|
+
export interface QueryProperty {
|
|
1151
|
+
getName(): string;
|
|
1152
|
+
}
|
|
1153
|
+
export interface Query<T, U> {
|
|
1154
|
+
/**
|
|
1155
|
+
* Order the results ascending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).
|
|
1156
|
+
*/
|
|
1157
|
+
asc(): T;
|
|
1158
|
+
/**
|
|
1159
|
+
* Order the results descending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).
|
|
1160
|
+
*/
|
|
1161
|
+
desc(): T;
|
|
1162
|
+
orderBy(property: QueryProperty): T;
|
|
1163
|
+
orderBy(property: QueryProperty, nullHandlingOnOrder: NullHandlingOnOrder): T;
|
|
1164
|
+
/**
|
|
1165
|
+
* Executes the query and returns the number of results
|
|
1166
|
+
*/
|
|
1167
|
+
count(): number;
|
|
1168
|
+
/**
|
|
1169
|
+
* Executes the query and returns the resulting entity or null if no entity matches the query criteria.
|
|
1170
|
+
*
|
|
1171
|
+
* @throws org.flowable.common.engine.api.FlowableException when the query results in more than one entities.
|
|
1172
|
+
*/
|
|
1173
|
+
singleResult(): U;
|
|
1174
|
+
/**
|
|
1175
|
+
* Executes the query and get a list of entities as the result.
|
|
1176
|
+
*/
|
|
1177
|
+
list(): U[];
|
|
1178
|
+
/**
|
|
1179
|
+
* Executes the query and get a list of entities as the result.
|
|
1180
|
+
*/
|
|
1181
|
+
listPage(firstResult: number, maxResults: number): U[];
|
|
1182
|
+
}
|
|
1183
|
+
export interface TaskInfoQuery<T, V extends TaskInfo> extends Query<T, V> {
|
|
1184
|
+
/**
|
|
1185
|
+
* Only select tasks with the given task id (in practice, there will be maximum one of this kind)
|
|
1186
|
+
*/
|
|
1187
|
+
taskId(taskId: string): T;
|
|
1188
|
+
/**
|
|
1189
|
+
* Only select tasks with an id that is in the given list
|
|
1190
|
+
*
|
|
1191
|
+
* @throws FlowableIllegalArgumentException
|
|
1192
|
+
* When passed id list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1193
|
+
*/
|
|
1194
|
+
taskIds(taskIds: string[]): T;
|
|
1195
|
+
/** Only select tasks with the given name */
|
|
1196
|
+
taskName(name: string): T;
|
|
1197
|
+
/**
|
|
1198
|
+
* Only select tasks with a name that is in the given list
|
|
1199
|
+
*
|
|
1200
|
+
* @throws FlowableIllegalArgumentException
|
|
1201
|
+
* When passed name list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1202
|
+
*/
|
|
1203
|
+
taskNameIn(nameList: string[]): T;
|
|
1204
|
+
/**
|
|
1205
|
+
* Only select tasks with a name that is in the given list
|
|
1206
|
+
*
|
|
1207
|
+
* This method, unlike the {@link #taskNameIn(Collection)} method will not take in account the upper/lower case: both the input parameters as the column value are lowercased when the query is executed.
|
|
1208
|
+
*
|
|
1209
|
+
* @throws FlowableIllegalArgumentException
|
|
1210
|
+
* When passed name list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1211
|
+
*/
|
|
1212
|
+
taskNameInIgnoreCase(nameList: string[]): T;
|
|
1213
|
+
/**
|
|
1214
|
+
* Only select tasks with a name matching the parameter. The syntax is that of SQL: for example usage: nameLike(%test%)
|
|
1215
|
+
*/
|
|
1216
|
+
taskNameLike(nameLike: string): T;
|
|
1217
|
+
/**
|
|
1218
|
+
* Only select tasks with a name matching the parameter. The syntax is that of SQL: for example usage: nameLike(%test%)
|
|
1219
|
+
*
|
|
1220
|
+
* This method, unlike the {@link #taskNameLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is
|
|
1221
|
+
* executed.
|
|
1222
|
+
*/
|
|
1223
|
+
taskNameLikeIgnoreCase(nameLike: string): T;
|
|
1224
|
+
/** Only select tasks with the given description. */
|
|
1225
|
+
taskDescription(description: string): T;
|
|
1226
|
+
/**
|
|
1227
|
+
* Only select tasks with a description matching the parameter . The syntax is that of SQL: for example usage: descriptionLike(%test%)
|
|
1228
|
+
*/
|
|
1229
|
+
taskDescriptionLike(descriptionLike: string): T;
|
|
1230
|
+
/**
|
|
1231
|
+
* Only select tasks with a description matching the parameter . The syntax is that of SQL: for example usage: descriptionLike(%test%)
|
|
1232
|
+
*
|
|
1233
|
+
* This method, unlike the {@link #taskDescriptionLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is
|
|
1234
|
+
* executed.
|
|
1235
|
+
*/
|
|
1236
|
+
taskDescriptionLikeIgnoreCase(descriptionLike: string): T;
|
|
1237
|
+
/** Only select tasks with the given priority. */
|
|
1238
|
+
taskPriority(priority: number): T;
|
|
1239
|
+
/** Only select tasks with the given priority or higher. */
|
|
1240
|
+
taskMinPriority(minPriority: number): T;
|
|
1241
|
+
/** Only select tasks with the given priority or lower. */
|
|
1242
|
+
taskMaxPriority(maxPriority: number): T;
|
|
1243
|
+
/** Only select tasks which are assigned to the given user. */
|
|
1244
|
+
taskAssignee(assignee: string): T;
|
|
1245
|
+
/**
|
|
1246
|
+
* Only select tasks which were last assigned to an assignee like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1247
|
+
*/
|
|
1248
|
+
taskAssigneeLike(assigneeLike: string): T;
|
|
1249
|
+
/**
|
|
1250
|
+
* Only select tasks which were last assigned to an assignee like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1251
|
+
*
|
|
1252
|
+
* This method, unlike the {@link #taskAssigneeLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is
|
|
1253
|
+
* executed.
|
|
1254
|
+
*/
|
|
1255
|
+
taskAssigneeLikeIgnoreCase(assigneeLikeIgnoreCase: string): T;
|
|
1256
|
+
/** Only select tasks which don't have an assignee. */
|
|
1257
|
+
taskUnassigned(): T;
|
|
1258
|
+
/** Only select tasks which are assigned to any user */
|
|
1259
|
+
taskAssigned(): T;
|
|
1260
|
+
/**
|
|
1261
|
+
* Only select tasks with an assignee that is in the given list
|
|
1262
|
+
*
|
|
1263
|
+
* @throws FlowableIllegalArgumentException
|
|
1264
|
+
* When passed name list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1265
|
+
*/
|
|
1266
|
+
taskAssigneeIds(assigneeListIds: string[]): T;
|
|
1267
|
+
/** Only select tasks for which the given user is the owner. */
|
|
1268
|
+
taskOwner(owner: string): T;
|
|
1269
|
+
/**
|
|
1270
|
+
* Only select tasks which were last assigned to an owner like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1271
|
+
*/
|
|
1272
|
+
taskOwnerLike(ownerLike: string): T;
|
|
1273
|
+
/**
|
|
1274
|
+
* Only select tasks which were last assigned to an owner like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1275
|
+
*
|
|
1276
|
+
* This method, unlike the {@link #taskOwnerLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the query is
|
|
1277
|
+
* executed.
|
|
1278
|
+
*/
|
|
1279
|
+
taskOwnerLikeIgnoreCase(ownerLikeIgnoreCase: string): T;
|
|
1280
|
+
/** Only select tasks for which the given user is a candidate. */
|
|
1281
|
+
taskCandidateUser(candidateUser: string): T;
|
|
1282
|
+
/**
|
|
1283
|
+
* Only select tasks for which there exist an {@link IdentityLink} with the given user, including tasks which have been assigned to the given user (assignee) or owned by the given user (owner).
|
|
1284
|
+
*/
|
|
1285
|
+
taskInvolvedUser(involvedUser: string): T;
|
|
1286
|
+
/**
|
|
1287
|
+
* Only select tasks for which there exist an {@link IdentityLink} with the given Groups.
|
|
1288
|
+
*/
|
|
1289
|
+
taskInvolvedGroups(involvedGroup: string[]): T;
|
|
1290
|
+
/**
|
|
1291
|
+
* Allows to select a task using {@link #taskCandidateGroup(String)} {@link #taskCandidateGroupIn(Collection)} or {@link #taskCandidateUser(String)} but ignore the assignee value instead of querying for an empty assignee.
|
|
1292
|
+
*/
|
|
1293
|
+
ignoreAssigneeValue(): T;
|
|
1294
|
+
/** Only select tasks for which users in the given group are candidates. */
|
|
1295
|
+
taskCandidateGroup(candidateGroup: string): T;
|
|
1296
|
+
/**
|
|
1297
|
+
* Only select tasks for which the 'candidateGroup' is one of the given groups.
|
|
1298
|
+
*
|
|
1299
|
+
* @throws FlowableIllegalArgumentException
|
|
1300
|
+
* When query is executed and {@link #taskCandidateGroup(String)} or {@link #taskCandidateUser(String)} has been executed on the query instance. When passed group list is empty or
|
|
1301
|
+
* <code>null</code>.
|
|
1302
|
+
*/
|
|
1303
|
+
taskCandidateGroupIn(candidateGroups: string[]): T;
|
|
1304
|
+
/**
|
|
1305
|
+
* Only select tasks that have the given tenant id.
|
|
1306
|
+
*/
|
|
1307
|
+
taskTenantId(tenantId: string): T;
|
|
1308
|
+
/**
|
|
1309
|
+
* Only select tasks with a tenant id like the given one.
|
|
1310
|
+
*/
|
|
1311
|
+
taskTenantIdLike(tenantIdLike: string): T;
|
|
1312
|
+
/**
|
|
1313
|
+
* Only select tasks that do not have a tenant id.
|
|
1314
|
+
*/
|
|
1315
|
+
taskWithoutTenantId(): T;
|
|
1316
|
+
/**
|
|
1317
|
+
* Only select tasks for the given process instance id.
|
|
1318
|
+
*/
|
|
1319
|
+
processInstanceId(processInstanceId: string): T;
|
|
1320
|
+
/**
|
|
1321
|
+
* Only select tasks for the given process ids.
|
|
1322
|
+
*/
|
|
1323
|
+
processInstanceIdIn(processInstanceIds: string[]): T;
|
|
1324
|
+
/**
|
|
1325
|
+
* Only select tasks without a process instance id.
|
|
1326
|
+
*/
|
|
1327
|
+
withoutProcessInstanceId(): T;
|
|
1328
|
+
/**
|
|
1329
|
+
* Only select tasks for the given business key
|
|
1330
|
+
*/
|
|
1331
|
+
processInstanceBusinessKey(processInstanceBusinessKey: string): T;
|
|
1332
|
+
/**
|
|
1333
|
+
* Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%").
|
|
1334
|
+
*/
|
|
1335
|
+
processInstanceBusinessKeyLike(processInstanceBusinessKeyLike: string): T;
|
|
1336
|
+
/**
|
|
1337
|
+
* Only select tasks with a business key like the given value The syntax is that of SQL: for example usage: processInstanceBusinessKeyLike("%test%").
|
|
1338
|
+
*
|
|
1339
|
+
* This method, unlike the {@link #processInstanceBusinessKeyLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when
|
|
1340
|
+
* the query is executed.
|
|
1341
|
+
*/
|
|
1342
|
+
processInstanceBusinessKeyLikeIgnoreCase(processInstanceBusinessKeyLikeIgnoreCase: string): T;
|
|
1343
|
+
/**
|
|
1344
|
+
* Only select tasks for the given execution.
|
|
1345
|
+
*/
|
|
1346
|
+
executionId(executionId: string): T;
|
|
1347
|
+
/**
|
|
1348
|
+
* Only select tasks for the given case instance.
|
|
1349
|
+
*/
|
|
1350
|
+
caseInstanceId(caseInstanceId: string): T;
|
|
1351
|
+
/**
|
|
1352
|
+
* Only select tasks for the given case definition.
|
|
1353
|
+
*/
|
|
1354
|
+
caseDefinitionId(caseDefinitionId: string): T;
|
|
1355
|
+
/**
|
|
1356
|
+
* Only select tasks which are part of a case instance which has the given case definition key.
|
|
1357
|
+
*/
|
|
1358
|
+
caseDefinitionKey(caseDefinitionKey: string): T;
|
|
1359
|
+
/**
|
|
1360
|
+
* Only select tasks which are part of a case instance which has a case definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1361
|
+
*/
|
|
1362
|
+
caseDefinitionKeyLike(caseDefinitionKeyLike: string): T;
|
|
1363
|
+
/**
|
|
1364
|
+
* Only select tasks which are part of a case instance which has a case definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1365
|
+
*
|
|
1366
|
+
* This method, unlike the {@link #caseDefinitionKeyLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the
|
|
1367
|
+
* query is executed.
|
|
1368
|
+
*/
|
|
1369
|
+
caseDefinitionKeyLikeIgnoreCase(caseDefinitionKeyLikeIgnoreCase: string): T;
|
|
1370
|
+
/** Only select tasks that have a case definition for which the key is present in the given list **/
|
|
1371
|
+
caseDefinitionKeyIn(caseDefinitionKeys: string[]): T;
|
|
1372
|
+
/**
|
|
1373
|
+
* Only select tasks for the given plan item instance.
|
|
1374
|
+
*/
|
|
1375
|
+
planItemInstanceId(planItemInstanceId: string): T;
|
|
1376
|
+
/**
|
|
1377
|
+
* Only select tasks for the given scope identifier.
|
|
1378
|
+
*/
|
|
1379
|
+
scopeId(scopeId: string): T;
|
|
1380
|
+
/**
|
|
1381
|
+
* Only select tasks for the given sub scope identifier.
|
|
1382
|
+
*/
|
|
1383
|
+
subScopeId(subScopeId: string): T;
|
|
1384
|
+
/**
|
|
1385
|
+
* Only select tasks for the given scope type.
|
|
1386
|
+
*/
|
|
1387
|
+
scopeType(scopeType: string): T;
|
|
1388
|
+
/**
|
|
1389
|
+
* Only select tasks for the given scope definition identifier.
|
|
1390
|
+
*/
|
|
1391
|
+
scopeDefinitionId(scopeDefinitionId: string): T;
|
|
1392
|
+
/**
|
|
1393
|
+
* Only select tasks for the given stage, defined through its stage instance id.
|
|
1394
|
+
*/
|
|
1395
|
+
propagatedStageInstanceId(propagatedStageInstanceId: string): T;
|
|
1396
|
+
/**
|
|
1397
|
+
* Select all tasks for the given process instance id and its children.
|
|
1398
|
+
*/
|
|
1399
|
+
processInstanceIdWithChildren(processInstanceId: string): T;
|
|
1400
|
+
/**
|
|
1401
|
+
* Select all tasks for the given case instance id and its children.
|
|
1402
|
+
*/
|
|
1403
|
+
caseInstanceIdWithChildren(caseInstanceId: string): T;
|
|
1404
|
+
/**
|
|
1405
|
+
* Only select tasks that are created on the given date.
|
|
1406
|
+
*/
|
|
1407
|
+
taskCreatedOn(createTime: Date): T;
|
|
1408
|
+
/**
|
|
1409
|
+
* Only select tasks that are created before the given date.
|
|
1410
|
+
*/
|
|
1411
|
+
taskCreatedBefore(before: Date): T;
|
|
1412
|
+
/**
|
|
1413
|
+
* Only select tasks that are created after the given date.
|
|
1414
|
+
*/
|
|
1415
|
+
taskCreatedAfter(after: Date): T;
|
|
1416
|
+
/**
|
|
1417
|
+
* Only select tasks that are started in progress on the given date.
|
|
1418
|
+
*/
|
|
1419
|
+
taskInProgressStartTimeOn(claimedTime: Date): T;
|
|
1420
|
+
/**
|
|
1421
|
+
* Only select tasks that are started in progress before the given date.
|
|
1422
|
+
*/
|
|
1423
|
+
taskInProgressStartTimeBefore(before: Date): T;
|
|
1424
|
+
/**
|
|
1425
|
+
* Only select tasks that are started in progress after the given date.
|
|
1426
|
+
*/
|
|
1427
|
+
taskInProgressStartTimeAfter(after: Date): T;
|
|
1428
|
+
/**
|
|
1429
|
+
* Select all tasks that have an in progress started user reference for the given value.
|
|
1430
|
+
*/
|
|
1431
|
+
taskInProgressStartedBy(startedBy: string): T;
|
|
1432
|
+
/**
|
|
1433
|
+
* Only select tasks that are claimed on the given date.
|
|
1434
|
+
*/
|
|
1435
|
+
taskClaimedOn(claimedTime: Date): T;
|
|
1436
|
+
/**
|
|
1437
|
+
* Only select tasks that are claimed before the given date.
|
|
1438
|
+
*/
|
|
1439
|
+
taskClaimedBefore(before: Date): T;
|
|
1440
|
+
/**
|
|
1441
|
+
* Only select tasks that are claimed after the given date.
|
|
1442
|
+
*/
|
|
1443
|
+
taskClaimedAfter(after: Date): T;
|
|
1444
|
+
/**
|
|
1445
|
+
* Select all tasks that have a claimed by user reference for the given value.
|
|
1446
|
+
*/
|
|
1447
|
+
taskClaimedBy(claimedBy: string): T;
|
|
1448
|
+
/**
|
|
1449
|
+
* Only select tasks that are suspended on the given date.
|
|
1450
|
+
*/
|
|
1451
|
+
taskSuspendedOn(suspendedTime: Date): T;
|
|
1452
|
+
/**
|
|
1453
|
+
* Only select tasks that are suspended before the given date.
|
|
1454
|
+
*/
|
|
1455
|
+
taskSuspendedBefore(before: Date): T;
|
|
1456
|
+
/**
|
|
1457
|
+
* Only select tasks that are suspended after the given date.
|
|
1458
|
+
*/
|
|
1459
|
+
taskSuspendedAfter(after: Date): T;
|
|
1460
|
+
/**
|
|
1461
|
+
* Select all tasks that have a suspended by user reference for the given value.
|
|
1462
|
+
*/
|
|
1463
|
+
taskSuspendedBy(suspendedBy: string): T;
|
|
1464
|
+
/**
|
|
1465
|
+
* Only select tasks with the given category.
|
|
1466
|
+
*/
|
|
1467
|
+
taskCategory(category: string): T;
|
|
1468
|
+
/**
|
|
1469
|
+
* Only select tasks belonging to one of the categories in the given list.
|
|
1470
|
+
*
|
|
1471
|
+
* @param taskCategoryInList
|
|
1472
|
+
* @throws FlowableIllegalArgumentException When passed category list is empty or <code>null</code> or contains <code>null</code> String.
|
|
1473
|
+
*/
|
|
1474
|
+
taskCategoryIn(taskCategoryInList: string[]): T;
|
|
1475
|
+
/**
|
|
1476
|
+
* Only select tasks with a defined category which do not belong to a category present in the given list.
|
|
1477
|
+
* <p>
|
|
1478
|
+
* NOTE: This method does <b>not</b> return tasks <b>without</b> category e.g. tasks having a <code>null</code> category.
|
|
1479
|
+
* To include <code>null</code> categories, use <code>query.or().taskCategoryNotIn(...).taskWithoutCategory().endOr()</code>
|
|
1480
|
+
* </p>
|
|
1481
|
+
*
|
|
1482
|
+
* @param taskCategoryNotInList
|
|
1483
|
+
* @throws FlowableIllegalArgumentException When passed category list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1484
|
+
* @see #taskWithoutCategory
|
|
1485
|
+
*/
|
|
1486
|
+
taskCategoryNotIn(taskCategoryNotInList: string[]): T;
|
|
1487
|
+
/**
|
|
1488
|
+
* Selects tasks without category.
|
|
1489
|
+
* <p>
|
|
1490
|
+
* Can also be used in conjunction with other filter criteria to include tasks without category e.g. in <code>or</code> queries.
|
|
1491
|
+
* </p>
|
|
1492
|
+
* @see #taskCategoryNotIn(Collection)
|
|
1493
|
+
*/
|
|
1494
|
+
taskWithoutCategory(): T;
|
|
1495
|
+
/**
|
|
1496
|
+
* Only select tasks with form key.
|
|
1497
|
+
*/
|
|
1498
|
+
taskWithFormKey(): T;
|
|
1499
|
+
/**
|
|
1500
|
+
* Only select tasks with the given formKey.
|
|
1501
|
+
*/
|
|
1502
|
+
taskFormKey(formKey: string): T;
|
|
1503
|
+
/**
|
|
1504
|
+
* Only select tasks with the given taskDefinitionKey. The task definition key is the id of the userTask: <userTask id="xxx" .../>
|
|
1505
|
+
**/
|
|
1506
|
+
taskDefinitionKey(key: string): T;
|
|
1507
|
+
/**
|
|
1508
|
+
* Only select tasks with a taskDefinitionKey that match the given parameter. The syntax is that of SQL: for example usage: taskDefinitionKeyLike("%test%"). The task definition key is the id of
|
|
1509
|
+
* the userTask: <userTask id="xxx" .../>
|
|
1510
|
+
**/
|
|
1511
|
+
taskDefinitionKeyLike(keyLike: string): T;
|
|
1512
|
+
/**
|
|
1513
|
+
* Only select tasks with the given taskDefinitionKeys. The task definition key is the id of the userTask: <userTask id="xxx" .../>
|
|
1514
|
+
**/
|
|
1515
|
+
taskDefinitionKeys(keys: string[]): T;
|
|
1516
|
+
/**
|
|
1517
|
+
* Only select tasks with the given state.
|
|
1518
|
+
**/
|
|
1519
|
+
taskState(state: string): T;
|
|
1520
|
+
/**
|
|
1521
|
+
* Only select tasks with the given in progress start due date.
|
|
1522
|
+
*/
|
|
1523
|
+
taskInProgressStartDueDate(dueDate: Date): T;
|
|
1524
|
+
/**
|
|
1525
|
+
* Only select tasks which have an in progress start due date before the given date.
|
|
1526
|
+
*/
|
|
1527
|
+
taskInProgressStartDueBefore(dueDate: Date): T;
|
|
1528
|
+
/**
|
|
1529
|
+
* Only select tasks which have an in progress start due date after the given date.
|
|
1530
|
+
*/
|
|
1531
|
+
taskInProgressStartDueAfter(dueDate: Date): T;
|
|
1532
|
+
/**
|
|
1533
|
+
* Only select tasks with no in progress start due date.
|
|
1534
|
+
*/
|
|
1535
|
+
withoutTaskInProgressStartDueDate(): T;
|
|
1536
|
+
/**
|
|
1537
|
+
* Only select tasks with the given due date.
|
|
1538
|
+
*/
|
|
1539
|
+
taskDueDate(dueDate: Date): T;
|
|
1540
|
+
/**
|
|
1541
|
+
* Only select tasks which have a due date before the given date.
|
|
1542
|
+
*/
|
|
1543
|
+
taskDueBefore(dueDate: Date): T;
|
|
1544
|
+
/**
|
|
1545
|
+
* Only select tasks which have a due date after the given date.
|
|
1546
|
+
*/
|
|
1547
|
+
taskDueAfter(dueDate: Date): T;
|
|
1548
|
+
/**
|
|
1549
|
+
* Only select tasks with no due date.
|
|
1550
|
+
*/
|
|
1551
|
+
withoutTaskDueDate(): T;
|
|
1552
|
+
/**
|
|
1553
|
+
* Only select tasks which are part of a process instance which has the given process definition key.
|
|
1554
|
+
*/
|
|
1555
|
+
processDefinitionKey(processDefinitionKey: string): T;
|
|
1556
|
+
/**
|
|
1557
|
+
* Only select tasks which are part of a process instance which has a process definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1558
|
+
*/
|
|
1559
|
+
processDefinitionKeyLike(processDefinitionKeyLike: string): T;
|
|
1560
|
+
/**
|
|
1561
|
+
* Only select tasks which are part of a process instance which has a process definition key like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1562
|
+
*
|
|
1563
|
+
* This method, unlike the {@link #processDefinitionKeyLike(String)} method will not take in account the upper/lower case: both the input parameter as the column value are lowercased when the
|
|
1564
|
+
* query is executed.
|
|
1565
|
+
*/
|
|
1566
|
+
processDefinitionKeyLikeIgnoreCase(processDefinitionKeyLikeIgnoreCase: string): T;
|
|
1567
|
+
/** Only select tasks that have a process definition for which the key is present in the given list **/
|
|
1568
|
+
processDefinitionKeyIn(processDefinitionKeys: string[]): T;
|
|
1569
|
+
/**
|
|
1570
|
+
* Only select tasks which created from the given task definition referenced by id.
|
|
1571
|
+
*/
|
|
1572
|
+
taskDefinitionId(taskDefinitionId: string): T;
|
|
1573
|
+
/**
|
|
1574
|
+
* Only select tasks which are part of a process instance which has the given process definition id.
|
|
1575
|
+
*/
|
|
1576
|
+
processDefinitionId(processDefinitionId: string): T;
|
|
1577
|
+
/**
|
|
1578
|
+
* Only select tasks which are part of a process instance which has the given process definition name.
|
|
1579
|
+
*/
|
|
1580
|
+
processDefinitionName(processDefinitionName: string): T;
|
|
1581
|
+
/**
|
|
1582
|
+
* Only select tasks which are part of a process instance which has a process definition name like the given value. The syntax that should be used is the same as in SQL, eg. %test%.
|
|
1583
|
+
*/
|
|
1584
|
+
processDefinitionNameLike(processDefinitionNameLike: string): T;
|
|
1585
|
+
/**
|
|
1586
|
+
* Only select tasks which are part of a process instance whose definition belongs to the category which is present in the given list.
|
|
1587
|
+
*
|
|
1588
|
+
* @throws FlowableIllegalArgumentException
|
|
1589
|
+
* When passed category list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1590
|
+
* @param processCategoryInList
|
|
1591
|
+
*/
|
|
1592
|
+
processCategoryIn(processCategoryInList: string[]): T;
|
|
1593
|
+
/**
|
|
1594
|
+
* Only select tasks which are part of a process instance whose definition does not belong to the category which is present in the given list.
|
|
1595
|
+
*
|
|
1596
|
+
* @throws FlowableIllegalArgumentException
|
|
1597
|
+
* When passed category list is empty or <code>null</code> or contains <code>null String</code>.
|
|
1598
|
+
* @param processCategoryNotInList
|
|
1599
|
+
*/
|
|
1600
|
+
processCategoryNotIn(processCategoryNotInList: string[]): T;
|
|
1601
|
+
/**
|
|
1602
|
+
* Only select tasks which are part of a process instance which has the given deployment id.
|
|
1603
|
+
*/
|
|
1604
|
+
deploymentId(deploymentId: string): T;
|
|
1605
|
+
/**
|
|
1606
|
+
* Only select tasks which are part of a process instance which has the given deployment id.
|
|
1607
|
+
*/
|
|
1608
|
+
deploymentIdIn(deploymentIds: string[]): T;
|
|
1609
|
+
/**
|
|
1610
|
+
* Only select tasks which are related to a case instance for to the given deployment id.
|
|
1611
|
+
*/
|
|
1612
|
+
cmmnDeploymentId(cmmnDeploymentId: string): T;
|
|
1613
|
+
/**
|
|
1614
|
+
* Only select tasks which are related to a case instances for the given deployment id.
|
|
1615
|
+
*/
|
|
1616
|
+
cmmnDeploymentIdIn(cmmnDeploymentIds: string[]): T;
|
|
1617
|
+
/**
|
|
1618
|
+
* Only select tasks which don't have a scope id set.
|
|
1619
|
+
*/
|
|
1620
|
+
withoutScopeId(): T;
|
|
1621
|
+
/**
|
|
1622
|
+
* Only select tasks which have a local task variable with the given name set to the given value.
|
|
1623
|
+
*/
|
|
1624
|
+
taskVariableValueEquals(variableName: string, variableValue: any): T;
|
|
1625
|
+
/**
|
|
1626
|
+
* Only select tasks which have at least one local task variable with the given value.
|
|
1627
|
+
*/
|
|
1628
|
+
taskVariableValueEquals(variableValue: any): T;
|
|
1629
|
+
/**
|
|
1630
|
+
* Only select tasks which have a local string variable with the given value, case insensitive.
|
|
1631
|
+
* <p>
|
|
1632
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1633
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1634
|
+
* </p>
|
|
1635
|
+
*/
|
|
1636
|
+
taskVariableValueEqualsIgnoreCase(name: string, value: string): T;
|
|
1637
|
+
/**
|
|
1638
|
+
* Only select tasks which have a local task variable with the given name, but with a different value than the passed value. Byte-arrays and {@link Serializable} objects (which are not primitive
|
|
1639
|
+
* type wrappers) are not supported.
|
|
1640
|
+
*/
|
|
1641
|
+
taskVariableValueNotEquals(variableName: string, variableValue: any): T;
|
|
1642
|
+
/**
|
|
1643
|
+
* Only select tasks which have a local string variable with is not the given value, case insensitive.
|
|
1644
|
+
* <p>
|
|
1645
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1646
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1647
|
+
* </p>
|
|
1648
|
+
*/
|
|
1649
|
+
taskVariableValueNotEqualsIgnoreCase(name: string, value: string): T;
|
|
1650
|
+
/**
|
|
1651
|
+
* Only select tasks which have a local variable value greater than the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers)
|
|
1652
|
+
* are not supported.
|
|
1653
|
+
*
|
|
1654
|
+
* @param name
|
|
1655
|
+
* cannot be null.
|
|
1656
|
+
* @param value
|
|
1657
|
+
* cannot be null.
|
|
1658
|
+
*/
|
|
1659
|
+
taskVariableValueGreaterThan(name: string, value: any): T;
|
|
1660
|
+
/**
|
|
1661
|
+
* Only select tasks which have a local variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive
|
|
1662
|
+
* type wrappers) are not supported.
|
|
1663
|
+
*
|
|
1664
|
+
* @param name
|
|
1665
|
+
* cannot be null.
|
|
1666
|
+
* @param value
|
|
1667
|
+
* cannot be null.
|
|
1668
|
+
*/
|
|
1669
|
+
taskVariableValueGreaterThanOrEqual(name: string, value: any): T;
|
|
1670
|
+
/**
|
|
1671
|
+
* Only select tasks which have a local variable value less than the passed value when the ended.Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers) are
|
|
1672
|
+
* not supported.
|
|
1673
|
+
*
|
|
1674
|
+
* @param name
|
|
1675
|
+
* cannot be null.
|
|
1676
|
+
* @param value
|
|
1677
|
+
* cannot be null.
|
|
1678
|
+
*/
|
|
1679
|
+
taskVariableValueLessThan(name: string, value: any): T;
|
|
1680
|
+
/**
|
|
1681
|
+
* Only select tasks which have a local variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1682
|
+
* wrappers) are not supported.
|
|
1683
|
+
*
|
|
1684
|
+
* @param name
|
|
1685
|
+
* cannot be null.
|
|
1686
|
+
* @param value
|
|
1687
|
+
* cannot be null.
|
|
1688
|
+
*/
|
|
1689
|
+
taskVariableValueLessThanOrEqual(name: string, value: any): T;
|
|
1690
|
+
/**
|
|
1691
|
+
* Only select tasks which have a local variable value like the given value when they ended. This can be used on string variables only.
|
|
1692
|
+
*
|
|
1693
|
+
* @param name
|
|
1694
|
+
* cannot be null.
|
|
1695
|
+
* @param value
|
|
1696
|
+
* cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1697
|
+
*/
|
|
1698
|
+
taskVariableValueLike(name: string, value: string): T;
|
|
1699
|
+
/**
|
|
1700
|
+
* Only select tasks which have a local variable value like the given value (case insensitive) when they ended. This can be used on string variables only.
|
|
1701
|
+
*
|
|
1702
|
+
* @param name
|
|
1703
|
+
* cannot be null.
|
|
1704
|
+
* @param value
|
|
1705
|
+
* cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1706
|
+
*/
|
|
1707
|
+
taskVariableValueLikeIgnoreCase(name: string, value: string): T;
|
|
1708
|
+
/**
|
|
1709
|
+
* Only select tasks which have a local variable with the given name.
|
|
1710
|
+
*
|
|
1711
|
+
* @param name
|
|
1712
|
+
* cannot be null.
|
|
1713
|
+
*/
|
|
1714
|
+
taskVariableExists(name: string): T;
|
|
1715
|
+
/**
|
|
1716
|
+
* Only select tasks which does not have a local variable with the given name.
|
|
1717
|
+
*
|
|
1718
|
+
* @param name
|
|
1719
|
+
* cannot be null.
|
|
1720
|
+
*/
|
|
1721
|
+
taskVariableNotExists(name: string): T;
|
|
1722
|
+
/**
|
|
1723
|
+
* Only select tasks which are part of a process that has a variable with the given name set to the given value.
|
|
1724
|
+
*/
|
|
1725
|
+
processVariableValueEquals(variableName: string, variableValue: any): T;
|
|
1726
|
+
/**
|
|
1727
|
+
* Only select tasks which are part of a process that has at least one variable with the given value.
|
|
1728
|
+
*/
|
|
1729
|
+
processVariableValueEquals(variableValue: any): T;
|
|
1730
|
+
/**
|
|
1731
|
+
* Only select tasks which are part of a process that has a local string variable which is not the given value, case insensitive.
|
|
1732
|
+
* <p>
|
|
1733
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1734
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1735
|
+
* </p>
|
|
1736
|
+
*/
|
|
1737
|
+
processVariableValueEqualsIgnoreCase(name: string, value: string): T;
|
|
1738
|
+
/**
|
|
1739
|
+
* Only select tasks which have a variable with the given name, but with a different value than the passed value. Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1740
|
+
* wrappers) are not supported.
|
|
1741
|
+
*/
|
|
1742
|
+
processVariableValueNotEquals(variableName: string, variableValue: any): T;
|
|
1743
|
+
/**
|
|
1744
|
+
* Only select tasks which are part of a process that has a string variable with the given value, case insensitive.
|
|
1745
|
+
* <p>
|
|
1746
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1747
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1748
|
+
* </p>
|
|
1749
|
+
*/
|
|
1750
|
+
processVariableValueNotEqualsIgnoreCase(name: string, value: string): T;
|
|
1751
|
+
/**
|
|
1752
|
+
* Only select tasks which have a global variable value greater than the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1753
|
+
* wrappers) are not supported.
|
|
1754
|
+
*
|
|
1755
|
+
* @param name
|
|
1756
|
+
* cannot be null.
|
|
1757
|
+
* @param value
|
|
1758
|
+
* cannot be null.
|
|
1759
|
+
*/
|
|
1760
|
+
processVariableValueGreaterThan(name: string, value: any): T;
|
|
1761
|
+
/**
|
|
1762
|
+
* Only select tasks which have a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive
|
|
1763
|
+
* type wrappers) are not supported.
|
|
1764
|
+
*
|
|
1765
|
+
* @param name
|
|
1766
|
+
* cannot be null.
|
|
1767
|
+
* @param value
|
|
1768
|
+
* cannot be null.
|
|
1769
|
+
*/
|
|
1770
|
+
processVariableValueGreaterThanOrEqual(name: string, value: any): T;
|
|
1771
|
+
/**
|
|
1772
|
+
* Only select tasks which have a global variable value less than the passed value when the ended.Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers) are
|
|
1773
|
+
* not supported.
|
|
1774
|
+
*
|
|
1775
|
+
* @param name
|
|
1776
|
+
* cannot be null.
|
|
1777
|
+
* @param value
|
|
1778
|
+
* cannot be null.
|
|
1779
|
+
*/
|
|
1780
|
+
processVariableValueLessThan(name: string, value: any): T;
|
|
1781
|
+
/**
|
|
1782
|
+
* Only select tasks which have a global variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1783
|
+
* wrappers) are not supported.
|
|
1784
|
+
*
|
|
1785
|
+
* @param name
|
|
1786
|
+
* cannot be null.
|
|
1787
|
+
* @param value
|
|
1788
|
+
* cannot be null.
|
|
1789
|
+
*/
|
|
1790
|
+
processVariableValueLessThanOrEqual(name: string, value: any): T;
|
|
1791
|
+
/**
|
|
1792
|
+
* Only select tasks which have a global variable value like the given value when they ended. This can be used on string variables only.
|
|
1793
|
+
*
|
|
1794
|
+
* @param name
|
|
1795
|
+
* cannot be null.
|
|
1796
|
+
* @param value
|
|
1797
|
+
* cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1798
|
+
*/
|
|
1799
|
+
processVariableValueLike(name: string, value: string): T;
|
|
1800
|
+
/**
|
|
1801
|
+
* Only select tasks which have a global variable value like the given value (case insensitive) when they ended. This can be used on string variables only.
|
|
1802
|
+
*
|
|
1803
|
+
* @param name
|
|
1804
|
+
* cannot be null.
|
|
1805
|
+
* @param value
|
|
1806
|
+
* cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1807
|
+
*/
|
|
1808
|
+
processVariableValueLikeIgnoreCase(name: string, value: string): T;
|
|
1809
|
+
/**
|
|
1810
|
+
* Only select tasks which have a global variable with the given name.
|
|
1811
|
+
*
|
|
1812
|
+
* @param name
|
|
1813
|
+
* cannot be null.
|
|
1814
|
+
*/
|
|
1815
|
+
processVariableExists(name: string): T;
|
|
1816
|
+
/**
|
|
1817
|
+
* Only select tasks which does not have a global variable with the given name.
|
|
1818
|
+
*
|
|
1819
|
+
* @param name
|
|
1820
|
+
* cannot be null.
|
|
1821
|
+
*/
|
|
1822
|
+
processVariableNotExists(name: string): T;
|
|
1823
|
+
/**
|
|
1824
|
+
* Only select tasks which are part of a case that has a variable with the given name set to the given value.
|
|
1825
|
+
*/
|
|
1826
|
+
caseVariableValueEquals(variableName: string, variableValue: any): T;
|
|
1827
|
+
/**
|
|
1828
|
+
* Only select tasks which are part of a case that has at least one variable with the given value.
|
|
1829
|
+
*/
|
|
1830
|
+
caseVariableValueEquals(variableValue: any): T;
|
|
1831
|
+
/**
|
|
1832
|
+
* Only select tasks which are part of a case that has a local string variable which is not the given value, case insensitive.
|
|
1833
|
+
* <p>
|
|
1834
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1835
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1836
|
+
* </p>
|
|
1837
|
+
*/
|
|
1838
|
+
caseVariableValueEqualsIgnoreCase(name: string, value: string): T;
|
|
1839
|
+
/**
|
|
1840
|
+
* Only select tasks which have a variable with the given name, but with a different value than the passed value. Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1841
|
+
* wrappers) are not supported.
|
|
1842
|
+
*/
|
|
1843
|
+
caseVariableValueNotEquals(variableName: string, variableValue: any): T;
|
|
1844
|
+
/**
|
|
1845
|
+
* Only select tasks which are part of a case that has a string variable with the given value, case insensitive.
|
|
1846
|
+
* <p>
|
|
1847
|
+
* This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive
|
|
1848
|
+
* Collations available (<a href="http://msdn.microsoft.com/en-us/library/ms144250(v=sql.105).aspx" >MSDN Server Collation Reference</a>).
|
|
1849
|
+
* </p>
|
|
1850
|
+
*/
|
|
1851
|
+
caseVariableValueNotEqualsIgnoreCase(name: string, value: string): T;
|
|
1852
|
+
/**
|
|
1853
|
+
* Only select tasks which have a global variable value greater than the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1854
|
+
* wrappers) are not supported.
|
|
1855
|
+
*
|
|
1856
|
+
* @param name cannot be null.
|
|
1857
|
+
* @param value cannot be null.
|
|
1858
|
+
*/
|
|
1859
|
+
caseVariableValueGreaterThan(name: string, value: any): T;
|
|
1860
|
+
/**
|
|
1861
|
+
* Only select tasks which have a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive
|
|
1862
|
+
* type wrappers) are not supported.
|
|
1863
|
+
*
|
|
1864
|
+
* @param name cannot be null.
|
|
1865
|
+
* @param value cannot be null.
|
|
1866
|
+
*/
|
|
1867
|
+
caseVariableValueGreaterThanOrEqual(name: string, value: any): T;
|
|
1868
|
+
/**
|
|
1869
|
+
* Only select tasks which have a global variable value less than the passed value when the ended.Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type wrappers) are
|
|
1870
|
+
* not supported.
|
|
1871
|
+
*
|
|
1872
|
+
* @param name cannot be null.
|
|
1873
|
+
* @param value cannot be null.
|
|
1874
|
+
*/
|
|
1875
|
+
caseVariableValueLessThan(name: string, value: any): T;
|
|
1876
|
+
/**
|
|
1877
|
+
* Only select tasks which have a global variable value less than or equal to the passed value when they ended. Booleans, Byte-arrays and {@link Serializable} objects (which are not primitive type
|
|
1878
|
+
* wrappers) are not supported.
|
|
1879
|
+
*
|
|
1880
|
+
* @param name cannot be null.
|
|
1881
|
+
* @param value cannot be null.
|
|
1882
|
+
*/
|
|
1883
|
+
caseVariableValueLessThanOrEqual(name: string, value: any): T;
|
|
1884
|
+
/**
|
|
1885
|
+
* Only select tasks which have a global variable value like the given value when they ended. This can be used on string variables only.
|
|
1886
|
+
*
|
|
1887
|
+
* @param name cannot be null.
|
|
1888
|
+
* @param value cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1889
|
+
*/
|
|
1890
|
+
caseVariableValueLike(name: string, value: string): T;
|
|
1891
|
+
/**
|
|
1892
|
+
* Only select tasks which have a global variable value like the given value (case insensitive) when they ended. This can be used on string variables only.
|
|
1893
|
+
*
|
|
1894
|
+
* @param name cannot be null.
|
|
1895
|
+
* @param value cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
|
|
1896
|
+
*/
|
|
1897
|
+
caseVariableValueLikeIgnoreCase(name: string, value: string): T;
|
|
1898
|
+
/**
|
|
1899
|
+
* Only select tasks which have a global variable with the given name.
|
|
1900
|
+
*
|
|
1901
|
+
* @param name cannot be null.
|
|
1902
|
+
*/
|
|
1903
|
+
caseVariableExists(name: string): T;
|
|
1904
|
+
/**
|
|
1905
|
+
* Only select tasks which does not have a global variable with the given name.
|
|
1906
|
+
*
|
|
1907
|
+
* @param name cannot be null.
|
|
1908
|
+
*/
|
|
1909
|
+
caseVariableNotExists(name: string): T;
|
|
1910
|
+
/**
|
|
1911
|
+
* Only selects tasks which with the given root scope id
|
|
1912
|
+
*/
|
|
1913
|
+
taskRootScopeId(parentScopeId: string): T;
|
|
1914
|
+
/**
|
|
1915
|
+
* Only selects tasks which with the given parent scope id
|
|
1916
|
+
*/
|
|
1917
|
+
taskParentScopeId(parentScopeId: string): T;
|
|
1918
|
+
/**
|
|
1919
|
+
* Include local task variables in the task query result
|
|
1920
|
+
*/
|
|
1921
|
+
includeTaskLocalVariables(): T;
|
|
1922
|
+
/**
|
|
1923
|
+
* Include global process variables in the task query result
|
|
1924
|
+
*/
|
|
1925
|
+
includeProcessVariables(): T;
|
|
1926
|
+
/**
|
|
1927
|
+
* Include global case variables in the task query result
|
|
1928
|
+
*/
|
|
1929
|
+
includeCaseVariables(): T;
|
|
1930
|
+
/**
|
|
1931
|
+
* Include identity links in the task query result
|
|
1932
|
+
*/
|
|
1933
|
+
includeIdentityLinks(): T;
|
|
1934
|
+
/**
|
|
1935
|
+
* Localize task name and description to specified locale.
|
|
1936
|
+
*/
|
|
1937
|
+
locale(locale: string): T;
|
|
1938
|
+
/**
|
|
1939
|
+
* Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.
|
|
1940
|
+
*/
|
|
1941
|
+
withLocalizationFallback(): T;
|
|
1942
|
+
/**
|
|
1943
|
+
* All query clauses called will be added to a single or-statement. This or-statement will be included with the other already existing clauses in the query, joined by an 'and'.
|
|
1944
|
+
* <p>
|
|
1945
|
+
* Calling endOr() will add all clauses to the regular query again. Calling or() after or() has been called or calling endOr() after endOr() has been called will result in an exception.
|
|
1946
|
+
* It is possible to call or() endOr() several times if each or() has a matching endOr(), e.g.:
|
|
1947
|
+
* </p>
|
|
1948
|
+
* {@code query.<ConditionA>}
|
|
1949
|
+
* {@code .or().<conditionB>.<conditionC>.endOr()}
|
|
1950
|
+
* {@code .<conditionD>.<conditionE>}
|
|
1951
|
+
* {@code .or().<conditionF>.<conditionG>.endOr()}
|
|
1952
|
+
* <p>
|
|
1953
|
+
* will result in: conditionA & (conditionB | conditionC) & conditionD & conditionE & (conditionF | conditionG)
|
|
1954
|
+
*/
|
|
1955
|
+
or(): T;
|
|
1956
|
+
endOr(): T;
|
|
1957
|
+
/**
|
|
1958
|
+
* Order by task id (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1959
|
+
*/
|
|
1960
|
+
orderByTaskId(): T;
|
|
1961
|
+
/**
|
|
1962
|
+
* Order by task name (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1963
|
+
*/
|
|
1964
|
+
orderByTaskName(): T;
|
|
1965
|
+
/**
|
|
1966
|
+
* Order by description (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1967
|
+
*/
|
|
1968
|
+
orderByTaskDescription(): T;
|
|
1969
|
+
/**
|
|
1970
|
+
* Order by priority (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1971
|
+
*/
|
|
1972
|
+
orderByTaskPriority(): T;
|
|
1973
|
+
/**
|
|
1974
|
+
* Order by assignee (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1975
|
+
*/
|
|
1976
|
+
orderByTaskAssignee(): T;
|
|
1977
|
+
/**
|
|
1978
|
+
* Order by the time on which the tasks were created (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1979
|
+
*/
|
|
1980
|
+
orderByTaskCreateTime(): T;
|
|
1981
|
+
/**
|
|
1982
|
+
* Order by process instance id (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1983
|
+
*/
|
|
1984
|
+
orderByProcessInstanceId(): T;
|
|
1985
|
+
/**
|
|
1986
|
+
* Order by execution id (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1987
|
+
*/
|
|
1988
|
+
orderByExecutionId(): T;
|
|
1989
|
+
/**
|
|
1990
|
+
* Order by process definition id (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1991
|
+
*/
|
|
1992
|
+
orderByProcessDefinitionId(): T;
|
|
1993
|
+
/**
|
|
1994
|
+
* Order by task due date (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1995
|
+
*/
|
|
1996
|
+
orderByTaskDueDate(): T;
|
|
1997
|
+
/**
|
|
1998
|
+
* Order by task owner (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
1999
|
+
*/
|
|
2000
|
+
orderByTaskOwner(): T;
|
|
2001
|
+
/**
|
|
2002
|
+
* Order by task definition key (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
2003
|
+
*/
|
|
2004
|
+
orderByTaskDefinitionKey(): T;
|
|
2005
|
+
/**
|
|
2006
|
+
* Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
2007
|
+
*/
|
|
2008
|
+
orderByTenantId(): T;
|
|
2009
|
+
/**
|
|
2010
|
+
* Order by due date (needs to be followed by {@link #asc()} or {@link #desc()}). If any of the tasks have null for the due date, these will be first in the result.
|
|
2011
|
+
*/
|
|
2012
|
+
orderByDueDateNullsFirst(): T;
|
|
2013
|
+
/**
|
|
2014
|
+
* Order by due date (needs to be followed by {@link #asc()} or {@link #desc()}). If any of the tasks have null for the due date, these will be last in the result.
|
|
2015
|
+
*/
|
|
2016
|
+
orderByDueDateNullsLast(): T;
|
|
2017
|
+
/**
|
|
2018
|
+
* Order by category (needs to be followed by {@link #asc()} or {@link #desc()}).
|
|
2019
|
+
*/
|
|
2020
|
+
orderByCategory(): T;
|
|
2021
|
+
}
|
|
2022
|
+
export {};
|