Package org.ametys.plugins.cart

Class QueryElement

java.lang.Object

org.ametys.plugins.cart.QueryElement

All Implemented Interfaces:

CartElement

Direct Known Subclasses:

QueryFromDirectoryElement

public class QueryElement
extends Object
implements CartElement

Implementation of a CartElement wrapping a search query

Constructor Summary

Constructors

Constructor	Description
QueryElement(String id, String query, UserIdentity author, ZonedDateTime creationDate, UserIdentity contributor, ZonedDateTime lastModified, String title)	Constructor

Method Summary

Modifier and Type	Method	Description
ZonedDateTime	getCreationDate()	Get the creation date
UserIdentity	getCreator()	Get the author
I18nizableText	getDescription()	Get the element's description
String	getGlyphIcon()	Get glyph icon.
List<I18nizableText>	getGroups()	Get the label of the groups
String	getId()	Get the unique identifier of the element
UserIdentity	getLastContributor()	Get the last contributor
ZonedDateTime	getLastModified()	Get the date of last modification
String	getMediumIcon()	Get the path to medium icon (32x32 pixels)
String	getQueryContent()	Get the content of the query
String	getSmallIcon()	Get the path to small icon (16x16 pixels)
I18nizableText	getTitle()	Get the element's title
String	getType()	Get the type of element

Methods inherited from class java.lang.Object

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

Constructor Details

QueryElement

public QueryElement(String id,
 String query,
 UserIdentity author,
 ZonedDateTime creationDate,
 UserIdentity contributor,
 ZonedDateTime lastModified,
 String title)

Constructor

Parameters:

id - The id

query - The query

author - The author

creationDate - The creation date

contributor - The last contributor

lastModified - The last modification date

title - The query title

Method Details

getId

public String getId()

Description copied from interface: CartElement

Get the unique identifier of the element

Specified by:

getId in interface CartElement

Returns:

The unique identifier

getTitle

public I18nizableText getTitle()

Description copied from interface: CartElement

Get the element's title

Specified by:

getTitle in interface CartElement

Returns:

The title

getDescription

public I18nizableText getDescription()

Description copied from interface: CartElement

Get the element's description

Specified by:

getDescription in interface CartElement

Returns:

The description

getQueryContent

public String getQueryContent()

Get the content of the query

Returns:

the content as a JSON string

getGroups

public List<I18nizableText> getGroups()

Description copied from interface: CartElement

Get the label of the groups

Specified by:

getGroups in interface CartElement

Returns:

the label of the groups

getCreationDate

public ZonedDateTime getCreationDate()

Description copied from interface: CartElement

Get the creation date

Specified by:

getCreationDate in interface CartElement

Returns:

the creation date

getCreator

public UserIdentity getCreator()

Description copied from interface: CartElement

Get the author

Specified by:

getCreator in interface CartElement

Returns:

The author

getLastModified

public ZonedDateTime getLastModified()

Description copied from interface: CartElement

Get the date of last modification

Specified by:

getLastModified in interface CartElement

Returns:

the date of last modification

getLastContributor

public UserIdentity getLastContributor()

Description copied from interface: CartElement

Get the last contributor

Specified by:

getLastContributor in interface CartElement

Returns:

The last contributor

getType

public String getType()

Description copied from interface: CartElement

Get the type of element

Specified by:

getType in interface CartElement

Returns:

The type

getGlyphIcon

public String getGlyphIcon()

Description copied from interface: CartElement

Get glyph icon. If not null, small and medium icon will be ignored

Specified by:

getGlyphIcon in interface CartElement

Returns:

the path to small icon

getSmallIcon

public String getSmallIcon()

Description copied from interface: CartElement

Get the path to small icon (16x16 pixels)

Specified by:

getSmallIcon in interface CartElement

Returns:

the path to small icon

getMediumIcon

public String getMediumIcon()

Description copied from interface: CartElement

Get the path to medium icon (32x32 pixels)

Specified by:

getMediumIcon in interface CartElement

Returns:

the path to medium icon