java.lang.Object
- org.nuxeo.ecm.core.query.sql.NXQL

```
public class NXQL
extends Object
```
This defines the constants for NXQL queries.

Author:

Florent Guillaume

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ECM_ACL`
`static String`	`ECM_ACL_BEGIN`	Suffix for ecm:acl, like in `ecm:acl/*/begin`
`static String`	`ECM_ACL_CREATOR`	Suffix for ecm:acl, like in `ecm:acl/*/creator`
`static String`	`ECM_ACL_END`	Suffix for ecm:acl, like in `ecm:acl/*/end`
`static String`	`ECM_ACL_GRANT`	Suffix for ecm:acl, like in `ecm:acl/*/grant`
`static String`	`ECM_ACL_NAME`	Suffix for ecm:acl, like in `ecm:acl/*/name`
`static String`	`ECM_ACL_PERMISSION`	Suffix for ecm:acl, like in `ecm:acl/*/permission`
`static String`	`ECM_ACL_POS`	Suffix for ecm:acl, like in `ecm:acl/*/pos`
`static String`	`ECM_ACL_PRINCIPAL`	Suffix for ecm:acl, like in `ecm:acl/*/principal`
`static String`	`ECM_ACL_STATUS`	Suffix for ecm:acl, like in `ecm:acl/*/status`
`static String`	`ECM_ANCESTORID`
`static String`	`ECM_BLOBKEYS`
`static String`	`ECM_FULLTEXT`
`static String`	`ECM_FULLTEXT_JOBID`
`static String`	`ECM_FULLTEXT_SCORE`
`static String`	`ECM_HASLEGALHOLD`
`static String`	`ECM_ISCHECKEDIN`
`static String`	`ECM_ISFLEXIBLERECORD`
`static String`	`ECM_ISLATESTMAJORVERSION`
`static String`	`ECM_ISLATESTVERSION`
`static String`	`ECM_ISPROXY`
`static String`	`ECM_ISRECORD`
`static String`	`ECM_ISTRASHED`
`static String`	`ECM_ISVERSION`
`static String`	`ECM_ISVERSION_OLD`
`static String`	`ECM_LIFECYCLESTATE`
`static String`	`ECM_LOCK_CREATED`
`static String`	`ECM_LOCK_OWNER`
`static String`	`ECM_MIXINTYPE`
`static String`	`ECM_NAME`
`static String`	`ECM_PARENTID`
`static String`	`ECM_PATH`
`static String`	`ECM_POS`
`static String`	`ECM_PREFIX`
`static String`	`ECM_PRIMARYTYPE`
`static String`	`ECM_PROXY_TARGETID`
`static String`	`ECM_PROXY_VERSIONABLEID`
`static String`	`ECM_RETAINED_PROPS`
`static String`	`ECM_RETAINUNTIL`
`static String`	`ECM_TAG`
`static String`	`ECM_UUID`
`static String`	`ECM_VERSION_VERSIONABLEID`
`static String`	`ECM_VERSIONCREATED`
`static String`	`ECM_VERSIONDESCRIPTION`
`static String`	`ECM_VERSIONLABEL`
`static String`	`NOW_FUNCTION`	The function returning the current datetime.
`static String`	`NXQL`	The NXQL query type.
`static String`	`TEST_NXQL_NOW`	Property containing the test value of the current date for `nowPlusPeriodAndDuration(java.lang.String)`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`escapeString(String s)`	Escapes a string into a single-quoted string for NXQL.
`static String`	`escapeStringInner(String s)`	Escapes a string (assumed to be single quoted) for NXQL.
`static ZonedDateTime`	`nowPlusPeriodAndDuration(String periodAndDurationText)`	Returns the current dateTime to which the period and duration (if present) has been added.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEST_NXQL_NOW
```
public static final String TEST_NXQL_NOW
```
    Property containing the test value of the current date for nowPlusPeriodAndDuration(java.lang.String).
    Only for tests, not a public API.
    
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - NXQL
```
public static final String NXQL
```
    The NXQL query type.
    
    See Also:
    
    Constant Field Values
  - ECM_PREFIX
```
public static final String ECM_PREFIX
```
    See Also:
    
    Constant Field Values
  - ECM_UUID
```
public static final String ECM_UUID
```
    See Also:
    
    Constant Field Values
  - ECM_PATH
```
public static final String ECM_PATH
```
    See Also:
    
    Constant Field Values
  - ECM_NAME
```
public static final String ECM_NAME
```
    See Also:
    
    Constant Field Values
  - ECM_POS
```
public static final String ECM_POS
```
    See Also:
    
    Constant Field Values
  - ECM_PARENTID
```
public static final String ECM_PARENTID
```
    See Also:
    
    Constant Field Values
  - ECM_MIXINTYPE
```
public static final String ECM_MIXINTYPE
```
    See Also:
    
    Constant Field Values
  - ECM_PRIMARYTYPE
```
public static final String ECM_PRIMARYTYPE
```
    See Also:
    
    Constant Field Values
  - ECM_ISPROXY
```
public static final String ECM_ISPROXY
```
    See Also:
    
    Constant Field Values
  - ECM_ISVERSION
```
public static final String ECM_ISVERSION
```
    See Also:
    
    Constant Field Values
  - ECM_ISVERSION_OLD
```
public static final String ECM_ISVERSION_OLD
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_LIFECYCLESTATE
```
public static final String ECM_LIFECYCLESTATE
```
    See Also:
    
    Constant Field Values
  - ECM_VERSIONLABEL
```
public static final String ECM_VERSIONLABEL
```
    See Also:
    
    Constant Field Values
  - ECM_FULLTEXT
```
public static final String ECM_FULLTEXT
```
    See Also:
    
    Constant Field Values
  - ECM_FULLTEXT_JOBID
```
public static final String ECM_FULLTEXT_JOBID
```
    See Also:
    
    Constant Field Values
  - ECM_FULLTEXT_SCORE
```
public static final String ECM_FULLTEXT_SCORE
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - ECM_LOCK_OWNER
```
public static final String ECM_LOCK_OWNER
```
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
  - ECM_LOCK_CREATED
```
public static final String ECM_LOCK_CREATED
```
    Since:
    
    5.4.2
    
    See Also:
    
    Constant Field Values
  - ECM_TAG
```
public static final String ECM_TAG
```
    Since:
    
    5.7
    
    See Also:
    
    Constant Field Values
  - ECM_PROXY_TARGETID
```
public static final String ECM_PROXY_TARGETID
```
    Since:
    
    5.7
    
    See Also:
    
    Constant Field Values
  - ECM_PROXY_VERSIONABLEID
```
public static final String ECM_PROXY_VERSIONABLEID
```
    Since:
    
    5.7
    
    See Also:
    
    Constant Field Values
  - ECM_ISCHECKEDIN
```
public static final String ECM_ISCHECKEDIN
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_ISLATESTVERSION
```
public static final String ECM_ISLATESTVERSION
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_ISLATESTMAJORVERSION
```
public static final String ECM_ISLATESTMAJORVERSION
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_VERSIONCREATED
```
public static final String ECM_VERSIONCREATED
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_VERSIONDESCRIPTION
```
public static final String ECM_VERSIONDESCRIPTION
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_VERSION_VERSIONABLEID
```
public static final String ECM_VERSION_VERSIONABLEID
```
    Since:
    
    5.7.3
    
    See Also:
    
    Constant Field Values
  - ECM_ANCESTORID
```
public static final String ECM_ANCESTORID
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - ECM_ACL
```
public static final String ECM_ACL
```
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_PRINCIPAL
```
public static final String ECM_ACL_PRINCIPAL
```
    Suffix for ecm:acl, like in ecm:acl/*/principal
    
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_PERMISSION
```
public static final String ECM_ACL_PERMISSION
```
    Suffix for ecm:acl, like in ecm:acl/*/permission
    
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_GRANT
```
public static final String ECM_ACL_GRANT
```
    Suffix for ecm:acl, like in ecm:acl/*/grant
    
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_NAME
```
public static final String ECM_ACL_NAME
```
    Suffix for ecm:acl, like in ecm:acl/*/name
    
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_POS
```
public static final String ECM_ACL_POS
```
    Suffix for ecm:acl, like in ecm:acl/*/pos
    
    Since:
    
    6.0-HF06, 7.2
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_CREATOR
```
public static final String ECM_ACL_CREATOR
```
    Suffix for ecm:acl, like in ecm:acl/*/creator
    
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_BEGIN
```
public static final String ECM_ACL_BEGIN
```
    Suffix for ecm:acl, like in ecm:acl/*/begin
    
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_END
```
public static final String ECM_ACL_END
```
    Suffix for ecm:acl, like in ecm:acl/*/end
    
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - ECM_ACL_STATUS
```
public static final String ECM_ACL_STATUS
```
    Suffix for ecm:acl, like in ecm:acl/*/status
    
    Since:
    
    7.4
    
    See Also:
    
    Constant Field Values
  - ECM_ISTRASHED
