|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainQuery
com.arsdigita.versioning.TransactionCollection
com.arsdigita.versioning.HistoryCollection
Encapsulates a query that returns all the tagged transactions for an object. This query can be used to render a history window for the object.
Field Summary | |
static String |
COMMENT
|
static String |
DUMMY_ID
|
static BigDecimal |
DUMMY_ID_VALUE
|
static String |
EMAIL
|
static String |
SHOW_CURRENT
|
static String |
TIMESTAMP
|
static String |
TRANS
|
static String |
TRANS_ID
|
Fields inherited from class com.arsdigita.domain.DomainQuery |
m_dataQuery, versionId |
Constructor Summary | |
protected |
HistoryCollection(DataQuery q)
Encapsulates the given query. |
Method Summary | |
String |
getComment()
Returns the transaction tag, which counts as the comment for the transaction. |
static HistoryCollection |
getHistory(VersionedACSObject obj,
boolean showCurrent)
Retrieve version history for the given object; retrieves all tagged transactions in reverse chronological order |
DataQuery |
getQuery()
Get the internal data query; useful for data tables |
Date |
getTimestamp()
Returns the creation date of the current version. |
Transaction |
getTransaction()
Returns the current transaction. |
BigDecimal |
getTransactionID()
Returns the current transaction ID; useful for generating URLs |
String |
getUserEmail()
Returns the current user's email. |
BigDecimal |
getVersion()
Returns the current version number. |
static boolean |
isDummyID(BigDecimal id)
Deprecated. with no replacement |
boolean |
next()
Moves to the next object in the collection. |
Methods inherited from class com.arsdigita.domain.DomainQuery |
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String TRANS_ID
public static final String TRANS
public static final String TIMESTAMP
public static final String EMAIL
public static final String COMMENT
public static final String SHOW_CURRENT
public static final String DUMMY_ID
public static final BigDecimal DUMMY_ID_VALUE
Constructor Detail |
protected HistoryCollection(DataQuery q)
Method Detail |
public static HistoryCollection getHistory(VersionedACSObject obj, boolean showCurrent)
obj
- the objectshowCurrent
- true if the draft version of the object should
be appended at the end of the history, false otherwisepublic boolean next()
DomainQuery
next
in interface DataQuery
next
in class DomainQuery
DataQuery.next()
public Transaction getTransaction()
getTransaction
in class TransactionCollection
public BigDecimal getTransactionID()
public String getUserEmail()
public BigDecimal getVersion()
public Date getTimestamp()
public String getComment()
public DataQuery getQuery()
public static boolean isDummyID(BigDecimal id)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |