Package org.ametys.plugins.cart

Class Cart

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultAmetysObject<CartFactory>

org.ametys.plugins.cart.Cart

All Implemented Interfaces:

ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, ACLAmetysObject, AmetysObject, DataAwareAmetysObject, ModelAwareDataAwareAmetysObject, ModifiableModelAwareDataAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject

public class Cart
extends DefaultAmetysObject<CartFactory>
implements ModifiableModelAwareDataAwareAmetysObject

Class representing a cart, backed by a JCR node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Cart.CartElementType	Types of CartElement
static enum	Cart.CartProfile	Rights profiles

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHOR	Property name for cart author
static final String	CONTENT_CART_ELEMENTS	Property name for cart content elements
static final String	CONTRIBUTOR	Property name for cart last contributor
static final String	CREATIONDATE	Property name for cart creation date
static final String	DESCRIPTION	Property name for cart description
static final String	DOCUMENTATION	Property name for cart documentation
static final String	LASTMODIFICATIONDATE	Property name for cart last modification date
static final String	QUERIES_CART_ELEMENTS	Property name for cart queries elements
static final String	QUERIES_FROM_DIRECTORY_CART_ELEMENTS	Property name for cart queries from directory elements
static final String	QUERY_AUTHOR_PROPERTY	Property name for cart query author
static final String	QUERY_DATE_PROPERTY	Property name for cart query creation date
static final String	QUERY_DESCRIPTION_PROPERTY	Property name for cart query description
static final String	QUERY_ID_PROPERTY	Property name for cart query id
static final String	QUERY_TITLE_PROPERTY	Property name for cart query title
static final String	RESOURCE_CART_ELEMENTS	Property name for cart resource elements
static final String	TITLE	Property name for cart title

Fields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

PROTECTED_PROPERTIES

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
Cart(javax.jcr.Node node, String parentPath, CartFactory factory)	Creates an Cart.

Method Summary

Modifier and Type	Method	Description
protected void	_removeContent(String contentIdToRemove)	Remove a content from the cart
protected void	_removeQuery(String queryIdToRemove)	Remove a query from the cart
protected void	_removeQueryFromDirectory(String queryIdToRemove)	Remove a query from directory from the cart
protected void	_removeResource(String resourceIdToRemove)	Remove a resource from the cart
void	addContent(String contentId)	Add a content to the cart
void	addQuery(String id, UserIdentity author, String title, String description, ZonedDateTime date)	Add a query to the cart
void	addQuery(UserIdentity author, String title, String description)	Add a query to the cart
void	addQueryFormDirectory(String queryId)	Add a query from directory to the cart
void	addResource(String resourceId)	Add a resource to the cart
UserIdentity	getAuthor()	Get the author of the cart
List<ContentElement>	getContentCartElements()	Get the contents of the cart
UserIdentity	getContributor()	Get the last contributor of the cart
ZonedDateTime	getCreationDate()	Get the date of the last modification of the cart
ModifiableIndexableDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
String	getDescription()	Get the description of the cart
String	getDocumentation()	Get the documentation of the cart
List<CartElement>	getElements()	Get the elements of the cart
ZonedDateTime	getLastModificationDate()	Get the date of the last modification of the cart
List<QueryElement>	getQueryCartElements()	Get the queries of the cart
List<QueryFromDirectoryElement>	getQueryFromDirectoryCartElements()	Get the resources of the cart
List<ResourceElement>	getResourceCartElements()	Get the resources of the cart
String	getTitle()	Get the title of the cart
boolean	hasQueryFromDirectoryCartElement(String queryId)	true if the query cart element exist
void	removeElement(String elmtId, Cart.CartElementType elmtType)	Delete an element
void	setAuthor(UserIdentity author)	Set the author of this cart.
void	setContributor(UserIdentity contributor)	Set the last contributor of this cart.
void	setCreationDate(ZonedDateTime creationDate)	Set the date of the creation.
void	setDescription(String description)	Set the description of this cart.
void	setDocumentation(String documentation)	Set the documentation of this cart.
void	setLastModificationDate(ZonedDateTime lastModificationDate)	Set the date of the last modification.
void	setTitle(String title)	Set the title of this cart.

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, disallowInheritance, getAllLabels, getAllRevisions, getBaseNode, getBaseVersion, getLabels, getLabels, getNode, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedDataHolder, getVersionHistory, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevision

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX

Methods inherited from interface org.ametys.cms.data.ametysobject.ModelAwareDataAwareAmetysObject

getSystemPropertyExtensionPoint, indexData, indexData

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareDataAwareAmetysObject

dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultiple

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getRepositoryData

Methods inherited from interface org.ametys.cms.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject

getComposite, getComposite, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRootDataHolder

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject

getRepositoryData, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Field Details

TITLE

public static final String TITLE

Property name for cart title

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Property name for cart description

See Also:

• Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION

Property name for cart documentation

See Also:

• Constant Field Values

AUTHOR

public static final String AUTHOR

Property name for cart author

See Also:

• Constant Field Values

CONTRIBUTOR

public static final String CONTRIBUTOR

Property name for cart last contributor

See Also:

• Constant Field Values

CREATIONDATE

public static final String CREATIONDATE

Property name for cart creation date

See Also:

• Constant Field Values

LASTMODIFICATIONDATE

public static final String LASTMODIFICATIONDATE

Property name for cart last modification date

See Also:

• Constant Field Values

CONTENT_CART_ELEMENTS

public static final String CONTENT_CART_ELEMENTS

Property name for cart content elements

See Also:

• Constant Field Values

RESOURCE_CART_ELEMENTS

public static final String RESOURCE_CART_ELEMENTS

Property name for cart resource elements

See Also:

• Constant Field Values

QUERIES_CART_ELEMENTS

public static final String QUERIES_CART_ELEMENTS

Property name for cart queries elements

See Also:

• Constant Field Values

QUERIES_FROM_DIRECTORY_CART_ELEMENTS

public static final String QUERIES_FROM_DIRECTORY_CART_ELEMENTS

Property name for cart queries from directory elements

See Also:

• Constant Field Values

QUERY_ID_PROPERTY

public static final String QUERY_ID_PROPERTY

Property name for cart query id

See Also:

• Constant Field Values

QUERY_DESCRIPTION_PROPERTY

public static final String QUERY_DESCRIPTION_PROPERTY

Property name for cart query description

See Also:

• Constant Field Values

QUERY_AUTHOR_PROPERTY

public static final String QUERY_AUTHOR_PROPERTY

Property name for cart query author

See Also:

• Constant Field Values

QUERY_TITLE_PROPERTY

public static final String QUERY_TITLE_PROPERTY

Property name for cart query title

See Also:

• Constant Field Values

QUERY_DATE_PROPERTY

public static final String QUERY_DATE_PROPERTY

Property name for cart query creation date

See Also:

• Constant Field Values

Constructor Details

Cart

public Cart(javax.jcr.Node node,
 String parentPath,
 CartFactory factory)

Creates an Cart.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Details

setTitle

public void setTitle(String title)

Set the title of this cart.

Parameters:

title - the title

setDescription

public void setDescription(String description)

Set the description of this cart.

Parameters:

description - the description

setDocumentation

public void setDocumentation(String documentation)

Set the documentation of this cart.

Parameters:

documentation - the documentation

setAuthor

public void setAuthor(UserIdentity author)

Set the author of this cart.

Parameters:

author - the author

setContributor

public void setContributor(UserIdentity contributor)

Set the last contributor of this cart.

Parameters:

contributor - the last contributor

setCreationDate

public void setCreationDate(ZonedDateTime creationDate)

Set the date of the creation.

Parameters:

creationDate - the last modification date to set.

setLastModificationDate

public void setLastModificationDate(ZonedDateTime lastModificationDate)

Set the date of the last modification.

