Package org.silverpeas.core.webapi.selection

Class SelectionBasketEntry

java.lang.Object

org.silverpeas.core.webapi.selection.SelectionBasketEntry

All Implemented Interfaces:

Serializable, WebEntity

public class SelectionBasketEntry
extends Object
implements WebEntity

An entry in the basket. Any items in the basket are wrapped by an entry that maps the item, id est the Silverpeas resource, to a context that indicates for what reason the resource was put in the basket. When an item is put or get from the SelectionBasket, it is always done through a SelectionBasketEntry instance.

Author:

mmoquillon

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SelectionBasketEntry()
	SelectionBasketEntry(BasketItem item)
	SelectionBasketEntry(BasketItem item, SelectionContext context)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SelectionBasketEntry	from(SelectionEntry<SilverpeasResource> entry)
SelectionContext	getContext()	Gets the context for what the related item has been put into the basket.
BasketItem	getItem()	Gets the item in the basket to which this entry is related.
URI	getURI()	Gets the URI through which this entry can be retrieved through the selection basket Web API.
int	hashCode()
SelectionBasketEntry	reload()	Reloads the data of the represented Silverpeas resource.
SelectionBasketEntry	withURI(URI uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionBasketEntry

protected SelectionBasketEntry()

SelectionBasketEntry

public SelectionBasketEntry(BasketItem item,
                            SelectionContext context)

SelectionBasketEntry

public SelectionBasketEntry(BasketItem item)

Method Detail

from

public static SelectionBasketEntry from(SelectionEntry<SilverpeasResource> entry)

getURI

public URI getURI()

Gets the URI through which this entry can be retrieved through the selection basket Web API.

Specified by:

getURI in interface WebEntity

Returns:

the URI at which this entry, and hence the selected Silverpeas resource, can be found.

withURI

public SelectionBasketEntry withURI(URI uri)

getItem

public BasketItem getItem()

Gets the item in the basket to which this entry is related.

Returns:

a Web entity representation of a Silverpeas resource.

getContext

public SelectionContext getContext()

Gets the context for what the related item has been put into the basket.

Returns:

the context of selecting the Silverpeas resource represented here by the item.

reload

public SelectionBasketEntry reload()

Reloads the data of the represented Silverpeas resource. By calling this method, you ensure the representation of the resource is up-to-date. If the resource supports the l10n, then the data get is in the language of the current user behind the request; by doing this, you ensure the data of the resource will be presented to the user in his language.

Returns:

itself

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object