public class

StructuredQuery

extends Query
java.lang.Object
   ↳ com.emc.documentum.fs.datamodel.core.query.Query
     ↳ com.emc.documentum.fs.datamodel.core.query.StructuredQuery

Class Overview

Java class for StructuredQuery complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="StructuredQuery">
   <complexContent>
     <extension base="{http://query.core.datamodel.fs.documentum.emc.com/}Query">
       <sequence>
         <element name="scopes" type="{http://query.core.datamodel.fs.documentum.emc.com/}RepositoryScope" maxOccurs="unbounded" minOccurs="0"/>
         <element name="rootExpressionSet" type="{http://query.core.datamodel.fs.documentum.emc.com/}ExpressionSet" minOccurs="0"/>
         <element name="orderByClauses" type="{http://query.core.datamodel.fs.documentum.emc.com/}OrderByClause" maxOccurs="unbounded" minOccurs="0"/>
         <element name="facetDefinitions" type="{http://query.core.datamodel.fs.documentum.emc.com/}FacetDefinition" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="objectType" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dateFormat" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="isDatabaseSearch" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="isIncludeAllVersions" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="isIncludeHidden" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="maxResultsForFacets" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
     </extension>
   </complexContent>
 </complexType>

Summary

Fields
protected String dateFormat
protected List<FacetDefinition> facetDefinitions
protected boolean isDatabaseSearch
protected boolean isIncludeAllVersions
protected boolean isIncludeHidden
protected int maxResultsForFacets
protected String objectType
protected List<OrderByClause> orderByClauses
protected ExpressionSet rootExpressionSet
protected List<RepositoryScope> scopes
[Expand]
Inherited Fields
From class com.emc.documentum.fs.datamodel.core.query.Query
Public Constructors
StructuredQuery()
Public Methods
String getDateFormat()
Gets the value of the dateFormat property.
List<FacetDefinition> getFacetDefinitions()
Gets the value of the facetDefinitions property.
int getMaxResultsForFacets()
Gets the value of the maxResultsForFacets property.
String getObjectType()
Gets the value of the objectType property.
List<OrderByClause> getOrderByClauses()
Gets the value of the orderByClauses property.
ExpressionSet getRootExpressionSet()
Gets the value of the rootExpressionSet property.
List<RepositoryScope> getScopes()
Gets the value of the scopes property.
boolean isIsDatabaseSearch()
Gets the value of the isDatabaseSearch property.
boolean isIsIncludeAllVersions()
Gets the value of the isIncludeAllVersions property.
boolean isIsIncludeHidden()
Gets the value of the isIncludeHidden property.
void setDateFormat(String value)
Sets the value of the dateFormat property.
void setIsDatabaseSearch(boolean value)
Sets the value of the isDatabaseSearch property.
void setIsIncludeAllVersions(boolean value)
Sets the value of the isIncludeAllVersions property.
void setIsIncludeHidden(boolean value)
Sets the value of the isIncludeHidden property.
void setMaxResultsForFacets(int value)
Sets the value of the maxResultsForFacets property.
void setObjectType(String value)
Sets the value of the objectType property.
void setRootExpressionSet(ExpressionSet value)
Sets the value of the rootExpressionSet property.
[Expand]
Inherited Methods
From class com.emc.documentum.fs.datamodel.core.query.Query
From class java.lang.Object

Fields

protected String dateFormat

protected List<FacetDefinition> facetDefinitions

protected boolean isDatabaseSearch

protected boolean isIncludeAllVersions

protected boolean isIncludeHidden

protected int maxResultsForFacets

protected String objectType

protected List<OrderByClause> orderByClauses

protected ExpressionSet rootExpressionSet

protected List<RepositoryScope> scopes

Public Constructors

public StructuredQuery ()

Public Methods

public String getDateFormat ()

Gets the value of the dateFormat property.

Returns
  • possible object is String

public List<FacetDefinition> getFacetDefinitions ()

Gets the value of the facetDefinitions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the facetDefinitions property.

For example, to add a new item, do as follows: 

    getFacetDefinitions().add(newItem);

Objects of the following type(s) are allowed in the list FacetDefinition

public int getMaxResultsForFacets ()

Gets the value of the maxResultsForFacets property.

public String getObjectType ()

Gets the value of the objectType property.

Returns
  • possible object is String

public List<OrderByClause> getOrderByClauses ()

Gets the value of the orderByClauses property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the orderByClauses property.

For example, to add a new item, do as follows: 

    getOrderByClauses().add(newItem);

Objects of the following type(s) are allowed in the list OrderByClause

public ExpressionSet getRootExpressionSet ()

Gets the value of the rootExpressionSet property.

Returns

public List<RepositoryScope> getScopes ()

Gets the value of the scopes property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the scopes property.

For example, to add a new item, do as follows: 

    getScopes().add(newItem);

Objects of the following type(s) are allowed in the list RepositoryScope

public boolean isIsDatabaseSearch ()

Gets the value of the isDatabaseSearch property.

public boolean isIsIncludeAllVersions ()

Gets the value of the isIncludeAllVersions property.

public boolean isIsIncludeHidden ()

Gets the value of the isIncludeHidden property.

public void setDateFormat (String value)

Sets the value of the dateFormat property.

Parameters
value Allowed object is String

public void setIsDatabaseSearch (boolean value)

Sets the value of the isDatabaseSearch property.

Parameters
value

public void setIsIncludeAllVersions (boolean value)

Sets the value of the isIncludeAllVersions property.

Parameters
value

public void setIsIncludeHidden (boolean value)

Sets the value of the isIncludeHidden property.

Parameters
value

public void setMaxResultsForFacets (int value)

Sets the value of the maxResultsForFacets property.

Parameters
value

public void setObjectType (String value)

Sets the value of the objectType property.

Parameters
value Allowed object is String

public void setRootExpressionSet (ExpressionSet value)

Sets the value of the rootExpressionSet property.

Parameters
value Allowed object is ExpressionSet