PropConstraint (ATG Java API)

java.lang.Object
- atg.search.routing.command.SearchXMLObject
- - atg.search.routing.command.search.DocumentSetConstraint
  - - atg.search.routing.command.search.BaseConstraint
    - - atg.search.routing.command.search.PropConstraint

All Implemented Interfaces:

java.io.Serializable
```
public class PropConstraint
extends BaseConstraint
```
A property constraint.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

static java.lang.String TAG

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

PropConstraint()

Constructors
Constructor and Description
`PropConstraint()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected DocumentSetConstraint`	`createFromParser(atg.search.routing.utils.SearchMessageNode pXml)`
`boolean`	`equals(java.lang.Object pObject)`
`protected void`	`getAttributeXML(java.lang.StringBuilder sb)`
`protected void`	`getBodyXML(java.lang.StringBuilder sb)`
`java.lang.String`	`getName()` Returns the name of the property to constrain against
`StringOp`	`getOperation()` Returns the operation for the constraint
`java.util.List<PropConstraint>`	`getPropConstraints()` Returns this constraint as an element of a list
`java.lang.String`	`getPropertyName()` Deprecated. Use `getName()` instead
`java.lang.String`	`getRepositoryId()` Returns the optional repository id, or null if not provided.
`java.lang.String`	`getRequestTag()`
`static java.lang.String`	`getTag()`
`PropType`	`getType()` Returns the type of constraint
`java.lang.String`	`getValue()` Returns the value or first part of range
`java.lang.String`	`getValue1()` Returns the first value of the range, same as `getValue()`
`java.lang.String`	`getValue2()` Returns the second value if this is a range value, otherwise null
`java.lang.Float`	`getWeight()` Returns the weight
`int`	`hashCode()`
`java.lang.Boolean`	`isCaseSensitive()` Indicates whether the constraint is case sensitive
`void`	`setCaseSensitive(java.lang.Boolean pCaseSensitive)` Sets whether the constraint is case sensitive
`void`	`setName(java.lang.String pName)` Sets the name of the property to constrain against
`void`	`setOperation(StringOp pOperation)` Sets the operation for the constraint
`void`	`setPropertyName(java.lang.String pProperty)` Deprecated. Use `setName(String)` instead
`void`	`setRepositoryId(java.lang.String pRepositoryId)` An optional value used for reporting purposes.
`void`	`setType(PropType pType)` Sets the type of constraint
`void`	`setValue(java.lang.String pValue)` Sets the value or first part of range.
`void`	`setValue2(java.lang.String pValue2)` Sets the second value if this is a range value
`void`	`setWeight(java.lang.Float pWeight)` Sets the weight
`static PropConstraint`	`valueOf(java.lang.String pXml)`

Methods inherited from class atg.search.routing.command.search.BaseConstraint
getXml, setXml

Methods inherited from class atg.search.routing.command.search.DocumentSetConstraint
createFromXML, getParser

Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

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

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropConstraint
```
public PropConstraint()
```
- Method Detail
  - getTag
```
public static java.lang.String getTag()
```
  - equals
```
public boolean equals(java.lang.Object pObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getPropConstraints
```
public java.util.List<PropConstraint> getPropConstraints()
```
    Returns this constraint as an element of a list
    
    Overrides:
    
    getPropConstraints in class DocumentSetConstraint
    
    Returns:
    
    this, in a list
  - getRepositoryId
```
public java.lang.String getRepositoryId()
```
    Returns the optional repository id, or null if not provided. always null if this is part of a response
    
    Returns:
    
    the optional repository id, or null if not provided. always null if this is part of a response
  - setRepositoryId
```
public void setRepositoryId(java.lang.String pRepositoryId)
```
    An optional value used for reporting purposes. it is not used by the engine
    
    Parameters:
    
    pRepositoryId - repository id
  - isCaseSensitive
```
public java.lang.Boolean isCaseSensitive()
```
    Indicates whether the constraint is case sensitive
    
    Returns:
    
    whether the constraint is case sensitive
  - setCaseSensitive
```
public void setCaseSensitive(java.lang.Boolean pCaseSensitive)
```
    Sets whether the constraint is case sensitive
    
    Parameters:
    
    pCaseSensitive - whether the constraint is case sensitive
  - getOperation
```
public StringOp getOperation()
```
    Returns the operation for the constraint
    
    Returns:
    
    the operation for the constraint
  - setOperation
```
public void setOperation(StringOp pOperation)
```
    Sets the operation for the constraint
    
    Parameters:
    
    pOperation - the operation for the constraint
  - getPropertyName
```
public java.lang.String getPropertyName()
```
    Deprecated. Use getName() instead
    
    Returns the name of the property to constrain against
    
    Returns:
    
    name of the property to constrain against
  - setPropertyName
```
public void setPropertyName(java.lang.String pProperty)
```
    Deprecated. Use setName(String) instead
    
    Sets the property to constrain against
    
    Parameters:
    
    pProperty - the property to constrain against
  - getName
```
public java.lang.String getName()
```
    Returns the name of the property to constrain against
    
    Returns:
    
    name of the property to constrain against
  - setName
```
public void setName(java.lang.String pName)
```
    Sets the name of the property to constrain against
    
    Parameters:
    
    pProperty - the name of the property to constrain against
  - getType
```
public PropType getType()
```
    Returns the type of constraint
    
    Returns:
    
    type of constraint
  - setType
```
public void setType(PropType pType)
```
    Sets the type of constraint
    
    Parameters:
    
    pType - type of constraint
  - getValue
```
public java.lang.String getValue()
```
    Returns the value or first part of range
    
    Returns:
    
    value or first part of range
  - setValue
```
public void setValue(java.lang.String pValue)
```
    Sets the value or first part of range. If this is a range value, also call setValue2(String).
    
    Parameters:
    
    pValue - value of constraint, or first in a range
  - getWeight
```
public java.lang.Float getWeight()
```
    Returns the weight
    
    Returns:
    
    the weight
  - setWeight
```
public void setWeight(java.lang.Float pWeight)
```
    Sets the weight
    
    Parameters:
    
    pWeight - the weight
  - getBodyXML
```
protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException
```
    Overrides:
    
    getBodyXML in class atg.search.routing.command.SearchXMLObject
    
    Throws:
    
    atg.search.routing.command.IncompleteCommandException
  - getAttributeXML
```
protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException
```
    Overrides:
    
    getAttributeXML in class atg.search.routing.command.SearchXMLObject
    
    Throws:
    
    atg.search.routing.command.IncompleteCommandException
  - valueOf
```
public static PropConstraint valueOf(java.lang.String pXml)
```
  - createFromParser
```
protected DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pXml)
```
    Specified by:
    
    createFromParser in class DocumentSetConstraint
  - getValue1
```
public java.lang.String getValue1()
```
    Returns the first value of the range, same as getValue()
    
    Returns:
    
    first value of the range, same as getValue()
  - setValue2
```
public void setValue2(java.lang.String pValue2)
```
    Sets the second value if this is a range value
    
    Parameters:
    
    pValue2 - the second value if this is a range value
  - getValue2
```
public java.lang.String getValue2()
```
    Returns the second value if this is a range value, otherwise null
    
    Returns:
    
    second value if this is a range value, otherwise null
  - getRequestTag
```
public java.lang.String getRequestTag()
```
    Specified by:
    
    getRequestTag in class atg.search.routing.command.SearchXMLObject

Class PropConstraint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class atg.search.routing.command.search.BaseConstraint

Methods inherited from class atg.search.routing.command.search.DocumentSetConstraint

Methods inherited from class atg.search.routing.command.SearchXMLObject

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

TAG

Constructor Detail

PropConstraint

Method Detail

getTag

equals

hashCode

getPropConstraints

getRepositoryId

setRepositoryId

isCaseSensitive

setCaseSensitive

getOperation

setOperation

getPropertyName

setPropertyName

getName

setName

getType

setType

getValue

setValue

getWeight

setWeight

getBodyXML

getAttributeXML

valueOf

createFromParser

getValue1

setValue2

getValue2

getRequestTag