Package de.xima.fc.inbox.model

Class ProcessGUIModel

java.lang.Object

de.xima.fc.inbox.model.ProcessGUIModel

All Implemented Interfaces:

Serializable

public class ProcessGUIModel
extends Object
implements Serializable

Model that holds information necessary for displaying a process

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessGUIModel.Builder	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PARAM_STATUS_ID
static String	PARAM_STYLE_CLASS_ATTACHMENT
static String	PARAM_STYLE_CLASS_CLOSE
static String	PARAM_STYLE_CLASS_CONVERT_VERSION
static String	PARAM_STYLE_CLASS_CREATE_PDF
static String	PARAM_STYLE_CLASS_DELETE
static String	PARAM_STYLE_CLASS_MARK_READ
static String	PARAM_STYLE_CLASS_MARK_UNREAD
static String	PARAM_STYLE_CLASS_OPEN_IN_NEW_WINDOW
static String	PARAM_STYLE_CLASS_XPAGE
static String	PARAM_STYLE_CLASS_XPAGES
static String	PARAM_TAB_ACTION

Method Summary

Modifier and Type	Method	Description
static ProcessGUIModel.Builder	create(Vorgang process, Locale locale)	Deprecated.
static ProcessGUIModel.Builder	create(ProcessGUIModel processGUI)	Deprecated.
static ProcessGUIModel	forInboxView(Long formRecordId, EProcessView processView, Locale locale, IUser user, String baseUrl)
static ProcessGUIModel	forStandaloneView(javax.faces.context.FacesContext facesContext, Locale defaultLocale, IUser user)
IProjectVersionModel	getActiveProjectVersion()
List<Status>	getAvailableFollowStates()
List<Status>	getAvailableStates()	Deprecated.
List<Status>	getAvailableStatesForAdvancedDialog()
List<InvokableTaskModel>	getAvailableTasks()
IProjectVersionModel	getCurrentlySelectedProjectVersion()
String	getCurrentPageDisplayName()
String	getCurrentPageIcon()
String	getCurrentPageName()
org.primefaces.model.TreeNode<FormFieldDataModel>	getDataRoot()
List<Map<String,String>>	getFormFieldData()	Deprecated.
List<javax.faces.model.SelectItem>	getFormProcessTypes()
IProjectVersionModel	getFormRecordProjectVersion()
String	getFormReviewUrl()
String	getInboxReviewUrl()
List<String>	getPageNames()
Vorgang	getProcess()
EProcessView	getProcessView()
List<IFormRecordJobDetailsModel>	getQuartzDetails()
String	getStateDisplayName()
void	gotoFormPage(String pageName)
boolean	isCanSubmitForm()
boolean	isCanSubmitFormVersion()
boolean	isCurrentFormversion()	Deprecated.
boolean	isCurrentFormversionActive()
boolean	isCurrentViewAccessible()
boolean	isFormRecordAccessible()
boolean	isFormRecordDataLocked()
boolean	isPendingDoubleOptIn()
boolean	isShowAdvancedMenu()
boolean	isShowInvokeTaskMenu()
boolean	isShowStatusChangeMenu()
boolean	isShowViewActions(EProcessView processView)
boolean	isStandaloneView()
boolean	isUseActiveProjectVersion()
boolean	isUsesNewWorkflow()
boolean	isViewAccessible(EProcessView processView)
boolean	isWaitingForDoiVerification()
boolean	isWorkflowInvalid()
void	setCurrentFormversion(boolean isCurrentFormversion)	Deprecated.
void	setFormProcessTypes(List<javax.faces.model.SelectItem> formProcessTypes)
void	setProcess(Vorgang process)	Deprecated.
void	setProcessView(EProcessView processView)
void	setUseActiveProjectVersion(boolean useActiveProjectVersion)
void	unlock()
void	updateData(IUser user)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_TAB_ACTION

public static final String PARAM_TAB_ACTION

See Also:

Constant Field Values

PARAM_STATUS_ID

public static final String PARAM_STATUS_ID

See Also:

Constant Field Values

PARAM_STYLE_CLASS_DELETE

public static final String PARAM_STYLE_CLASS_DELETE

See Also:

Constant Field Values

PARAM_STYLE_CLASS_OPEN_IN_NEW_WINDOW

public static final String PARAM_STYLE_CLASS_OPEN_IN_NEW_WINDOW

See Also:

Constant Field Values

PARAM_STYLE_CLASS_CLOSE

public static final String PARAM_STYLE_CLASS_CLOSE

See Also:

Constant Field Values

PARAM_STYLE_CLASS_MARK_READ

public static final String PARAM_STYLE_CLASS_MARK_READ

See Also:

Constant Field Values

PARAM_STYLE_CLASS_MARK_UNREAD

public static final String PARAM_STYLE_CLASS_MARK_UNREAD

See Also:

Constant Field Values

PARAM_STYLE_CLASS_ATTACHMENT

public static final String PARAM_STYLE_CLASS_ATTACHMENT

See Also:

Constant Field Values

PARAM_STYLE_CLASS_CONVERT_VERSION

public static final String PARAM_STYLE_CLASS_CONVERT_VERSION

See Also:

Constant Field Values

