| java.lang.Object
 com.bigbross.bossa.history.Historian
| Constructor Summary | |
| public | Historian(Bossa engine)
Creates a new empty historian. |
| Method Summary | |
| public void | exportHistory(Date end, String file)
Exports to a XML file all events that took place before the provided
date. | | Bossa | getBossa()
Returns the bossa engine this historian is part. | | public List | getCaseHistory(String caseTypeId, int caseId)
Return all events that took place until now and are related to a
case. | | public List | getCaseHistory(Date start, String caseTypeId, int caseId)
Returns the events that took place after the start date, inclusive,
until now and are related to a case. | | public List | getCaseHistory(Date start, Date end, String caseTypeId, int caseId)
Returns the events that took place between the start date and the
end date, including the start date and excluding the end date, and
are related to a case. | | public List | getCaseTypeHistory(String caseTypeId)
Return all events that took place until now and are related to a
case type. | | public List | getCaseTypeHistory(Date start, String caseTypeId)
Returns the events that took place after the start date, inclusive,
until now and are related to a case type. | | public List | getCaseTypeHistory(Date start, Date end, String caseTypeId)
Returns the events that took place between the start date and the
end date, including the start date and excluding the end date, and
are related to a case type. | | public List | getHistory()
Return all events that took place until now. | | public List | getHistory(Date start)
Returns the events that took place after the start date, inclusive,
until now. | | public List | getHistory(Date start, Date end)
Returns the events that took place between the start date and
the end date, including the start date and excluding the end date. | | public List | getResourceHistory(String resourceId)
Return all events that took place until now and are related to a
resource. | | public List | getResourceHistory(Date start, String resourceId)
Returns the events that took place after the start date, inclusive,
until now and are related to a resource. | | public List | getResourceHistory(Date start, Date end, String resourceId)
Returns the events that took place between the start date and the end
date, including the start date and excluding the end date, and
are related to a resource. | | void | newEvent(Event event)
Adds a new event to the history. | | public void | purgeHistory(Date end)
Removes from history all events that took place before the provided
date. | | void | purgeHistoryImpl(Date end)
Removes from history all events that took place before the provided
date. |
| Historian | | public Historian(Bossa engine)(Code) | | Creates a new empty historian.
Parameters:
engine - the bossa engine this historian is part. |
| exportHistory | | public void exportHistory(Date end, String file) throws DataTransferException(Code) | | Exports to a XML file all events that took place before the provided
date. Events that happened exactly at the provided date are not
exported. This method complements the purgeHistory method,
providing a way to save events before purging them.
The format of the exported file is the same used by the
EventsXMLHelper class. This class may also be used to
export any event list obtained from the other historian methods.
Parameters:
end - the limit date for event removal.
Parameters:
file - the name of the file.
See Also: Historian.purgeHistory(Date)
See Also: com.bigbross.bossa.io.EventsXMLHelper |
| getBossa | | Bossa getBossa()(Code) | | Returns the bossa engine this historian is part.
the bossa engine this historian is part. |
| getCaseHistory | | public List getCaseHistory(String caseTypeId, int caseId)(Code) | | Return all events that took place until now and are related to a
case.
Parameters:
caseTypeId - the id of the case type.
Parameters:
caseId - the id of the case. all events that took place util now related to the case. |
| getCaseHistory | | public List getCaseHistory(Date start, String caseTypeId, int caseId)(Code) | | Returns the events that took place after the start date, inclusive,
until now and are related to a case.
Parameters:
start - the start date.
Parameters:
caseTypeId - the id of the case type.
Parameters:
caseId - the id of the case. the events that took place after the start date until nowrelated to the case. |
| getCaseHistory | | public List getCaseHistory(Date start, Date end, String caseTypeId, int caseId)(Code) | | Returns the events that took place between the start date and the
end date, including the start date and excluding the end date, and
are related to a case.
Parameters:
start - the start date.
Parameters:
end - the end date.
Parameters:
caseTypeId - the id of the case type.
Parameters:
caseId - the id of the case. the events that took place between the two dates, relatedto the case. |
| getCaseTypeHistory | | public List getCaseTypeHistory(String caseTypeId)(Code) | | Return all events that took place until now and are related to a
case type.
Parameters:
caseTypeId - the id of the case type. all events that took place until now related to the case type. |
| getCaseTypeHistory | | public List getCaseTypeHistory(Date start, String caseTypeId)(Code) | | Returns the events that took place after the start date, inclusive,
until now and are related to a case type.
Parameters:
start - the start date.
Parameters:
caseTypeId - the id of the case type. the events that took place after the start date until nowrelated to the case type. |
| getCaseTypeHistory | | public List getCaseTypeHistory(Date start, Date end, String caseTypeId)(Code) | | Returns the events that took place between the start date and the
end date, including the start date and excluding the end date, and
are related to a case type.
Parameters:
start - the start date.
Parameters:
end - the end date.
Parameters:
caseTypeId - the id of the case type. the events that took place between the two dates, related tothe case type. |
| getHistory | | public List getHistory()(Code) | | Return all events that took place until now.
all events that took place until now. |
| getHistory | | public List getHistory(Date start)(Code) | | Returns the events that took place after the start date, inclusive,
until now.
Parameters:
start - the start date. the events that took place after the start date until now. |
| getHistory | | public List getHistory(Date start, Date end)(Code) | | Returns the events that took place between the start date and
the end date, including the start date and excluding the end date.
Parameters:
start - the start date.
Parameters:
end - the end date. the events that took place between the two dates. |
| getResourceHistory | | public List getResourceHistory(String resourceId)(Code) | | Return all events that took place until now and are related to a
resource.
Parameters:
resourceId - the id of the resource. all events that took place until now related to the resource. |
| getResourceHistory | | public List getResourceHistory(Date start, String resourceId)(Code) | | Returns the events that took place after the start date, inclusive,
until now and are related to a resource.
Parameters:
start - the start date.
Parameters:
resourceId - the id of the resource. the events that took place after the start date until nowrelated to the resource. |
| getResourceHistory | | public List getResourceHistory(Date start, Date end, String resourceId)(Code) | | Returns the events that took place between the start date and the end
date, including the start date and excluding the end date, and
are related to a resource.
Parameters:
start - the start date.
Parameters:
end - the end date.
Parameters:
resourceId - the id of the resource. the events that took place between the two dates, related tothe resource. |
| newEvent | | void newEvent(Event event)(Code) | | Adds a new event to the history.
Parameters:
event - the new event. |
| purgeHistory | | public void purgeHistory(Date end) throws BossaException(Code) | | Removes from history all events that took place before the provided
date. Events that happened exactly at the provided date are not
removed.
Parameters:
end - the limit date for event removal.
exception:
PersistenceException - if an error occours when making theexecution of this method persistent. |
| purgeHistoryImpl | | void purgeHistoryImpl(Date end)(Code) | | Removes from history all events that took place before the provided
date. Events that happened exactly at the provided date are not
removed.
This method does not create a transaction in the prevalent system. The
execution of this method will not be persistent unless it is called
inside an appropriate transaction.
Parameters:
end - the limit date for event removal. |
|
|