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)

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	getColumnLayout(com.atlassian.crowd.embedded.api.User remoteUser, SearchRequest searchRequest) Get the columns layout for a searchRequest, if the searchRequest does not have one the user's columns are returned.
protected List	getColumnLayoutItems(String username, Set availableFields)
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
abstract EditableSearchRequestColumnLayout	getEditableSearchRequestColumnLayout(com.atlassian.crowd.embedded.api.User user, SearchRequest searchRequest) Get an editable column layout for the searchRequest, returns null if it does not have one
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
protected FieldManager	getFieldManager()
abstract boolean	hasColumnLayout(Long filterId)
abstract boolean	hasColumnLayout(SearchRequest searchRequest)
boolean	hasColumnLayout(com.atlassian.crowd.embedded.api.User user)
boolean	hasDefaultColumnLayout()
void	refresh()
protected void	removeColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV)
void	restoreDefaultColumnLayout()
abstract void	restoreSearchRequestColumnLayout(SearchRequest searchRequest)
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
abstract void	storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout) Writes the default column layout to permanent storage
void	storeEditableUserColumnLayout(EditableUserColumnLayout editableUserColumnLayout) Writes the default column layout to permanent storage
protected List	verifyColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV, Set availableFields)

Methods inherited from class java.lang.Object

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

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)

Method Detail

hasColumnLayout

public abstract boolean hasColumnLayout(SearchRequest searchRequest)
                                 throws ColumnLayoutStorageException

Specified by:

hasColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

hasColumnLayout

public abstract boolean hasColumnLayout(Long filterId)
                                 throws ColumnLayoutStorageException

Specified by:

hasColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

getEditableSearchRequestColumnLayout

public abstract EditableSearchRequestColumnLayout getEditableSearchRequestColumnLayout(com.atlassian.crowd.embedded.api.User user,
                                                                                       SearchRequest searchRequest)
                                                                                throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Get an editable column layout for the searchRequest, returns null if it does not have one

Specified by:

getEditableSearchRequestColumnLayout in interface ColumnLayoutManager

Returns:

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

Throws:

ColumnLayoutStorageException

storeEditableSearchRequestColumnLayout

public abstract void storeEditableSearchRequestColumnLayout(EditableSearchRequestColumnLayout editableSearchRequestColumnLayout)
                                                     throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Writes the default column layout to permanent storage

Specified by:

storeEditableSearchRequestColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

restoreSearchRequestColumnLayout

public abstract void restoreSearchRequestColumnLayout(SearchRequest searchRequest)
                                               throws ColumnLayoutStorageException

Specified by:

restoreSearchRequestColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

hasDefaultColumnLayout

public boolean hasDefaultColumnLayout()
                               throws ColumnLayoutStorageException

Specified by:

hasDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

hasColumnLayout

public boolean hasColumnLayout(com.atlassian.crowd.embedded.api.User user)
                        throws ColumnLayoutStorageException

Specified by:

hasColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

getColumnLayout

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

Description copied from interface: ColumnLayoutManager

Get the columns layout for a searchRequest, if the searchRequest does not have one the user's columns are returned. If the user does nto have one the default is returned

Specified by:

getColumnLayout in interface ColumnLayoutManager

Returns:

Immutable ColumnLayout to be used when displaying

Throws:

ColumnLayoutStorageException

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()
                                                           throws ColumnLayoutStorageException

Description copied from interface: ColumnLayoutManager

Get an editable default column layout for the system

Specified by:

getEditableDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

getEditableUserColumnLayout

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

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

Throws:

ColumnLayoutStorageException

getColumnLayoutItems

protected List getColumnLayoutItems(String username,
                                    Set availableFields)
                             throws ColumnLayoutStorageException

Throws:

ColumnLayoutStorageException

verifyColumnLayoutItems

protected List verifyColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV,
                                       Set availableFields)
                                throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

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

storeColumnLayoutItems

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

Throws:

org.ofbiz.core.entity.GenericEntityException

restoreDefaultColumnLayout

public void restoreDefaultColumnLayout()
                                throws ColumnLayoutStorageException

Specified by:

restoreDefaultColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

restoreUserColumnLayout

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

Specified by:

restoreUserColumnLayout in interface ColumnLayoutManager

Throws:

ColumnLayoutStorageException

removeColumnLayoutItems

protected void removeColumnLayoutItems(org.ofbiz.core.entity.GenericValue columnLayoutGV)
                                throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getFieldManager

protected FieldManager getFieldManager()