PARAM_STYLE_CLASS_CREATE_PDF

public static final String PARAM_STYLE_CLASS_CREATE_PDF

See Also:

Constant Field Values

PARAM_STYLE_CLASS_XPAGE

public static final String PARAM_STYLE_CLASS_XPAGE

See Also:

Constant Field Values

PARAM_STYLE_CLASS_XPAGES

public static final String PARAM_STYLE_CLASS_XPAGES

See Also:

Constant Field Values

Method Detail

getProcess

public Vorgang getProcess()

setProcess

@Deprecated
public void setProcess(Vorgang process)

Deprecated.

getProcessView

public EProcessView getProcessView()

setProcessView

public void setProcessView(EProcessView processView)

isCanSubmitForm

public boolean isCanSubmitForm()

isUsesNewWorkflow

public boolean isUsesNewWorkflow()

isPendingDoubleOptIn

public boolean isPendingDoubleOptIn()

Returns:

Whether a double opt-in process is still in progress.

isShowAdvancedMenu

public boolean isShowAdvancedMenu()

Returns:

Whether the advanced processing menu is shown.

isShowStatusChangeMenu

public boolean isShowStatusChangeMenu()

Returns:

Whether the menu for performing a state change is shown (old workflow engine only).

isShowInvokeTaskMenu

public boolean isShowInvokeTaskMenu()

Returns:

Whether the menu for invoking a workflow trigger is shown (new workflow engine only).

getFormProcessTypes

public List<javax.faces.model.SelectItem> getFormProcessTypes()

Returns:

Available form process types for the advanced menu.

setFormProcessTypes

public void setFormProcessTypes(List<javax.faces.model.SelectItem> formProcessTypes)

isFormRecordAccessible

public boolean isFormRecordAccessible()

isStandaloneView

public boolean isStandaloneView()

getFormReviewUrl

public String getFormReviewUrl()

getInboxReviewUrl

public String getInboxReviewUrl()

isUseActiveProjectVersion

public boolean isUseActiveProjectVersion()

setUseActiveProjectVersion

public void setUseActiveProjectVersion(boolean useActiveProjectVersion)

getDataRoot

public org.primefaces.model.TreeNode<FormFieldDataModel> getDataRoot()

getCurrentPageName

public String getCurrentPageName()

getCurrentPageDisplayName

public String getCurrentPageDisplayName()

getCurrentPageIcon

public String getCurrentPageIcon()

getStateDisplayName

public String getStateDisplayName()

getPageNames

public List<String> getPageNames()

getAvailableFollowStates

public List<Status> getAvailableFollowStates()

Returns:

All following states to the current state of the old workflow engine to which the user may perform a state change in the inbox.

getAvailableStatesForAdvancedDialog

public List<Status> getAvailableStatesForAdvancedDialog()

getAvailableTasks

public List<InvokableTaskModel> getAvailableTasks()

Returns:

All tasks of the new workflow engine that may be initiated by the current user in the inbox.

getQuartzDetails

public List<IFormRecordJobDetailsModel> getQuartzDetails()

getFormRecordProjectVersion

public IProjectVersionModel getFormRecordProjectVersion()

getActiveProjectVersion

public IProjectVersionModel getActiveProjectVersion()

isCurrentFormversionActive

public boolean isCurrentFormversionActive()

getCurrentlySelectedProjectVersion

public IProjectVersionModel getCurrentlySelectedProjectVersion()

isFormRecordDataLocked

public boolean isFormRecordDataLocked()

isCurrentViewAccessible

public boolean isCurrentViewAccessible()

isViewAccessible

public boolean isViewAccessible(EProcessView processView)

isWorkflowInvalid

public boolean isWorkflowInvalid()

isShowViewActions

public boolean isShowViewActions(EProcessView processView)

isWaitingForDoiVerification

public boolean isWaitingForDoiVerification()

isCanSubmitFormVersion

public boolean isCanSubmitFormVersion()

unlock

public void unlock()

gotoFormPage

public void gotoFormPage(String pageName)

updateData

public void updateData(IUser user)

forStandaloneView

public static final ProcessGUIModel forStandaloneView(javax.faces.context.FacesContext facesContext,
                                                      Locale defaultLocale,
                                                      IUser user)

forInboxView

public static final ProcessGUIModel forInboxView(Long formRecordId,
                                                 EProcessView processView,
                                                 Locale locale,
                                                 IUser user,
                                                 String baseUrl)

getAvailableStates

@Deprecated
public List<Status> getAvailableStates()

Deprecated.

Returns:

All states of the old workflow engine to which the user may perform a state change in the inbox (via the advanced dialog).

getFormFieldData

@Deprecated
public List<Map<String,String>> getFormFieldData()

Deprecated.

isCurrentFormversion

@Deprecated
public boolean isCurrentFormversion()

Deprecated.

setCurrentFormversion

@Deprecated
public void setCurrentFormversion(boolean isCurrentFormversion)

Deprecated.

create

@Deprecated
public static final ProcessGUIModel.Builder create(Vorgang process,
                                                   Locale locale)

Deprecated.

create

@Deprecated
public static final ProcessGUIModel.Builder create(ProcessGUIModel processGUI)

Deprecated.