Package com.flowable.workobject.engine.impl

Class WorkObjectServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<WorkObjectEngineConfiguration>

com.flowable.workobject.engine.impl.WorkObjectServiceImpl

All Implemented Interfaces:

WorkObjectService

public class WorkObjectServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<WorkObjectEngineConfiguration>
implements WorkObjectService

Author:

Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
WorkObjectServiceImpl(WorkObjectEngineConfiguration engineConfig)

Method Summary

Modifier and Type	Method	Description
void	addGroupIdentityLink(java.lang.String workObjectId, java.lang.String groupId, java.lang.String identityLinkType)	Involves a group with a work object.
void	addParticipantGroup(java.lang.String workObjectId, java.lang.String groupId)	Convenience shorthand for WorkObjectService.addGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
void	addParticipantUser(java.lang.String workObjectId, java.lang.String userId)	Convenience shorthand for WorkObjectService.addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
void	addUserIdentityLink(java.lang.String workObjectId, java.lang.String userId, java.lang.String identityLinkType)	Involves a user with a work object.
WorkObject	createWorkObject(java.lang.String definitionKey, java.lang.String parentId, java.lang.String parentType, java.lang.String tenantId)	Creates new WorkObject according to provided definitionKey.
WorkObjectQuery	createWorkObjectQuery()	Creates a new WorkObjectQuery instance, that can be used to query the runtime work objects.
WorkObjectUpdater	createWorkObjectUpdater(WorkObject workObject)
void	deleteGroupIdentityLink(java.lang.String workObjectId, java.lang.String groupId, java.lang.String identityLinkType)	Removes the association between a group and a work object for the given identityLinkType.
void	deleteParticipantGroup(java.lang.String workObjectId, java.lang.String groupId)	Convenience shorthand for WorkObjectService.deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
void	deleteParticipantUser(java.lang.String workObjectId, java.lang.String userId)	Convenience shorthand for WorkObjectService.deleteUserIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT
void	deleteUserIdentityLink(java.lang.String workObjectId, java.lang.String userId, java.lang.String identityLinkType)	Removes the association between a user and a work object for the given identityLinkType.
void	deleteWorkObject(java.lang.String workObjectId)	Deletes work object
java.lang.String	getFirstWorkObjectId(java.lang.String underlyingObjectId, java.lang.String underlyingObjectType)	Fetch the first WorkObject id from the underlying object type.
java.util.List<org.flowable.identitylink.api.IdentityLink>	getIdentityLinksForWorkObject(java.lang.String instanceId)	Retrieves the IdentityLinks associated with the given work object.
java.lang.String	getParentId(java.lang.String workObjectId)	Gets parent identifier for the given workObjectId
void	removeVariable(java.lang.String workObjectId, java.lang.String name)	Removes variable from a given workObject
void	updateVariable(java.lang.String workObjectId, java.lang.String name, java.lang.Object value)	Updates/creates a variable for a given workObject
WorkObject	updateWorkObject(WorkObject workObject)	Based on the WorkObject.getId() update workObject attributes.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkObjectServiceImpl

public WorkObjectServiceImpl(WorkObjectEngineConfiguration engineConfig)

Method Details

updateVariable

public void updateVariable(java.lang.String workObjectId, java.lang.String name, java.lang.Object value)

Description copied from interface: WorkObjectService

Updates/creates a variable for a given workObject

Specified by:

updateVariable in interface WorkObjectService

Parameters:

workObjectId - workObject identifier

name - variable name

value - new variable value

removeVariable

public void removeVariable(java.lang.String workObjectId, java.lang.String name)

Description copied from interface: WorkObjectService

Removes variable from a given workObject

Specified by:

removeVariable in interface WorkObjectService

Parameters:

workObjectId - workObject identifier

name - of the variable to remove

createWorkObjectQuery

public WorkObjectQuery createWorkObjectQuery()

Description copied from interface: WorkObjectService

Creates a new WorkObjectQuery instance, that can be used to query the runtime work objects.

Specified by:

createWorkObjectQuery in interface WorkObjectService

createWorkObject

public WorkObject createWorkObject(java.lang.String definitionKey, java.lang.String parentId, java.lang.String parentType, java.lang.String tenantId)

Description copied from interface: WorkObjectService

Creates new WorkObject according to provided definitionKey. DefinitionKey identifies the latest version of the WorkObjectDefinition

Specified by:

createWorkObject in interface WorkObjectService

Parameters:

definitionKey - definition according which new workObject will be created

parentId - workObject is created as a child of the parent

parentType - parent reference type identifier

tenantId - tenantId which is used to determine definition

Returns:

workObject created according to definition

updateWorkObject

public WorkObject updateWorkObject(WorkObject workObject)

Description copied from interface: WorkObjectService

Based on the WorkObject.getId() update workObject attributes. To update workObject variable use WorkObjectService.updateVariable(String, String, Object)

Specified by:

updateWorkObject in interface WorkObjectService

Parameters:

workObject - work object to update

Returns:

updated work object

deleteWorkObject

public void deleteWorkObject(java.lang.String workObjectId)

Description copied from interface: WorkObjectService

Deletes work object

Specified by:

deleteWorkObject in interface WorkObjectService

Parameters:

workObjectId - work object identifier

getFirstWorkObjectId

public java.lang.String getFirstWorkObjectId(java.lang.String underlyingObjectId, java.lang.String underlyingObjectType)

Description copied from interface: WorkObjectService

Fetch the first WorkObject id from the underlying object type.

Specified by:

getFirstWorkObjectId in interface WorkObjectService

Parameters:

underlyingObjectId - underlying object identifier

underlyingObjectType - underlying object relation ship descriptor

Returns:

the first WorkObject id which is the parent of the specified underlying object

createWorkObjectUpdater

public WorkObjectUpdater createWorkObjectUpdater(WorkObject workObject)

Specified by:

createWorkObjectUpdater in interface WorkObjectService

addUserIdentityLink

public void addUserIdentityLink(java.lang.String workObjectId, java.lang.String userId, java.lang.String identityLinkType)

Description copied from interface: WorkObjectService

Involves a user with a work object. The type of identity link is defined by the given identityLinkType.

Specified by:

addUserIdentityLink in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

userId - id of the user involve, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

addGroupIdentityLink

public void addGroupIdentityLink(java.lang.String workObjectId, java.lang.String groupId, java.lang.String identityLinkType)

Description copied from interface: WorkObjectService

Involves a group with a work object. The type of identityLink is defined by the given identityLink.

Specified by:

addGroupIdentityLink in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

groupId - id of the group to involve, cannot be null.

identityLinkType - type of identity, cannot be null (@see IdentityLinkType).

addParticipantUser

public void addParticipantUser(java.lang.String workObjectId, java.lang.String userId)

Description copied from interface: WorkObjectService

Convenience shorthand for WorkObjectService.addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE

Specified by:

addParticipantUser in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

userId - id of the user to use as candidate, cannot be null.

addParticipantGroup

public void addParticipantGroup(java.lang.String workObjectId, java.lang.String groupId)

Description copied from interface: WorkObjectService

Convenience shorthand for WorkObjectService.addGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT

Specified by:

addParticipantGroup in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

groupId - id of the group to use as candidate, cannot be null.

deleteParticipantUser

public void deleteParticipantUser(java.lang.String workObjectId, java.lang.String userId)

Description copied from interface: WorkObjectService

Convenience shorthand for WorkObjectService.deleteUserIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT

Specified by:

deleteParticipantUser in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

userId - id of the user to use as candidate, cannot be null.

deleteParticipantGroup

public void deleteParticipantGroup(java.lang.String workObjectId, java.lang.String groupId)

Description copied from interface: WorkObjectService

Convenience shorthand for WorkObjectService.deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.PARTICIPANT

Specified by:

deleteParticipantGroup in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

groupId - id of the group to use as candidate, cannot be null.

deleteUserIdentityLink

public void deleteUserIdentityLink(java.lang.String workObjectId, java.lang.String userId, java.lang.String identityLinkType)

Description copied from interface: WorkObjectService

Removes the association between a user and a work object for the given identityLinkType.

Specified by:

deleteUserIdentityLink in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

userId - id of the user involve, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

deleteGroupIdentityLink

public void deleteGroupIdentityLink(java.lang.String workObjectId, java.lang.String groupId, java.lang.String identityLinkType)

Description copied from interface: WorkObjectService

Removes the association between a group and a work object for the given identityLinkType.

Specified by:

deleteGroupIdentityLink in interface WorkObjectService

Parameters:

workObjectId - id of the work object, cannot be null.

groupId - id of the group to involve, cannot be null.

identityLinkType - type of identity, cannot be null (@see IdentityLinkType).

getIdentityLinksForWorkObject

public java.util.List<org.flowable.identitylink.api.IdentityLink> getIdentityLinksForWorkObject(java.lang.String instanceId)

Description copied from interface: WorkObjectService

Retrieves the IdentityLinks associated with the given work object. Such an IdentityLink informs how a certain user is involved with a work object.

Specified by:

getIdentityLinksForWorkObject in interface WorkObjectService

getParentId

public java.lang.String getParentId(java.lang.String workObjectId)

Description copied from interface: WorkObjectService

Gets parent identifier for the given workObjectId

Specified by:

getParentId in interface WorkObjectService

Parameters:

workObjectId - child object identifier

Returns:

parent workObject identifier or null in the case when workObject is root already