UserContentReturnable (Ametys 4.5.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
  - - org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdderReturnable
    - - org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
      - org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable
        
        org.ametys.plugins.userdirectory.service.search.UserContentReturnable

All Implemented Interfaces:

LogEnabled, PluginAware, Returnable, Initializable, Configurable, Contextualizable, Serviceable
```
public class UserContentReturnable
extends PrivateContentReturnable
```
Returnable for users' contents

Field Summary

Fields
Modifier and Type Field Description

static String PARAMETER_VIEW
The additional parameter for the view
- Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable
  _associatedContentSearchableRole, _avalonRole, _definitionPrefix, _shortAvalonRole
- Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
  _associatedContentSearchable, _contentFilterHelper, _contentHelper, _context, _label, _searchableEP
- Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
  _manager, _pluginName

Constructor Summary

Constructors
Constructor Description

UserContentReturnable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getViewForSax(AdditionalParameterValueMap additionalParameterValues)`	Gets the view for saxing
`protected Function<Query,Query>`	`siteQueryJoiner()`	The joiner for the site query

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable
_configureAssociatedContentReturnableRole, _getAssociatedSearchable, _initAvalonRole, _initDefinitionPrefix, _initShortAvalonRole, associatedContentSearchableRole, configure, getContentTypes, getDefinitionPrefix, getId, getSaxer

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
_setAssociatedContentSearchable, contextualize, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, service, sitemapQueryJoiner, tagQueryJoiner

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
additionalServiceParameters, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.Returnable
additionalServiceParameters, selectedByDefault

- Field Detail
  - PARAMETER_VIEW
```
public static final String PARAMETER_VIEW
```
    The additional parameter for the view
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserContentReturnable
```
public UserContentReturnable()
```
- Method Detail
  - getViewForSax
```
protected String getViewForSax(AdditionalParameterValueMap additionalParameterValues)
```
    Description copied from class: PrivateContentReturnable
    
    Gets the view for saxing
    
    Overrides:
    
    getViewForSax in class PrivateContentReturnable
    
    Parameters:
    
    additionalParameterValues - The additional parameter values
    
    Returns:
    
    the view for saxing
  - siteQueryJoiner
```
protected Function<Query,Query> siteQueryJoiner()
```
    Description copied from class: AbstractContentBasedReturnable
    
    The joiner for the site query
    
    Overrides:
    
    siteQueryJoiner in class AbstractContentBasedReturnable
    
    Returns:
    
    The joiner for the site query