com.fatwire.realtime.event

Interface PublishingEvent

All Superinterfaces:

Event

@Exported
public interface PublishingEvent
extends Event

The Event interface that Content Server real time publishing uses to notice users of the publishing tasks status

Method Summary

Modifier and Type	Method and Description
List<AssetId>	getAssetIds() Gets the List of published asset
String	getMessage() Gets the String message of the publishing session/tasks
Map<String,Object>	getProperties()
String	getPubSessionId() The method to retrieve the publish session id from PublishEvent
String	getRouteSlip()
PublishingStatusEnum	getStatus() Gets the publishing status
String	getTargetId() Gets the targetid of publish
String	getTargetname() Gets the targetname of publish
RealTimeConstants.PublishingTasks	getTaskName() Gets the publishing task name from the PublishEvent
String	getUsername() Gets the username of publish
void	setAssetIds(List<AssetId> assetIds) Sets the List of published asset
void	setMessage(String message) Sets the String message of the publishing session/tasks
void	setProperties(Map<String,Object> properties)
void	setPubSessionId(String pubSessionId) Set the publishing sesssion id to Event
void	setRouteSlip(String routeSlip)
void	setStatus(PublishingStatusEnum status) Sets the publishing status to the PublishEvent
void	setTargetId(String targetid) Sets the targetid of publish
void	setTargetname(String targetname) Sets the targetname of publish
void	setTaskName(RealTimeConstants.PublishingTasks taskname) Sets the publish task name to the PublishEvent
void	setUsername(String username) Sets the username of publish

Method Detail

setPubSessionId

void setPubSessionId(String pubSessionId)

Set the publishing sesssion id to Event

Parameters:

pubSessionId - the string id of the publishing session

getPubSessionId

String getPubSessionId()

The method to retrieve the publish session id from PublishEvent

Returns:

the String id of the publish session

setTaskName

void setTaskName(RealTimeConstants.PublishingTasks taskname)

Sets the publish task name to the PublishEvent

Parameters:

taskname - the Publishing task name

getTaskName

RealTimeConstants.PublishingTasks getTaskName()

Gets the publishing task name from the PublishEvent

Returns:

the publishing task name

getStatus

PublishingStatusEnum getStatus()

Gets the publishing status

Returns:

the status of the publishing session or sub tasks

setStatus

void setStatus(PublishingStatusEnum status)

Sets the publishing status to the PublishEvent

Parameters:

status - the status Object of the pubishing session/tasks

setMessage

void setMessage(String message)

Sets the String message of the publishing session/tasks

Parameters:

message - the String message

getMessage

String getMessage()

Gets the String message of the publishing session/tasks

Returns:

the String message

getAssetIds

List<AssetId> getAssetIds()

Gets the List of published asset

Returns:

the String message

setAssetIds

void setAssetIds(List<AssetId> assetIds)

Sets the List of published asset

Parameters:

assetIds - asset Id's

getUsername

String getUsername()

Gets the username of publish

Returns:

the String username

setUsername

void setUsername(String username)

Sets the username of publish

Parameters:

username - a user name

getTargetname

String getTargetname()

Gets the targetname of publish

Returns:

the String targetname

setTargetname

void setTargetname(String targetname)

Sets the targetname of publish

Parameters:

targetname - targetname of publish

getTargetId

String getTargetId()

Gets the targetid of publish

Returns:

the String targetid

setTargetId

void setTargetId(String targetid)

Sets the targetid of publish

Parameters:

targetid - targetid of publish

getRouteSlip

String getRouteSlip()

setRouteSlip

void setRouteSlip(String routeSlip)

getProperties

Map<String,Object> getProperties()

setProperties

void setProperties(Map<String,Object> properties)