|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.search.DocumentSetConstraint atg.search.routing.command.search.BaseConstraint atg.search.routing.command.search.DateConstraint
public class DateConstraint
Allows a constraint to a specific date or a date range. See setDate1(String)
and setDate2(String)
.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
static java.lang.String |
TAG
|
Constructor Summary | |
---|---|
DateConstraint()
|
Method Summary | |
---|---|
protected DateConstraint |
createFromParser(atg.search.routing.utils.FastXMLModel pXml,
int rootIdx)
|
java.lang.String |
getDate1()
Returns the first (and possibly the only) date. |
java.lang.String |
getDate2()
Returns the second date if the date is a range of dates. |
NumOp |
getOperation()
Returns the number operation |
static java.lang.String |
getTag()
|
java.lang.Float |
getWeight()
Returns the weight of the constraint |
void |
setDate1(java.lang.String pDate1)
If the second date is not set via setDate2(String) , then this date will be the only date; the operation
(see setOperation(atg.search.routing.command.search.NumOp) ) will apply. |
void |
setDate2(java.lang.String pDate2)
Sets the second date, making this a range constraint. |
void |
setOperation(NumOp pOperation)
Sets the number operation |
void |
setWeight(java.lang.Float pWeight)
Sets the weight of the constraint |
java.lang.String |
toXml()
Converts this constraint to the XML representation that can be sent in request. |
static DateConstraint |
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, equals, escapeToXml, getParser, getPropConstraints, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static final java.lang.String TAG
Constructor Detail |
---|
public DateConstraint()
Method Detail |
---|
public static java.lang.String getTag()
public java.lang.Float getWeight()
public void setWeight(java.lang.Float pWeight)
pWeight
- public NumOp getOperation()
public void setOperation(NumOp pOperation)
pOperation
- public java.lang.String getDate1()
getDate2()
and setDate1(String)
public void setDate1(java.lang.String pDate1)
setDate2(String)
, then this date will be the only date; the operation
(see setOperation(atg.search.routing.command.search.NumOp)
) will apply. If the second date is specified, then
it will be a range delimited according to the chosen operation (see (atg.search.routing.command.search.NumOp)
).
The only acceptable date formats are as follows:
YY or YYYY
MM/YY (or MM/YYYY)
MM/DD/YY (or MM/DD/YYYY)
pDate1
- a date string, in an appropriate formpublic java.lang.String getDate2()
public void setDate2(java.lang.String pDate2)
setDate1(java.lang.String)
for acceptable formats.
pDate2
- second date in the case of a rangepublic java.lang.String toXml()
DocumentSetConstraint
toXml
in class DocumentSetConstraint
public static DateConstraint valueOf(java.lang.String pXml)
protected DateConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml, int rootIdx)
createFromParser
in class DocumentSetConstraint
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |