com.webmethods.portal.service.meta2.system.schedpub

Interface ISchedPubService

All Superinterfaces:

IInitializable

public interface ISchedPubService
extends IInitializable

Title: Description: Copyright: Copyright (c) 2001 Company:

Method Summary

Modifier and Type	Method and Description
void	addPublishTarget(int schedID, IThingID topicID, String aliasName) Add a target to publish to.
int	addScheduledPublish(IThingID thingID, IThingID userID, long startDate, long endDate) Add a new scheduled publishing event.
IScheduledPublish	getScheduledPublishById(int schedId) Gets s Scheduled Publish object by given id
IListView<IPublishTarget>	listPublishTargets(int schedID) get a list of publish targets for this scheduled publish
IListView<IScheduledPublish>	listScheduledPublishes(IThingID userID) Get a list of scheduled publishes created by the passed in user.
void	removePublishTarget(int schedID, IThingID topicID) Remove a publish target for a schedpub event.
void	removeScheduledPublish(int schedID) Remove an existing scheduled publishing event.

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

addScheduledPublish

int addScheduledPublish(IThingID thingID,
                        IThingID userID,
                        long startDate,
                        long endDate)
                 throws MetaException

Add a new scheduled publishing event. Events occur on the hour, every hour, so if you set a time that is in between hours, the publish/unpublish will occur at the next hour.

Parameters:

thingID - The ID of the thing you want to publish

userID - The ID of the user who is creating this event.

startDate - Date to publish the thing, in ms since the epoch.

endDate - Date to unpublish the thing, in ms since the epoch.

Returns:

ID of the publish event

Throws:

MetaException

removeScheduledPublish

void removeScheduledPublish(int schedID)
                     throws MetaException

Remove an existing scheduled publishing event.

Parameters:

schedID - the ID of the event to remove.

Throws:

MetaException

addPublishTarget

void addPublishTarget(int schedID,
                      IThingID topicID,
                      String aliasName)
               throws MetaException

Add a target to publish to.

Parameters:

schedID - the ID of the schedule (returned by addScheduledPublish)

topicID - The ID of the topic to publish to

aliasName - Optional different name for the thing when it's published. May be null.

Throws:

MetaException

removePublishTarget

void removePublishTarget(int schedID,
                         IThingID topicID)
                  throws MetaException

Remove a publish target for a schedpub event.

Parameters:

schedID - the ID of the schedule (returned by addScheduledPublish)

topicID - The ID of the topic to remove

Throws:

MetaException

listScheduledPublishes

IListView<IScheduledPublish> listScheduledPublishes(IThingID userID)
                                             throws MetaException

Get a list of scheduled publishes created by the passed in user.

Returns:

List of IScheduledPublish objects

Throws:

MetaException

listPublishTargets

IListView<IPublishTarget> listPublishTargets(int schedID)
                                      throws MetaException

get a list of publish targets for this scheduled publish

Returns:

List of IPublishTarget objects.

Throws:

MetaException

getScheduledPublishById

IScheduledPublish getScheduledPublishById(int schedId)
                                   throws MetaException

Gets s Scheduled Publish object by given id

Throws:

MetaException