com.tridion.broker.querying.criteria.content

Class ItemInitialPublishDateCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.DateCriteria

com.tridion.broker.querying.criteria.content.ItemInitialPublishDateCriteria

public class ItemInitialPublishDateCriteria
extends DateCriteria

This queries the Broker Storage by Item's initialPublish date. This criteria gives you the possibility to define the format in which you are sending the date or to send the date as a Date and also allows you to define the operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).
Examples:

• Date july2008 = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS").parse("2008-07-06 00:00:00.000");
ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria(july2008);
  will match the items initially published on 2008 July 06 at 00:00:00.000.
• ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria(july2008, Criteria.GREATER_THAN);
  will match the items initially published after 2008 July 06, 00:00:00.000.
• ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria("2008-07-06 00:00:00.000");
  will match the items initially published on 2008 July 06 at 00:00:00.000.
• ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria("2008-07-06 00:00:00.000", "yyyy-MM-dd HH:mm:ss.SSS");
  will match the items initially published on 2008 July 06 at 00:00:00.000.
• ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria("2008-07-06 00:00:00.000", Criteria.GREATER_THAN)
  will match all items initially published after 2008 July 06, 00:00:00.000.
• ItemInitialPublishDateCriteria criteria = new ItemInitialPublishDateCriteria("2008-07-06 00:00:00.000", "yyyy-MM-dd HH:mm:ss.SSS", Criteria.GREATER_THAN)
  will match all items initially published after 2008 July 06, 00:00:00.000.

Field Summary

Fields inherited from class com.tridion.broker.querying.criteria.DateCriteria

DATE_FORMAT, ORACLE_DATE_CONVERSION_STRING

Fields inherited from class com.tridion.broker.querying.criteria.Criteria

EQUAL, GREATER_OR_EQUAL_THAN, GREATER_THAN, LESS_OR_EQUAL_THAN, LESS_THAN, LIKE, NOT_EQUAL

Constructor Summary

Constructors

Constructor and Description
ItemInitialPublishDateCriteria(Date initialPublishDate) Creates a new criteria with a specific initialPublishDate.
ItemInitialPublishDateCriteria(Date initialPublishDate, FieldOperator operator) Creates a new date criteria with a specific initialPublishDate and that uses the specified field operator.
ItemInitialPublishDateCriteria(String initialPublishDate) Creates a new date criteria with a specific initialPublishDate string and expected in the format "yyyy-MM-dd HH:mm:ss.SSS".
ItemInitialPublishDateCriteria(String initialPublishDate, FieldOperator operator) Creates a new date criteria with a specific initialPublishDate string, expected in the format "yyyy-MM-dd HH:mm:ss.SSS" and that uses the specified field operator.
ItemInitialPublishDateCriteria(String initialPublishDate, String dateFormat) Creates a new date criteria with a specific initialPublishDate string and expected in the specified dateFormat.
ItemInitialPublishDateCriteria(String initialPublishDate, String dateFormat, FieldOperator operator) Creates a new date criteria with a specific initialPublishDate string, expected in the specified dateFormat and that uses the specified field operator.

Method Summary

Methods inherited from class com.tridion.broker.querying.criteria.DateCriteria

getConvertedDate, toString

Methods inherited from class com.tridion.broker.querying.criteria.Criteria

addCriteria, getCriteriaChildren, getCriteriaName, getFieldOperatorAsString, getParentOperator, getSignature, hasAnyCriteria, isLikeOperatorApplicable, isOperator, setParentOperator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(Date initialPublishDate)

Creates a new criteria with a specific initialPublishDate. Note that if you use this constructor the used field operator will be EQUAL.

Parameters:

initialPublishDate - The date to be used by this criteria.

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(String initialPublishDate)
                               throws CriteriaException

Creates a new date criteria with a specific initialPublishDate string and expected in the format "yyyy-MM-dd HH:mm:ss.SSS". Note that if you use this constructor the used field operator will be EQUAL.

Parameters:

initialPublishDate - The string representation of the date (expected in the format "yyyy-MM-dd HH:mm:ss.SSS") to be used by this criteria.

Throws:

CriteriaException - if the sent initialPublishDate cannot be parsed with the format "yyyy-MM-dd HH:mm:ss.SSS".

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(String initialPublishDate,
                                      String dateFormat)
                               throws CriteriaException

Creates a new date criteria with a specific initialPublishDate string and expected in the specified dateFormat. Note that if you use this constructor the used field operator will be EQUAL.

Parameters:

initialPublishDate - The string representation of the date to be used by this criteria.

dateFormat - The the date format in which the initialPublishDate is specified.

Throws:

CriteriaException - if the sent initialPublishDate cannot be parsed with the given dateFormat.

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(String initialPublishDate,
                                      FieldOperator operator)
                               throws CriteriaException

Creates a new date criteria with a specific initialPublishDate string, expected in the format "yyyy-MM-dd HH:mm:ss.SSS" and that uses the specified field operator.

Parameters:

initialPublishDate - The string representation of the date (expected in the format "yyyy-MM-dd HH:mm:ss.SSS") to be used by this criteria.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Throws:

CriteriaException - if the sent initialPublishDate cannot be parsed with the format "yyyy-MM-dd HH:mm:ss.SSS".

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(String initialPublishDate,
                                      String dateFormat,
                                      FieldOperator operator)
                               throws CriteriaException

Creates a new date criteria with a specific initialPublishDate string, expected in the specified dateFormat and that uses the specified field operator.

Parameters:

initialPublishDate - The string representation of the date to be used by this criteria.

dateFormat - The the date format in which the initialPublishDate is specified.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Throws:

CriteriaException - if the sent initialPublishDate cannot be parsed with the given dateFormat.

ItemInitialPublishDateCriteria

public ItemInitialPublishDateCriteria(Date initialPublishDate,
                                      FieldOperator operator)

Creates a new date criteria with a specific initialPublishDate and that uses the specified field operator.

Parameters:

initialPublishDate - The date to be used by this criteria.

operator - Operator for the queried date (Criteria.EQUAL, Criteria.GREATER_THAN, ...).