com.retek.component.history
Interface HistoryManager

All Superinterfaces:
DistributedObjectManager

public interface HistoryManager
extends DistributedObjectManager


Method Summary
 HistoryEventType buildExternalHistoryEventType()
           
 HistoryEvent buildGenericHistoryEventInstanceForCustomer(User user, Customer customer, java.lang.String eventDetail)
          Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).
 HistoryEvent buildGenericHistoryEventInstanceForOrder(User user, CustomerOrder order, HistoryEventType eventType, HistoryEventVisibility visibility, java.lang.String eventDetail)
          Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer order. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).
 HistoryEvent buildGenericHistoryEventInstanceForOrder(User user, CustomerOrder order, HistoryEventVisibility visibility, java.lang.String eventDetail)
          Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer order. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).
 HistoryEvent buildHistoryEventInstance(HistoryEventRequest eventRequest)
          Build a new history event instance for a history event request object.
 HistoryEvent buildHistoryEventInstanceForActivityRequest(Banner banner, ChannelType channelType, User user, Customer customer, CustomerOrder order, ActivityRequest request)
          Build a new customer history event instance for an activity request.
 HistoryEvent buildHistoryEventInstanceForCustomer(Banner banner, ChannelType channelType, HistoryEventType type, User user, Customer customer)
          Build a new customer history event instance for a customer.
 HistoryEvent buildHistoryEventInstanceForOrder(HistoryEventType type, User user, CustomerOrder order)
          Build a new customer history event instance for an order.
 java.util.Set findAllEventTypes()
           
 java.util.List findEventsForCustomer(Customer customer)
          Find all history events for a specified customer (regardless of visibility).
 java.util.List findEventsForCustomerVisibleAtCustomer(Customer customer)
          Find all history events for a specified customer which have visibility set to customer only.
 java.util.List findEventsForOrder(CustomerOrder order)
          Find history events for a specified customer order.
 boolean isEventTypeEquals(HistoryEventRequest request, java.lang.String eventTypeId)
           
 boolean isEventTypeEquals(HistoryEvent event, java.lang.String eventTypeId)
           
 HistoryEvent read(DistributedReference ref)
          Read a history event for a specified reference.
 HistoryEventType readHistoryEventType(java.lang.String eventTypeId)
           
 void submitHistoryEvents(java.util.Collection eventRequests)
          Submit one or more history events to the history database for a specified set of history event requests.
 
Methods inherited from interface com.retek.commons.component.DistributedObjectManager
getContext
 

Method Detail

buildHistoryEventInstanceForCustomer

public HistoryEvent buildHistoryEventInstanceForCustomer(Banner banner,
                                                         ChannelType channelType,
                                                         HistoryEventType type,
                                                         User user,
                                                         Customer customer)
                                                  throws SystemException,
                                                         BusinessException
Build a new customer history event instance for a customer.

Parameters:
banner - banner for the new event
channelType - channel type for the new event
type - history event type
user - user that created the new event
customer - customer for the new event
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

buildHistoryEventInstanceForOrder

public HistoryEvent buildHistoryEventInstanceForOrder(HistoryEventType type,
                                                      User user,
                                                      CustomerOrder order)
                                               throws SystemException,
                                                      BusinessException
Build a new customer history event instance for an order.

Parameters:
type - history event type
user - user that created the new event
order - order for the new event
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

buildHistoryEventInstanceForActivityRequest

public HistoryEvent buildHistoryEventInstanceForActivityRequest(Banner banner,
                                                                ChannelType channelType,
                                                                User user,
                                                                Customer customer,
                                                                CustomerOrder order,
                                                                ActivityRequest request)
                                                         throws SystemException,
                                                                BusinessException
Build a new customer history event instance for an activity request.

Parameters:
banner - banner for the new event
channelType - channel type for the new event
user - user that created the new event
customer - customer for the new event
order - order for the new event
request - activity request for the new event
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

buildHistoryEventInstance

public HistoryEvent buildHistoryEventInstance(HistoryEventRequest eventRequest)
                                       throws SystemException
Build a new history event instance for a history event request object. A history event request is a light-weight bean which can be used to queue up history events on another object (ex. customer order) during a larger process to facilitate transaction integrity in managing history events.

Parameters:
eventRequest - history event request bean
Returns:
HistoryEvent new history event instance
Throws:
SystemException
See Also:
HistoryManager#submitHistoryEvents(Set)

read

public HistoryEvent read(DistributedReference ref)
                  throws SystemException
Read a history event for a specified reference.

Parameters:
ref - history event reference
Returns:
HistoryEvent
Throws:
SystemException

findEventsForOrder

public java.util.List findEventsForOrder(CustomerOrder order)
                                  throws SystemException,
                                         BusinessException
Find history events for a specified customer order.

Parameters:
order - customer order
Returns:
List matching history events for the order
Throws:
SystemException
BusinessException

findEventsForCustomer

public java.util.List findEventsForCustomer(Customer customer)
                                     throws SystemException,
                                            BusinessException
Find all history events for a specified customer (regardless of visibility).

Parameters:
customer - customer
Returns:
List matching history events for the customer
Throws:
SystemException
BusinessException

findEventsForCustomerVisibleAtCustomer

public java.util.List findEventsForCustomerVisibleAtCustomer(Customer customer)
                                                      throws SystemException,
                                                             BusinessException
Find all history events for a specified customer which have visibility set to customer only.

Parameters:
customer - customer
Returns:
List matching history events for the customer
Throws:
SystemException
BusinessException

buildGenericHistoryEventInstanceForCustomer

public HistoryEvent buildGenericHistoryEventInstanceForCustomer(User user,
                                                                Customer customer,
                                                                java.lang.String eventDetail)
                                                         throws SystemException,
                                                                BusinessException
Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).

Parameters:
user - user that created the new event
customer - customer for the new event
eventDetail - event detail
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

buildGenericHistoryEventInstanceForOrder

public HistoryEvent buildGenericHistoryEventInstanceForOrder(User user,
                                                             CustomerOrder order,
                                                             HistoryEventVisibility visibility,
                                                             java.lang.String eventDetail)
                                                      throws SystemException,
                                                             BusinessException
Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer order. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).

Parameters:
user - user that created the new event
order - order for the new event
visibility - history event visilbility
eventDetail - event detail
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

buildGenericHistoryEventInstanceForOrder

public HistoryEvent buildGenericHistoryEventInstanceForOrder(User user,
                                                             CustomerOrder order,
                                                             HistoryEventType eventType,
                                                             HistoryEventVisibility visibility,
                                                             java.lang.String eventDetail)
                                                      throws SystemException,
                                                             BusinessException
Deprecated. : 3/31/2004 : Please use one of the buildHistoryEventInstance methods Build a new generic history event instance for a customer order. Note: This api is intended for use by external integration layer to RCOM (not for use internally within the RCOM application, see the other build instance patterns for building new history events within RCOM).

Parameters:
user - user that created the new event
order - order for the new event
visibility - history event visilbility
eventDetail - event detail
Returns:
HistoryEvent new history event instance
Throws:
SystemException
BusinessException
See Also:
HistoryEvent.submit()

submitHistoryEvents

public void submitHistoryEvents(java.util.Collection eventRequests)
                         throws SystemException
Submit one or more history events to the history database for a specified set of history event requests.

Parameters:
eventRequests - history event request beans
Throws:
SystemException
See Also:
HistoryEventRequest

isEventTypeEquals

public boolean isEventTypeEquals(HistoryEvent event,
                                 java.lang.String eventTypeId)
                          throws SystemException
Throws:
SystemException

isEventTypeEquals

public boolean isEventTypeEquals(HistoryEventRequest request,
                                 java.lang.String eventTypeId)
                          throws SystemException
Throws:
SystemException

readHistoryEventType

public HistoryEventType readHistoryEventType(java.lang.String eventTypeId)
                                      throws SystemException
Throws:
SystemException

buildExternalHistoryEventType

public HistoryEventType buildExternalHistoryEventType()
                                               throws SystemException
Throws:
SystemException

findAllEventTypes

public java.util.Set findAllEventTypes()
                                throws SystemException
Throws:
SystemException


Copyright © 2005 Retek Inc. All Rights Reserved. - Generated at Fri, 01/21/2005 14:25