org.nuxeo.dam.seam

Class DamSearchActions

java.lang.Object

org.nuxeo.dam.seam.DamSearchActions

All Implemented Interfaces:

Serializable

@Name(value="damSearchActions")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class DamSearchActions
extends Object
implements Serializable

Handles DAM search and permalinks related actions.

Since:

5.7

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_VIEW_NAME_PARAMETER
static String	CONTENT_VIEW_STATE_PARAMETER
static String	CURRENT_PAGE_PARAMETER
static String	DAM_CODEC
static String	DAM_FLAG
static String	PAGE_SIZE_PARAMETER
static String	SAVED_SEARCHES_LABEL
static String	SEARCH_FILTERS_LABEL
static String	SEARCH_SAVED_LABEL
static String	SHARED_SEARCHES_LABEL

Constructor Summary

Constructors

Constructor and Description
DamSearchActions()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearSearch()
List<javax.faces.model.SelectItem>	getAllSavedSearchesSelectItems()
String	getAssetPermanentLinkUrl() Deprecated. since 5.9.5. Use DamActions.getAssetPermanentLinkUrl(boolean).
Set<ContentViewHeader>	getContentViewHeaders()
List<String>	getContentViewNames()
String	getCurrentContentViewName()
String	getCurrentPage()
String	getCurrentSelectedSavedSearchId()
String	getJSONContentViewState()
String	getPageSize()
String	getSavedSearchTitle()
String	getSearchPermanentLinkUrl() Compute a permanent link for the current search.
String	loadPermanentLink(DocumentView docView)
void	loadSavedSearch(String contentViewName, DocumentModel searchDocument)
void	onContentViewPageProviderChanged(String contentViewName)
void	refreshAndRewind()
void	resetonFlush() Reset attributes.
String	saveSearch()
void	setCurrentContentViewName(String contentViewName)
void	setCurrentPage(String currentPage)
void	setCurrentSelectedSavedSearchId(String selectedSavedSearchId)
void	setPageSize(String pageSize)
void	setSavedSearchTitle(String savedSearchTitle)
void	setState(String state)
void	updateCurrentDocument()
void	updateCurrentDocument(PageProvider<DocumentModel> pageProvider)

Methods inherited from class java.lang.Object

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

Field Detail

SAVED_SEARCHES_LABEL

public static final String SAVED_SEARCHES_LABEL

See Also:

Constant Field Values

SHARED_SEARCHES_LABEL

public static final String SHARED_SEARCHES_LABEL

See Also:

Constant Field Values

SEARCH_FILTERS_LABEL

public static final String SEARCH_FILTERS_LABEL

See Also:

Constant Field Values

SEARCH_SAVED_LABEL

public static final String SEARCH_SAVED_LABEL

See Also:

Constant Field Values

DAM_FLAG

public static final String DAM_FLAG

See Also:

Constant Field Values

DAM_CODEC

public static final String DAM_CODEC

See Also:

Constant Field Values

CONTENT_VIEW_NAME_PARAMETER

public static final String CONTENT_VIEW_NAME_PARAMETER

See Also:

Constant Field Values

CURRENT_PAGE_PARAMETER

public static final String CURRENT_PAGE_PARAMETER

See Also:

Constant Field Values

PAGE_SIZE_PARAMETER

public static final String PAGE_SIZE_PARAMETER

See Also:

Constant Field Values

CONTENT_VIEW_STATE_PARAMETER

public static final String CONTENT_VIEW_STATE_PARAMETER

See Also:

Constant Field Values

Constructor Detail

DamSearchActions

public DamSearchActions()

Method Detail

getJSONContentViewState

public String getJSONContentViewState()
                               throws ClientException,
                                      UnsupportedEncodingException

Throws:

ClientException

UnsupportedEncodingException

Since:

5.9.1

getCurrentContentViewName

public String getCurrentContentViewName()

setCurrentContentViewName

public void setCurrentContentViewName(String contentViewName)
                               throws ClientException

Throws:

ClientException

getCurrentSelectedSavedSearchId

public String getCurrentSelectedSavedSearchId()

setCurrentSelectedSavedSearchId

public void setCurrentSelectedSavedSearchId(String selectedSavedSearchId)
                                     throws ClientException

Throws:

ClientException

loadSavedSearch

public void loadSavedSearch(String contentViewName,
                   DocumentModel searchDocument)
                     throws ClientException

Throws:

ClientException

getContentViewNames

public List<String> getContentViewNames()

getContentViewHeaders

public Set<ContentViewHeader> getContentViewHeaders()
                                             throws ClientException

Throws:

ClientException

clearSearch

public void clearSearch()
                 throws ClientException

Throws:

ClientException

refreshAndRewind

@Observer(value="refreshDamSearch",
          create=true)
public void refreshAndRewind()
                      throws ClientException

Throws:

ClientException

updateCurrentDocument

public void updateCurrentDocument()
                           throws ClientException

Throws:

ClientException

updateCurrentDocument

public void updateCurrentDocument(PageProvider<DocumentModel> pageProvider)
                           throws ClientException

Throws:

ClientException

getAllSavedSearchesSelectItems

public List<javax.faces.model.SelectItem> getAllSavedSearchesSelectItems()
                                                                  throws ClientException

Throws:

ClientException

getSavedSearchTitle

public String getSavedSearchTitle()

setSavedSearchTitle

public void setSavedSearchTitle(String savedSearchTitle)

saveSearch

public String saveSearch()
                  throws ClientException

Throws:

ClientException

setState

public void setState(String state)
              throws ClientException,
                     UnsupportedEncodingException

Throws:

ClientException

UnsupportedEncodingException

getCurrentPage

public String getCurrentPage()

setCurrentPage

public void setCurrentPage(String currentPage)

getPageSize

public String getPageSize()

setPageSize

public void setPageSize(String pageSize)

getSearchPermanentLinkUrl

public String getSearchPermanentLinkUrl()
                                 throws ClientException,
                                        UnsupportedEncodingException

Compute a permanent link for the current search.

Throws:

ClientException

UnsupportedEncodingException

getAssetPermanentLinkUrl

@Deprecated
public String getAssetPermanentLinkUrl()
                                throws ClientException,
                                       UnsupportedEncodingException

Deprecated. since 5.9.5. Use DamActions.getAssetPermanentLinkUrl(boolean).

Throws:

ClientException

UnsupportedEncodingException

loadPermanentLink

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String loadPermanentLink(DocumentView docView)
                         throws ClientException

Throws:

ClientException

onContentViewPageProviderChanged

@Observer(value={"contentViewPageChanged","contentViewPageSizeChanged","contentViewRefresh"},
          create=true)
public void onContentViewPageProviderChanged(String contentViewName)
                                      throws ClientException

Throws:

ClientException

resetonFlush

@Observer(value="flush",
          create=false)
@BypassInterceptors
public void resetonFlush()

Reset attributes.

Since:

5.7.2