```
public static final String ECM_ISTRASHED
```
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - ECM_ISRECORD
```
public static final String ECM_ISRECORD
```
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - ECM_ISFLEXIBLERECORD
```
public static final String ECM_ISFLEXIBLERECORD
```
    Since:
    
    2023.1
    
    See Also:
    
    Constant Field Values
  - ECM_RETAINUNTIL
```
public static final String ECM_RETAINUNTIL
```
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - ECM_HASLEGALHOLD
```
public static final String ECM_HASLEGALHOLD
```
    Since:
    
    11.1
    
    See Also:
    
    Constant Field Values
  - ECM_BLOBKEYS
```
public static final String ECM_BLOBKEYS
```
    Since:
    
    11.5
    
    See Also:
    
    Constant Field Values
  - ECM_RETAINED_PROPS
```
public static final String ECM_RETAINED_PROPS
```
    Since:
    
    2021.32
    
    See Also:
    
    Constant Field Values
  - NOW_FUNCTION
```
public static final String NOW_FUNCTION
```
    The function returning the current datetime. It can optionally have as an argument a duration that will be added to the current datetime, expressed as a ISO 8601 period.
    See PeriodAndDuration.parse(java.lang.String) for the exact format.
    
    Since:
    
    11.1
    
    See Also:
    
    PeriodAndDuration.parse(java.lang.String), Constant Field Values
- Method Detail
  - escapeString
```
public static String escapeString(String s)
```
    Escapes a string into a single-quoted string for NXQL.
    Any single quote or backslash characters are escaped with a backslash.
    
    Parameters:
    
    s - the string to escape
    
    Returns:
    
    the escaped string
    
    Since:
    
    5.7, 5.6.0-HF08
  - escapeStringInner
```
public static String escapeStringInner(String s)
```
    Escapes a string (assumed to be single quoted) for NXQL.
    Any single quote or backslash characters are escaped with a backslash.
    
    Parameters:
    
    s - the string to escape
    
    Returns:
    
    the escaped string, without external quotes
    
    Since:
    
    5.7, 5.6.0-HF08
  - nowPlusPeriodAndDuration
```
public static ZonedDateTime nowPlusPeriodAndDuration(String periodAndDurationText)
```
    Returns the current dateTime to which the period and duration (if present) has been added.
    
    Parameters:
    
    periodAndDurationText - the period and duration as text, or null
    
    Returns:
    
    the current dateTime to which the period and duration has been added
    
    Throws:
    
    IllegalArgumentException - if the period and duration cannot be parsed
    
    Since:
    
    11.1

Class NXQL

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEST_NXQL_NOW

NXQL

ECM_PREFIX

ECM_UUID

ECM_PATH

ECM_NAME

ECM_POS

ECM_PARENTID

ECM_MIXINTYPE

ECM_PRIMARYTYPE

ECM_ISPROXY

ECM_ISVERSION

ECM_ISVERSION_OLD

ECM_LIFECYCLESTATE

ECM_VERSIONLABEL

ECM_FULLTEXT

ECM_FULLTEXT_JOBID

ECM_FULLTEXT_SCORE

ECM_LOCK_OWNER

ECM_LOCK_CREATED

ECM_TAG

ECM_PROXY_TARGETID

ECM_PROXY_VERSIONABLEID

ECM_ISCHECKEDIN

ECM_ISLATESTVERSION

ECM_ISLATESTMAJORVERSION

ECM_VERSIONCREATED

ECM_VERSIONDESCRIPTION

ECM_VERSION_VERSIONABLEID

ECM_ANCESTORID

ECM_ACL

ECM_ACL_PRINCIPAL

ECM_ACL_PERMISSION

ECM_ACL_GRANT

ECM_ACL_NAME

ECM_ACL_POS

ECM_ACL_CREATOR

ECM_ACL_BEGIN

ECM_ACL_END

ECM_ACL_STATUS

ECM_ISTRASHED

ECM_ISRECORD

ECM_ISFLEXIBLERECORD

ECM_RETAINUNTIL

ECM_HASLEGALHOLD

ECM_BLOBKEYS

ECM_RETAINED_PROPS

NOW_FUNCTION

Method Detail

escapeString

escapeStringInner

nowPlusPeriodAndDuration