com.ibm.commerce.contentmanagement.events

Class WorkspaceEventFactory

java.lang.Object

com.ibm.commerce.contentmanagement.events.WorkspaceEventFactory

public class WorkspaceEventFactory
extends java.lang.Object

A factory to create the content context event.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
static WorkspaceEventFactory	getInstance() Returns an instance of the content context factory.
static int	getTaskEventType(java.lang.Integer status) Generates the Task event with the type specified.
static int	getTaskGroupEventType(java.lang.Integer status) Generates the Task event with the type specified.
static int	getWorkspaceEventType(java.lang.Integer status) Generates the Workspace event with the type specified.
void	sendTaskCompleteEvent(java.lang.Long taskId, CommandContext cmdContext) Generates a Task Complete event.
void	sendTaskCompleteEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, java.lang.Long taskId, CommandContext cmdContext) Generates a Task Complete event.
void	sendTaskEvent(int eventType, java.lang.Integer oldStatus, java.lang.Long taskId, CommandContext cmdContext) Generates the Task event with the type specified.
void	sendTaskGroupApprovedEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Approved event.
void	sendTaskGroupApprovedEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Approved event.
void	sendTaskGroupCommitFailedEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Commit Failed event.
void	sendTaskGroupCommitFailedEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Commit Failed event.
void	sendTaskGroupCommitInProgressEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Commit in Progress event.
void	sendTaskGroupCommitInProgressEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Commit in Progress event.
void	sendTaskGroupCommittedEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Committed event.
void	sendTaskGroupCommittedEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Committed event.
void	sendTaskGroupCompleteEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Completed event.
void	sendTaskGroupCompleteEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Completed event.
void	sendTaskGroupEvent(int eventType, java.lang.Integer oldStatus, java.lang.Long taskGroupId, CommandContext cmdContext) Generates the Task Group event with the type specified.
void	sendTaskGroupReadyForApprovalEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready for Approval event.
void	sendTaskGroupReadyForApprovalEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready for Approval event.
void	sendTaskGroupReadyToCommitEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready to Commit event.
void	sendTaskGroupReadyToCommitEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready to Commit event.
void	sendTaskGroupReadyToPublish(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready for Publish event.
void	sendTaskGroupReadyToPublish(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Ready for Publish event.
void	sendTaskGroupWorkingEvent(java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Working event.
void	sendTaskGroupWorkingEvent(java.lang.Long workspaceId, java.lang.Long taskGroupId, CommandContext cmdContext) Generates a Task Group Working event.
void	sendWorkspaceCancelledEvent(java.lang.Long workspaceId, CommandContext cmdContext) Generates a Task Group Commit Failed event.
void	sendWorkspaceEvent(int eventType, java.lang.Long workspaceId, CommandContext cmdContext) Generates the Task event with the type specified.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

getInstance

public static WorkspaceEventFactory getInstance()

Returns an instance of the content context factory.

Returns:

An instance of the content context factory.

sendTaskCompleteEvent

public void sendTaskCompleteEvent(java.lang.Long workspaceId,
                                  java.lang.Long taskGroupId,
                                  java.lang.Long taskId,
                                  CommandContext cmdContext)
                           throws ECException

Generates a Task Complete event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

taskId - The task Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskCompleteEvent

public void sendTaskCompleteEvent(java.lang.Long taskId,
                                  CommandContext cmdContext)
                           throws ECException

Generates a Task Complete event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

taskId - The task Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupWorkingEvent

public void sendTaskGroupWorkingEvent(java.lang.Long workspaceId,
                                      java.lang.Long taskGroupId,
                                      CommandContext cmdContext)
                               throws ECException

Generates a Task Group Working event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupWorkingEvent

public void sendTaskGroupWorkingEvent(java.lang.Long taskGroupId,
                                      CommandContext cmdContext)
                               throws ECException

Generates a Task Group Working event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyForApprovalEvent

public void sendTaskGroupReadyForApprovalEvent(java.lang.Long workspaceId,
                                               java.lang.Long taskGroupId,
                                               CommandContext cmdContext)
                                        throws ECException

Generates a Task Group Ready for Approval event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyForApprovalEvent

public void sendTaskGroupReadyForApprovalEvent(java.lang.Long taskGroupId,
                                               CommandContext cmdContext)
                                        throws ECException

Generates a Task Group Ready for Approval event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupApprovedEvent

public void sendTaskGroupApprovedEvent(java.lang.Long workspaceId,
                                       java.lang.Long taskGroupId,
                                       CommandContext cmdContext)
                                throws ECException

Generates a Task Group Approved event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupApprovedEvent

public void sendTaskGroupApprovedEvent(java.lang.Long taskGroupId,
                                       CommandContext cmdContext)
                                throws ECException

Generates a Task Group Approved event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyToCommitEvent

public void sendTaskGroupReadyToCommitEvent(java.lang.Long workspaceId,
                                            java.lang.Long taskGroupId,
                                            CommandContext cmdContext)
                                     throws ECException

Generates a Task Group Ready to Commit event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyToCommitEvent

public void sendTaskGroupReadyToCommitEvent(java.lang.Long taskGroupId,
                                            CommandContext cmdContext)
                                     throws ECException

Generates a Task Group Ready to Commit event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommitInProgressEvent

public void sendTaskGroupCommitInProgressEvent(java.lang.Long workspaceId,
                                               java.lang.Long taskGroupId,
                                               CommandContext cmdContext)
                                        throws ECException

Generates a Task Group Commit in Progress event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommitInProgressEvent

public void sendTaskGroupCommitInProgressEvent(java.lang.Long taskGroupId,
                                               CommandContext cmdContext)
                                        throws ECException

Generates a Task Group Commit in Progress event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommittedEvent

public void sendTaskGroupCommittedEvent(java.lang.Long workspaceId,
                                        java.lang.Long taskGroupId,
                                        CommandContext cmdContext)
                                 throws ECException

Generates a Task Group Committed event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommittedEvent

public void sendTaskGroupCommittedEvent(java.lang.Long taskGroupId,
                                        CommandContext cmdContext)
                                 throws ECException

Generates a Task Group Committed event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyToPublish

public void sendTaskGroupReadyToPublish(java.lang.Long workspaceId,
                                        java.lang.Long taskGroupId,
                                        CommandContext cmdContext)
                                 throws ECException

Generates a Task Group Ready for Publish event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupReadyToPublish

public void sendTaskGroupReadyToPublish(java.lang.Long taskGroupId,
                                        CommandContext cmdContext)
                                 throws ECException

Generates a Task Group Ready for Publish event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCompleteEvent

public void sendTaskGroupCompleteEvent(java.lang.Long workspaceId,
                                       java.lang.Long taskGroupId,
                                       CommandContext cmdContext)
                                throws ECException

Generates a Task Group Completed event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCompleteEvent

public void sendTaskGroupCompleteEvent(java.lang.Long taskGroupId,
                                       CommandContext cmdContext)
                                throws ECException

Generates a Task Group Completed event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommitFailedEvent

public void sendTaskGroupCommitFailedEvent(java.lang.Long workspaceId,
                                           java.lang.Long taskGroupId,
                                           CommandContext cmdContext)
                                    throws ECException

Generates a Task Group Commit Failed event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupCommitFailedEvent

public void sendTaskGroupCommitFailedEvent(java.lang.Long taskGroupId,
                                           CommandContext cmdContext)
                                    throws ECException

Generates a Task Group Commit Failed event.

Parameters:

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendWorkspaceCancelledEvent

public void sendWorkspaceCancelledEvent(java.lang.Long workspaceId,
                                        CommandContext cmdContext)
                                 throws ECException

Generates a Task Group Commit Failed event.

Parameters:

workspaceId - The workspace Id.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskGroupEvent

public void sendTaskGroupEvent(int eventType,
                               java.lang.Integer oldStatus,
                               java.lang.Long taskGroupId,
                               CommandContext cmdContext)
                        throws ECException

Generates the Task Group event with the type specified.

Parameters:

eventType - The type of event to be send.

oldStatus - The previous status of the task group.

taskGroupId - The task group Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendTaskEvent

public void sendTaskEvent(int eventType,
                          java.lang.Integer oldStatus,
                          java.lang.Long taskId,
                          CommandContext cmdContext)
                   throws ECException

Generates the Task event with the type specified.

Parameters:

eventType - The type of event to be send.

oldStatus - The previous status of the task.

taskId - The task Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

sendWorkspaceEvent

public void sendWorkspaceEvent(int eventType,
                               java.lang.Long workspaceId,
                               CommandContext cmdContext)
                        throws ECException

Generates the Task event with the type specified.

Parameters:

eventType - The type of event to be send.

taskId - The task Id.

cmdContext - The command context of the current session.

Throws:

ECException - An exception may occur by the listener when the event is handled.

getTaskGroupEventType

public static int getTaskGroupEventType(java.lang.Integer status)

Generates the Task event with the type specified.

Parameters:

status - The status of task group.

Returns:

The task event with the type specified.

Throws:

ECException - An exception may occur by the listener when the event is handled.

getTaskEventType

public static int getTaskEventType(java.lang.Integer status)

Generates the Task event with the type specified.

Parameters:

status - The status of task.

Returns:

The task event with the type specified.

getWorkspaceEventType

public static int getWorkspaceEventType(java.lang.Integer status)

Generates the Workspace event with the type specified.

Parameters:

status - The status of workspace.

Returns:

The workspace event with the type specified.