Parameters:

lastModificationDate - the last modification date to set.

getTitle

public String getTitle()

Get the title of the cart

Returns:

The title

getDescription

public String getDescription()

Get the description of the cart

Returns:

The description

getDocumentation

public String getDocumentation()

Get the documentation of the cart

Returns:

The documentation

getAuthor

public UserIdentity getAuthor()

Get the author of the cart

Returns:

The author

getContributor

public UserIdentity getContributor()

Get the last contributor of the cart

Returns:

The contributor

getCreationDate

public ZonedDateTime getCreationDate()

Get the date of the last modification of the cart

Returns:

The date

getLastModificationDate

public ZonedDateTime getLastModificationDate()

Get the date of the last modification of the cart

Returns:

The date

addContent

public void addContent(String contentId)

Add a content to the cart

Parameters:

contentId - The content id

addResource

public void addResource(String resourceId)

Add a resource to the cart

Parameters:

resourceId - The resource id

addQueryFormDirectory

public void addQueryFormDirectory(String queryId)

Add a query from directory to the cart

Parameters:

queryId - The query id

addQuery

public void addQuery(UserIdentity author,
 String title,
 String description)

Add a query to the cart

Parameters:

author - The author of the query

title - The title of the query

description - The query as string

addQuery

public void addQuery(String id,
 UserIdentity author,
 String title,
 String description,
 ZonedDateTime date)

Add a query to the cart

Parameters:

id - The id of the query

author - The author of the query

title - The title of the query

description - The query as string

date - The creation date of the query

removeElement

public void removeElement(String elmtId,
 Cart.CartElementType elmtType)

Delete an element

Parameters:

elmtId - The id of element to remove

elmtType - The type of element to remove

_removeResource

protected void _removeResource(String resourceIdToRemove)

Remove a resource from the cart

Parameters:

resourceIdToRemove - The id of the resource to remove

_removeContent

protected void _removeContent(String contentIdToRemove)

Remove a content from the cart

Parameters:

contentIdToRemove - The id of the content to remove

_removeQueryFromDirectory

protected void _removeQueryFromDirectory(String queryIdToRemove)

Remove a query from directory from the cart

Parameters:

queryIdToRemove - The id of the query from directory to remove

_removeQuery

protected void _removeQuery(String queryIdToRemove)

Remove a query from the cart

Parameters:

queryIdToRemove - The id of the query to remove

getElements

public List<CartElement> getElements()

Get the elements of the cart

Returns:

The elements of the cart

getContentCartElements

public List<ContentElement> getContentCartElements()
                                            throws javax.jcr.RepositoryException

Get the contents of the cart

Returns:

The elements of the cart

Throws:

javax.jcr.RepositoryException - if an exception occurs while exploring the repository

getResourceCartElements

public List<ResourceElement> getResourceCartElements()
                                              throws javax.jcr.RepositoryException

Get the resources of the cart

Returns:

The elements of the cart

Throws:

javax.jcr.RepositoryException - if an exception occurs while exploring the repository

getQueryFromDirectoryCartElements

public List<QueryFromDirectoryElement> getQueryFromDirectoryCartElements()
                                                                  throws javax.jcr.RepositoryException

Get the resources of the cart

Returns:

The elements of the cart

Throws:

javax.jcr.RepositoryException - if an exception occurs while exploring the repository

hasQueryFromDirectoryCartElement

public boolean hasQueryFromDirectoryCartElement(String queryId)

true if the query cart element exist

Parameters:

queryId - the query id

Returns:

true if the query cart element exist

getQueryCartElements

public List<QueryElement> getQueryCartElements()
                                        throws javax.jcr.RepositoryException

Get the queries of the cart

Returns:

The elements of the cart

Throws:

javax.jcr.RepositoryException - if an exception occurs while exploring the repository

getDataHolder

public ModifiableIndexableDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelAwareDataAwareAmetysObject

Specified by:

getDataHolder in interface ModifiableModelAwareDataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject