com.webmethods.portal.mech.schedpub

Interface ISchedpubMechanics

public interface ISchedpubMechanics

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) Get a lScheduled 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.
IListView<IScheduledPublish>	listScheduledPublishesByUserForThing(IThingID userID, IThingID thingID) Get a list of schedule publisheds create by the passed user for the passed thing
void	removePublishTarget(int schedID, IThingID topicID) Remove a publish target for a schedpub event.
void	removeScheduledPublish(int schedID) Remove an existing scheduled publishing event.

Method Detail

addScheduledPublish

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

Add a new scheduled publishing event.

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:

PortalException

removeScheduledPublish

void removeScheduledPublish(int schedID)
                     throws PortalException

Remove an existing scheduled publishing event.

Parameters:

schedID - the ID of the event to remove.

Throws:

PortalException

addPublishTarget

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

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:

PortalException

removePublishTarget

void removePublishTarget(int schedID,
                         IThingID topicID)
                  throws PortalException

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:

PortalException

getScheduledPublishById

IScheduledPublish getScheduledPublishById(int schedID)
                                   throws PortalException

Get a lScheduled Publish object by given id

Parameters:

schedID -

Returns:

IScheduledPublish

Throws:

PortalException

listScheduledPublishes

IListView<IScheduledPublish> listScheduledPublishes(IThingID userID)
                                             throws PortalException

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

Parameters:

userID -

Returns:

IListView

Throws:

PortalException

listPublishTargets

IListView<IPublishTarget> listPublishTargets(int schedID)
                                      throws PortalException

Get a list of publish targets for this scheduled publish

Parameters:

schedID -

Returns:

IListView

Throws:

PortalException

listScheduledPublishesByUserForThing

IListView<IScheduledPublish> listScheduledPublishesByUserForThing(IThingID userID,
                                                                  IThingID thingID)
                                                           throws PortalException

Get a list of schedule publisheds create by the passed user for the passed thing

Parameters:

userID -

thingID -

Returns:

IListView

Throws:

PortalException