Package org.ametys.plugins.queriesdirectory

Class Query

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

org.ametys.plugins.queriesdirectory.Query

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, MovableAmetysObject, RemovableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject

public class Query
extends DefaultAmetysObject<QueryFactory>
implements MovableAmetysObject

Class representing a query, backed by a JCR node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Query.QueryProfile	Rights profiles
static enum	Query.Type	Type of a Query
static enum	Query.Visibility	Visibility of a Query

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHOR	Property name for query author
static final String	CONTENT	Property name for query content
static final String	DESCRIPTION	Property name for query description
static final String	GROUPS	Property name for query groups
static final String	LASTMODIFICATIONDATE	Property name for query last modification date
static final String	PROFILE_READ_ACCESS	Property name for query read access
static final String	PROFILE_WRITE_ACCESS	Property name for query write access
static final String	TITLE	Property name for query title
static final String	TYPE	Property name for query type
static final String	USERS	Property name for query users
static final String	VISIBILITY	Property name for query visibility

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

PROTECTED_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
Query(Node node, String parentPath, QueryFactory factory)	Creates an Query.

Method Summary

Modifier and Type	Method	Description
boolean	canMoveTo(AmetysObject newParent)	Test if a move can be a success or if it is impossible (e.g.
boolean	canRead(UserIdentity user)	Determines if an user has READ access to this query.
boolean	canWrite(UserIdentity user)	Determines if an user has WRITE access to this query.
UserIdentity	getAuthor()	Get the author of the query
String	getContent()	Get the content of the query
String	getDescription()	Get the description of the query
Set<GroupIdentity>	getGrantedGroups(Query.QueryProfile profile)	Get the granted groups
Set<UserIdentity>	getGrantedUsers(Query.QueryProfile profile)	Get the granted users
Date	getLastModificationDate()	Get the date of the last modification of the query
String	getTitle()	Get the title of the query
String	getType()	Get the type of the query
Query.Visibility	getVisibility()	Get the visibility of the query
void	moveTo(AmetysObject newParent, boolean renameIfExist)	Move the current object as a new child of the given object.
void	orderBefore(AmetysObject siblingNode)	Order a node before another sibling node (or as the last node)
void	setAuthor(UserIdentity author)	Set the author of this query.
void	setContent(String content)	Set the content of this query.
void	setDescription(String description)	Set the description of this query.
void	setGrantedGroups(Query.QueryProfile profile, Set<GroupIdentity> groups)	Set the granted groups
void	setGrantedUsers(Query.QueryProfile profile, Set<UserIdentity> users)	Set the granted users
void	setLastModificationDate(Date lastModificationDate)	Set the date of the last modification.
void	setTitle(String title)	Set the title of this query.
void	setType(String type)	Set the type of this query.
void	setVisibility(Query.Visibility visibility)	Set the query visibility

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.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Field Details

TITLE

public static final String TITLE

Property name for query title

See Also:

• Constant Field Values

TYPE

public static final String TYPE

Property name for query type

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Property name for query description

See Also:

• Constant Field Values

CONTENT

public static final String CONTENT

Property name for query content

See Also:

• Constant Field Values

AUTHOR

public static final String AUTHOR

Property name for query author

See Also:

• Constant Field Values

LASTMODIFICATIONDATE

public static final String LASTMODIFICATIONDATE

Property name for query last modification date

See Also:

• Constant Field Values

VISIBILITY

public static final String VISIBILITY

Property name for query visibility

See Also:

• Constant Field Values

PROFILE_READ_ACCESS

public static final String PROFILE_READ_ACCESS

Property name for query read access

See Also:

• Constant Field Values

PROFILE_WRITE_ACCESS

public static final String PROFILE_WRITE_ACCESS

Property name for query write access

See Also:

• Constant Field Values

GROUPS

public static final String GROUPS

Property name for query groups

See Also:

• Constant Field Values

USERS

public static final String USERS

Property name for query users

See Also:

• Constant Field Values

Constructor Details

Query

public Query(Node node,
 String parentPath,
 QueryFactory factory)

Creates an Query.

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 query.

Parameters:

title - the description

setType

public void setType(String type)

Set the type of this query.

Parameters:

type - the description

setDescription

public void setDescription(String description)

Set the description of this query.

Parameters:

description - the description

setContent

public void setContent(String content)

Set the content of this query.

Parameters:

content - the content

setAuthor

public void setAuthor(UserIdentity author)

Set the author of this query.

Parameters:

author - the author

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Set the date of the last modification.

Parameters:

lastModificationDate - the last modification date to set.

setVisibility

public void setVisibility(Query.Visibility visibility)

Set the query visibility

Parameters:

visibility - the visibility

getTitle

public String getTitle()

Get the title of the query

Returns:

The title

getType

public String getType()

Get the type of the query

Returns:

The type

getDescription

public String getDescription()

Get the description of the query

Returns:

The description

getContent

public String getContent()

Get the content of the query

Returns:

The content

getAuthor

public UserIdentity getAuthor()

Get the author of the query

Returns:

The author

getVisibility

public Query.Visibility getVisibility()

Get the visibility of the query

Returns:

The visibility

getGrantedUsers

public Set<UserIdentity> getGrantedUsers(Query.QueryProfile profile)

Get the granted users

Parameters:

profile - teh query profile

Returns:

the logins of granted users

getGrantedGroups

public Set<GroupIdentity> getGrantedGroups(Query.QueryProfile profile)

Get the granted groups

Parameters:

profile - the query profile

Returns:

the granted groups

canRead

public boolean canRead(UserIdentity user)

Determines if an user has READ access to this query.

Parameters:

user - The user

Returns:

true if the user has read access, false otherwise

canWrite

public boolean canWrite(UserIdentity user)

Determines if an user has WRITE access to this query.

Parameters:

user - The user

Returns:

true if the user has write access, false otherwise

setGrantedUsers

public void setGrantedUsers(Query.QueryProfile profile,
 Set<UserIdentity> users)

Set the granted users

Parameters:

profile - the query profile

users - the granted users

setGrantedGroups

public void setGrantedGroups(Query.QueryProfile profile,
 Set<GroupIdentity> groups)

Set the granted groups

Parameters:

profile - the query profile

groups - the granted groups

getLastModificationDate

public Date getLastModificationDate()

Get the date of the last modification of the query

Returns:

The date

canMoveTo

public boolean canMoveTo(AmetysObject newParent)
                  throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Test if a move can be a success or if it is impossible (e.g. due to the implementation of the target)

Specified by:

canMoveTo in interface MovableAmetysObject

Parameters:

newParent - See moveTo.

Returns:

true if the move operation may succeed. If false is returned and you call moveTo anyway, you may encontered a RuntimeException (such as UnsupportedOperationException)

Throws:

AmetysRepositoryException - if an error occurs.

moveTo

public void moveTo(AmetysObject newParent,
 boolean renameIfExist)
            throws AmetysRepositoryException,
RepositoryIntegrityViolationException

Description copied from interface: MovableAmetysObject

Move the current object as a new child of the given object. This node will be the last child. You should call canMoveTo to know if this is a supported operation.

Specified by:

moveTo in interface MovableAmetysObject

Parameters:

newParent - The new parent for the current object. Can not be null. Can not be a child of the current node. Must be a TraversableAmetyObject.

renameIfExist - true to rename moved page if a page with same name already exist

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if a page with the same name already exists.

orderBefore

public void orderBefore(AmetysObject siblingNode)
                 throws AmetysRepositoryException

Description copied from interface: MovableAmetysObject

Order a node before another sibling node (or as the last node)

Specified by:

orderBefore in interface MovableAmetysObject

Parameters:

siblingNode - The node that will be the next sibling node of the current node. Must have the same parent as the current node. Can be null to set the current node as the last node.

Throws:

AmetysRepositoryException - if an error occurs.