Package de.xima.fc.workflow.taglib.model
Class WorkflowExternalState
- java.lang.Object
-
- de.xima.fc.workflow.taglib.model.WorkflowExternalState
-
- All Implemented Interfaces:
Serializable
public final class WorkflowExternalState extends Object implements Serializable
External state implementation used forFlowchartModel.updateExternalState(com.alibaba.fastjson.JSONObject)
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static WorkflowExternalState
empty()
WorkflowExternalState
getAndClearChangedState(boolean reset)
Map<String,Map<String,ClientSubmitButtonView>>
getButtons()
Map<UUID,ClientClientCounterView>
getClientCounters()
Map<UUID,ClientClientResourceView>
getClientResources()
CustomViewSettings
getCustomViewSetings()
Map<UUID,ClientDirectClientAuthorizationView>
getDirectClientAuthorizations()
Map<UUID,ClientInboxView>
getInboxes()
Map<UUID,ClientProjectResourceView>
getProjectResources()
Map<UUID,ClientWorkflowStateView>
getStates()
Map<UUID,ClientTemplateView>
getTemplatesHtml()
Map<UUID,ClientTemplateView>
getTemplatesUrl()
Map<UUID,ClientUserGroupView>
getUserGroups()
Map<UUID,ClientUserView>
getUsers()
Deprecated.com.alibaba.fastjson.JSONObject
toJson()
void
updateButtons(Map<String,Map<String,ClientSubmitButtonView>> buttons)
Sets the button data to the given value and checks the dirty flag.void
updateClientCounters(Map<UUID,ClientClientCounterView> clientCounters)
Sets the client counter data to the given value and checks the dirty flag.void
updateClientResources(Map<UUID,ClientClientResourceView> clientResources)
Sets the client resource data to the given value and checks the dirty flag.void
updateCustomViewSettings(CustomViewSettings customViewSetings)
Sets the custom view settings data to the given value and checks the dirty flag.void
updateDirectClientAuthorizations(Map<UUID,ClientDirectClientAuthorizationView> directClientAuthorization)
Sets the direct client authorization data to the given value and checks the dirty flag.void
updateInboxes(Map<UUID,ClientInboxView> inboxes)
Sets the inbox data to the given value and checks the dirty flag.void
updateProjectResources(Map<UUID,ClientProjectResourceView> projectResources)
Sets the project resource data to the given value and checks the dirty flag.void
updateStates(Map<UUID,ClientWorkflowStateView> states)
Sets the workflow state data to the given value and checks the dirty flag.void
updateTemplatesHtml(Map<UUID,ClientTemplateView> templatesHtml)
Sets the HTML template data to the given value and checks the dirty flag.void
updateTemplatesUrl(Map<UUID,ClientTemplateView> templatesUrl)
Sets the URL template data to the given value and checks the dirty flag.void
updateUserGroups(Map<UUID,ClientUserGroupView> userGroups)
Sets the user group data to the given value and checks the dirty flag.void
updateUsers(Map<UUID,ClientUserView> users)
Deprecated.
-
-
-
Method Detail
-
getAndClearChangedState
public WorkflowExternalState getAndClearChangedState(boolean reset)
- Parameters:
reset
- Iftrue
, reset the dirty flags so that the next call to this method returns an empty state when no update* method was called the mean time.- Returns:
- A snapshot of this workflow state with only the data that has changed.
-
getButtons
@Nullable public Map<String,Map<String,ClientSubmitButtonView>> getButtons()
- Returns:
- A mapping
(qualifier, buttonName, data)
from the qualifier and button name to the button data.
-
getClientCounters
@Nullable public Map<UUID,ClientClientCounterView> getClientCounters()
- Returns:
- A map with each client counter view model mapped to its UUIDs.
-
getClientResources
@Nullable public Map<UUID,ClientClientResourceView> getClientResources()
- Returns:
- A map with each client resource view model mapped to its UUIDs.
-
getCustomViewSetings
@Nullable public CustomViewSettings getCustomViewSetings()
- Returns:
- The custom view settings for the workflow designer.
-
getDirectClientAuthorizations
public Map<UUID,ClientDirectClientAuthorizationView> getDirectClientAuthorizations()
- Returns:
- A map with each direct client authorization view model mapped to its UUIDs.
-
getInboxes
@Nullable public Map<UUID,ClientInboxView> getInboxes()
- Returns:
- A map with each inbox view model mapped to its UUIDs.
-
getProjectResources
@Nullable public Map<UUID,ClientProjectResourceView> getProjectResources()
- Returns:
- A map with each project resource view model mapped to its UUIDs.
-
getStates
@Nullable public Map<UUID,ClientWorkflowStateView> getStates()
- Returns:
- A map with each workflow state view model mapped to its UUIDs.
-
getTemplatesHtml
@Nullable public Map<UUID,ClientTemplateView> getTemplatesHtml()
- Returns:
- A map with each HTML template view model mapped to its UUIDs.
-
getTemplatesUrl
@Nullable public Map<UUID,ClientTemplateView> getTemplatesUrl()
- Returns:
- A map with each URL template view model mapped to its UUIDs.
-
getUserGroups
@Nullable public Map<UUID,ClientUserGroupView> getUserGroups()
- Returns:
- A map with each user group view model mapped to its UUIDs.
-
getUsers
@Nullable @Deprecated public Map<UUID,ClientUserView> getUsers()
Deprecated.- Returns:
- A map with each user view model mapped to its UUIDs.
-
toJson
public com.alibaba.fastjson.JSONObject toJson()
- Returns:
- This model serialized as JSON object.
-
updateButtons
public void updateButtons(Map<String,Map<String,ClientSubmitButtonView>> buttons)
Sets the button data to the given value and checks the dirty flag.- Parameters:
buttons
- New form button data.
-
updateClientCounters
public void updateClientCounters(Map<UUID,ClientClientCounterView> clientCounters)
Sets the client counter data to the given value and checks the dirty flag.- Parameters:
clientCounters
- New client counter data.
-
updateClientResources
public void updateClientResources(Map<UUID,ClientClientResourceView> clientResources)
Sets the client resource data to the given value and checks the dirty flag.- Parameters:
clientResources
- New client resource data.
-
updateCustomViewSettings
public void updateCustomViewSettings(CustomViewSettings customViewSetings)
Sets the custom view settings data to the given value and checks the dirty flag.- Parameters:
customViewSetings
- New custom view settings data.
-
updateDirectClientAuthorizations
public void updateDirectClientAuthorizations(Map<UUID,ClientDirectClientAuthorizationView> directClientAuthorization)
Sets the direct client authorization data to the given value and checks the dirty flag.- Parameters:
directClientAuthorization
- New direct client authorization data.
-
updateInboxes
public void updateInboxes(Map<UUID,ClientInboxView> inboxes)
Sets the inbox data to the given value and checks the dirty flag.- Parameters:
inboxes
- New inbox data.
-
updateProjectResources
public void updateProjectResources(Map<UUID,ClientProjectResourceView> projectResources)
Sets the project resource data to the given value and checks the dirty flag.- Parameters:
projectResources
- New project resource data.
-
updateStates
public void updateStates(Map<UUID,ClientWorkflowStateView> states)
Sets the workflow state data to the given value and checks the dirty flag.- Parameters:
states
- New workflow state data.
-
updateTemplatesHtml
public void updateTemplatesHtml(Map<UUID,ClientTemplateView> templatesHtml)
Sets the HTML template data to the given value and checks the dirty flag.- Parameters:
templatesHtml
- New HTML template data.
-
updateTemplatesUrl
public void updateTemplatesUrl(Map<UUID,ClientTemplateView> templatesUrl)
Sets the URL template data to the given value and checks the dirty flag.- Parameters:
templatesUrl
- New URL template data.
-
updateUserGroups
public void updateUserGroups(Map<UUID,ClientUserGroupView> userGroups)
Sets the user group data to the given value and checks the dirty flag.- Parameters:
userGroups
- New user group data.
-
updateUsers
@Deprecated public void updateUsers(Map<UUID,ClientUserView> users)
Deprecated.Sets the user data to the given value and checks the dirty flag.- Parameters:
users
- New user data.
-
empty
public static WorkflowExternalState empty()
- Returns:
- A new empty state with no data.
-
-