Class InboxPreferences

java.lang.Object

de.xima.fc.mdl.profile.InboxPreferences

All Implemented Interfaces:

Serializable

public class InboxPreferences
extends Object
implements Serializable

Model for preferences of a UserProfile regarding the form inbox.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InboxPreferences()

Method Summary

Modifier and Type	Method	Description
List<InboxViewConfig>	getInboxViewConfigs()
InboxViewConfig	inboxViewConfigBy(Long mandantId, String viewType, Long viewId, boolean create)	Looks for a configuration matching the provided client ID, view type and view ID and returns it.
Boolean	isVerticalLayout()
void	setInboxViewConfigs(List<InboxViewConfig> inboxViewConfigs)
void	setVerticalLayout(Boolean vertLayout)
boolean	updateViewConfig(Long mandantId, String viewType, Long viewId, String sortField, boolean sortAsc)	Updates (if present) or creates (if not present) the view configuration belonging to the passed client ID, view type and view ID with the provided sorting parameters.

Methods inherited from class Object

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

Constructor Details

InboxPreferences

public InboxPreferences()

Method Details

isVerticalLayout

public Boolean isVerticalLayout()

setVerticalLayout

public void setVerticalLayout(Boolean vertLayout)

getInboxViewConfigs

public List<InboxViewConfig> getInboxViewConfigs()

setInboxViewConfigs

public void setInboxViewConfigs(List<InboxViewConfig> inboxViewConfigs)

inboxViewConfigBy

public InboxViewConfig inboxViewConfigBy(Long mandantId,
 String viewType,
 Long viewId,
 boolean create)

Looks for a configuration matching the provided client ID, view type and view ID and returns it. If no such configuration could be found and the passed create flag is true, a new one will be created and returned. If the flag is false and no matching configuration was found, null will be returned.

Parameters:

mandantId - ID of the current client

viewType - the type of the view (see de.xima.fc.inbox.enums.EProcessListView)

viewId - the ID of the related de.xima.fc.inbox.model.ProjectView

create - if true and no config for the given parameters could be found, one will be created and returned

Returns:

an existing or a newly created configuration or null

updateViewConfig

public boolean updateViewConfig(Long mandantId,
 String viewType,
 Long viewId,
 String sortField,
 boolean sortAsc)

Updates (if present) or creates (if not present) the view configuration belonging to the passed client ID, view type and view ID with the provided sorting parameters.

Parameters:

mandantId - ID of the current client

viewType - the type of the view (see de.xima.fc.inbox.enums.EProcessListView)

viewId - the ID of the related de.xima.fc.inbox.model.ProjectView

sortField - the name of the field to sort by

sortAsc - flag for the sort order

Returns:

true, if there were changes (i.e. a new configuration was created or an existing one was changed), false, if neither sort field nor sort direction of an existing configuration has changed.