com.atlassian.jira.issue.fields.layout.column
Class AbstractColumnLayoutManager

java.lang.Object
  com.atlassian.jira.issue.fields.layout.column.AbstractColumnLayoutManager

All Implemented Interfaces:

ColumnLayoutManager

Direct Known Subclasses:

DefaultColumnLayoutManager

public abstract class AbstractColumnLayoutManager
extends Object
implements ColumnLayoutManager

Field Summary

protected static int	DEFAULT_CACHE_SIZE
protected OfBizDelegator	ofBizDelegator

Constructor Summary

AbstractColumnLayoutManager(FieldManager fieldManager, OfBizDelegator ofBizDelegator, UserKeyService userKeyService)

Method Summary

ColumnLayout	getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser) Get the columns layout for a user, if the user does not have one the default is returned
ColumnLayout	getDefaultColumnLayout()
ColumnLayout	getDefaultColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser) Get the default Layout, and filter out the columns which a user cannot see
EditableDefaultColumnLayout	getEditableDefaultColumnLayout() Get an editable default column layout for the system
EditableUserColumnLayout	getEditableUserColumnLayout(com.atlassian.crowd.embedded.api.User user) Get an editable column layout for the user, returns null if they do not have one
void	refresh()
void	restoreDefaultColumnLayout() Sets the ColumnLayout in use for users who have not defined their own, also known as the System column layout.
void	restoreUserColumnLayout(com.atlassian.crowd.embedded.api.User user)
protected void	storeColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV, ColumnLayout columnLayout)
void	storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout) Writes the default column layout to permanent storage
void	storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout) Writes the default column layout to permanent storage

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.issue.fields.layout.column.ColumnLayoutManager

getColumnLayout, getEditableSearchRequestColumnLayout, hasColumnLayout, hasColumnLayout, hasColumnLayout, hasDefaultColumnLayout, restoreSearchRequestColumnLayout, storeEditableSearchRequestColumnLayout

Field Detail

DEFAULT_CACHE_SIZE

protected static final int DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

ofBizDelegator

protected final OfBizDelegator ofBizDelegator

Constructor Detail

AbstractColumnLayoutManager

public AbstractColumnLayoutManager(FieldManager fieldManager,
                                   OfBizDelegator ofBizDelegator,
                                   UserKeyService userKeyService)

Method Detail

getColumnLayout

public ColumnLayout getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser)
                             throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Get the columns layout for a user, if the user does not have one the default is returned

Specified by:

getColumnLayout in interface ColumnLayoutManager

Returns:

Immutable ColumnLayout to be used when displaying

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

public ColumnLayout getDefaultColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser)
                                    throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Get the default Layout, and filter out the columns which a user cannot see

Specified by:

getDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

getDefaultColumnLayout

public ColumnLayout getDefaultColumnLayout()
                                    throws ColumnLayoutStorageException

Specified by:

getDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

refresh

public void refresh()

Specified by:

refresh in interface ColumnLayoutManager

getEditableDefaultColumnLayout

public EditableDefaultColumnLayout getEditableDefaultColumnLayout()

Description copied from interface: ColumnLayoutManager

Get an editable default column layout for the system

Specified by:

getEditableDefaultColumnLayout in interface ColumnLayoutManager

getEditableUserColumnLayout

public EditableUserColumnLayout getEditableUserColumnLayout(com.atlassian.crowd.embedded.api.User user)

Description copied from interface: ColumnLayoutManager

Get an editable column layout for the user, returns null if they do not have one

Specified by:

getEditableUserColumnLayout in interface ColumnLayoutManager

Returns:

EditableColumnLayout if there is one for the user otherwise return a new one generated from the default

storeEditableDefaultColumnLayout

public void storeEditableDefaultColumnLayout(EditableDefaultColumnLayout editableDefaultColumnLayout)
                                      throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Writes the default column layout to permanent storage

Specified by:

storeEditableDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

storeEditableUserColumnLayout

public void storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout)
                                   throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Writes the default column layout to permanent storage

Specified by:

storeEditableUserColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

restoreDefaultColumnLayout

public void restoreDefaultColumnLayout()

Description copied from interface: ColumnLayoutManager

Sets the ColumnLayout in use for users who have not defined their own, also known as the System column layout.

Specified by:

restoreDefaultColumnLayout in interface ColumnLayoutManager

restoreUserColumnLayout

public void restoreUserColumnLayout(com.atlassian.crowd.embedded.api.User user)

Specified by:

restoreUserColumnLayout in interface ColumnLayoutManager

storeColumnLayoutItems

protected void storeColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV,
                                      ColumnLayout columnLayout)
                               throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException