Package org.ametys.plugins.calendar.search

Class CalendarSearchService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.web.frontoffice.search.SearchService

org.ametys.plugins.calendar.search.CalendarSearchService

All Implemented Interfaces:

Model, ModelItemAccessor, ModelItemContainer, LogEnabled, PluginAware, Labelable, Service, Disposable, Configurable, Contextualizable, Serviceable

public class CalendarSearchService
extends SearchService

Calendar search service

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLE_CALENDAR_PARAMETER_NAME	Parameter to enable calendar search components
static final String	END_DATE_ATTRIBUTE_NAME	Attribute name for content's end date
static final String	PARAM_END_DATE	Parameter for end date
static final String	PARAM_START_DATE	Parameter for start date
static final String	PARAM_SUBMIT	Parameter for selected tags
static final String	PARAM_TAGS	Parameter for selected tags
static final String	SERVICE_ID	Id of service
static final String	SERVICE_PARAM_CONTENT_TYPES	Service parameter for calendar content types
static final String	SERVICE_PARAM_CONTENT_VIEW	Service parameter for contents' view
static final String	SERVICE_PARAM_SAVE_USER_PREFS	The parameter name for saving user preferences
static final String	SERVICE_PARAM_TAG_CATEGORIES	Service parameter for tags' categories
static final String	START_DATE_ATTRIBUTE_NAME	Attribute name for content's start date

Fields inherited from class org.ametys.web.frontoffice.search.SearchService

_creationHelper, _renderingContextHandler, _searchServiceInstanceManager, PARAM_NAME_COMPUTE_COUNTS, PARAM_NAME_CONTEXTS, PARAM_NAME_CRITERIA, PARAM_NAME_FACETS, PARAM_NAME_HEADER, PARAM_NAME_INITIAL_SORTS, PARAM_NAME_LAUNCH_SEARCH_AT_STARTUP, PARAM_NAME_LINK_PAGE, PARAM_NAME_LINK_TITLE, PARAM_NAME_MAX_RESULTS, PARAM_NAME_PROPOSED_SORTS, PARAM_NAME_RESULT_PAGE, PARAM_NAME_RESULT_PLACE, PARAM_NAME_RESULTS_PER_PAGE, PARAM_NAME_RETURNABLES, PARAM_NAME_RIGHT_CHECKING_MODE, PARAM_NAME_RSS, PARAM_NAME_SAVE_USER_PREFS, PARAM_NAME_SERVICE_GROUP_ID, PARAM_NAME_XSLT, ROLE

Fields inherited from class org.ametys.web.service.StaticService

_context, _featureName, _manager, _modelItems, _paramsScript, _pluginName, _repeaterDefinitionParser, _serviceParameterDefinitionParser, _view, _viewAndParametersParser

Constructor Summary

Constructors

Constructor	Description
CalendarSearchService()

Method Summary

Modifier and Type	Method	Description
static EventsFilterHelper.DateTimeRange	getDateRange(SearchComponentArguments args)	Get search date range
static List<String>	getSelectedTags(SearchComponentArguments args)	Get the active tags
static List<String>	getTagCategories(SearchServiceInstance serviceInstance)	Get the tags' category
static boolean	hasTagCategories(SearchServiceInstance serviceInstance)	Determines if tags' categories filter is active
static boolean	isActive(SearchComponentArguments args)	Determines if is calendar service
boolean	isCacheable(Page currentPage, ZoneItem zoneItem)	Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.
static boolean	isFormSubmit(SearchComponentArguments args)	Determines if form is submit to get results
static boolean	saveFilterInUserPrefs(SearchServiceInstance serviceInstance)	Returns true if selected tags filter has to be saved in user preferences
static boolean	saveUserPrefsEnabled(SearchComponentArguments args)	Returns true if save user preferences is enabled
static void	saxTag(ContentHandler handler, Tag tag)	SAX a tag
static void	saxTag(ContentHandler handler, AttributesImpl attrs, Tag tag)	SAX a tag
static void	saxTagColor(ContentHandler handler, Tag tag)	SAX the color of a tag

Methods inherited from class org.ametys.web.frontoffice.search.SearchService

_buildAdditionalSearchServiceParameters, _fieldsReloadingWidget, _hasUserInput, _isDebug, _parseAndInjectDisplayAdditionalParameters, _parseAndInjectGeneralAdditionalParameters, _setWidgetParameters, configureParameters, hasUserCriteria, hasUserInput, service

Methods inherited from class org.ametys.web.service.StaticService

_configureClass, _configureImports, _configureScript, _parseI18nizableText, configure, configureDialogBoxDimension, configureIndexation, contextualize, dispose, getCategory, getCreationBoxHeight, getCreationBoxWidth, getCSSFiles, getDescription, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getModelItems, getName, getParameters, getParametersScript, getPluginName, getRight, getSmallIcon, getURL, getView, index, isPrivate, 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.runtime.model.ModelItemAccessor

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.web.service.Service

getFamilyId

Field Details

SERVICE_ID

public static final String SERVICE_ID

Id of service

See Also:

• Constant Field Values

ENABLE_CALENDAR_PARAMETER_NAME

public static final String ENABLE_CALENDAR_PARAMETER_NAME

Parameter to enable calendar search components

See Also:

• Constant Field Values

SERVICE_PARAM_TAG_CATEGORIES

public static final String SERVICE_PARAM_TAG_CATEGORIES

Service parameter for tags' categories

See Also:

• Constant Field Values

SERVICE_PARAM_CONTENT_VIEW

public static final String SERVICE_PARAM_CONTENT_VIEW

Service parameter for contents' view

See Also:

• Constant Field Values

SERVICE_PARAM_CONTENT_TYPES

public static final String SERVICE_PARAM_CONTENT_TYPES

Service parameter for calendar content types

See Also:

• Constant Field Values

SERVICE_PARAM_SAVE_USER_PREFS

public static final String SERVICE_PARAM_SAVE_USER_PREFS

The parameter name for saving user preferences

See Also:

• Constant Field Values

PARAM_START_DATE

public static final String PARAM_START_DATE

Parameter for start date

See Also:

• Constant Field Values

PARAM_END_DATE

public static final String PARAM_END_DATE

Parameter for end date

See Also:

• Constant Field Values

PARAM_TAGS

public static final String PARAM_TAGS

Parameter for selected tags

See Also:

• Constant Field Values

PARAM_SUBMIT

public static final String PARAM_SUBMIT

Parameter for selected tags

See Also:

• Constant Field Values

START_DATE_ATTRIBUTE_NAME

public static final String START_DATE_ATTRIBUTE_NAME

Attribute name for content's start date

See Also:

• Constant Field Values

END_DATE_ATTRIBUTE_NAME

public static final String END_DATE_ATTRIBUTE_NAME

Attribute name for content's end date

See Also:

• Constant Field Values

Constructor Details

CalendarSearchService

public CalendarSearchService()

Method Details

isCacheable

public boolean isCacheable(Page currentPage,
 ZoneItem zoneItem)

Description copied from interface: Service

Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Specified by:

isCacheable in interface Service

Overrides:

isCacheable in class SearchService

Parameters:

currentPage - the current Page containing the service.

zoneItem - the ZoneItem containing an instance of this service.
N.B: The ZoneItem can belong to a page that is not the current page, when it is inherited.

Returns:

true if the result of this service may be cached.

hasTagCategories

public static boolean hasTagCategories(SearchServiceInstance serviceInstance)

Determines if tags' categories filter is active

Parameters:

serviceInstance - the service instance

Returns:

true if tags' categories filter is active

getTagCategories

public static List<String> getTagCategories(SearchServiceInstance serviceInstance)

Get the tags' category

Parameters:

serviceInstance - the service instance

Returns:

the tags' category. Can be null if no tags' categories are configured

saveUserPrefsEnabled

public static boolean saveUserPrefsEnabled(SearchComponentArguments args)

Returns true if save user preferences is enabled

Parameters:

args - the search arguments

Returns:

true if save user preferences is enabled

saveFilterInUserPrefs

public static boolean saveFilterInUserPrefs(SearchServiceInstance serviceInstance)

Returns true if selected tags filter has to be saved in user preferences

Parameters:

serviceInstance - the service instance

Returns:

true if selected tags filtes has to be saved in user preferences

getSelectedTags

public static List<String> getSelectedTags(SearchComponentArguments args)

Get the active tags

Parameters:

args - the search arguments

Returns:

the active tags

isActive

public static boolean isActive(SearchComponentArguments args)

Determines if is calendar service

Parameters:

args - the search component arguments

Returns:

true if it is calendar service

isFormSubmit

public static boolean isFormSubmit(SearchComponentArguments args)

Determines if form is submit to get results

Parameters:

args - the search component arguments

Returns:

true if form is submit

getDateRange

public static EventsFilterHelper.DateTimeRange getDateRange(SearchComponentArguments args)

Get search date range

Parameters:

args - the search component arguments

Returns:

the date time range

saxTag

public static void saxTag(ContentHandler handler,
 Tag tag)
                   throws SAXException

SAX a tag

Parameters:

handler - the content handler

tag - the tag

Throws:

SAXException - if an error occurred

saxTag

public static void saxTag(ContentHandler handler,
 AttributesImpl attrs,
 Tag tag)
                   throws SAXException

SAX a tag

Parameters:

handler - the content handler

attrs - The attributes

tag - the tag

Throws:

SAXException - if an error occurred

saxTagColor

public static void saxTagColor(ContentHandler handler,
 Tag tag)
                        throws SAXException

SAX the color of a tag

Parameters:

handler - the content handler

tag - the tag

Throws:

SAXException - if an error occurred