com.webmethods.portal.bizPolicy.biz.meta.schedpub

Interface ISchedpubPolicy

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler

public interface ISchedpubPolicy
extends IBizPolicy

Policy for working with scheduled publishing.

Method Summary

Modifier and Type	Method and Description
List<IThingID>	addSchedulePublish(IContext context, IThingID thingID, IThingIDList topicIDList, List<String> aliasNameList, long startDate, long endDate) Creates a new scheduled publish.
IScheduledPublish	getSchedulePublish(IContext context, int schedID) Get a scheduled publish object by given id
IListView<IPublishTarget>	listPublishTargets(IContext context, int schedID) Get a list of publish targets for this scheduled publish
IListView<IScheduledPublish>	listScheduledPublishes(IContext context) Get a list of scheduled publishes created by the current user.
IListView<IScheduledPublish>	listScheduledPublishesForResource(IContext context, IThingID thingID) Get a list of scheduled publishes created by the current user for the passed thing
void	removeSchedulePublish(IContext context, int schedID) Removes an existing scheduled publish
List<IThingID>	updateSchedulePublish(IContext context, int schedID, IThingID thingID, IThingIDList topicIDList, List<String> aliasNameList, long startDate, long endDate) Updates an existing scheduled publish.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

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

init, shutdown

Method Detail

addSchedulePublish

List<IThingID> addSchedulePublish(IContext context,
                                  IThingID thingID,
                                  IThingIDList topicIDList,
                                  List<String> aliasNameList,
                                  long startDate,
                                  long endDate)
                           throws BizException

Creates a new scheduled publish.

Parameters:

context - Context state information (current user, etc.).

thingID - IThingID of the item to publish.

topicIDList - IThingIDList of topics that are the publish targets

aliasNameList - aliases to create

startDate - time the publishing will occur

endDate - time the published shortucts will be removed

Returns:

List of created scheduled publishes

Throws:

BizException

updateSchedulePublish

List<IThingID> updateSchedulePublish(IContext context,
                                     int schedID,
                                     IThingID thingID,
                                     IThingIDList topicIDList,
                                     List<String> aliasNameList,
                                     long startDate,
                                     long endDate)
                              throws BizException

Updates an existing scheduled publish.

Parameters:

context - Context state information (current user, etc.).

schedID - ID of the scheduled publish to update

thingID - IThingID of the item to publish.

topicIDList - IThingIDList of topics that are the publish targets

aliasNameList - aliases to create

startDate - time the publishing will occur

endDate - time the published shortucts will be removed

Returns:

List of updated scheduled publishes

Throws:

BizException

removeSchedulePublish

void removeSchedulePublish(IContext context,
                           int schedID)
                    throws BizException

Removes an existing scheduled publish

Parameters:

context - Context state information (current user, etc.).

schedID - ID of the scheduled publish to update

Throws:

BizException

getSchedulePublish

IScheduledPublish getSchedulePublish(IContext context,
                                     int schedID)
                              throws BizException

Get a scheduled publish object by given id

Parameters:

context - Context state information (current user, etc.).

schedID - ID of the scheduled publish to update

Returns:

IScheduledPublish

Throws:

BizException

listPublishTargets

IListView<IPublishTarget> listPublishTargets(IContext context,
                                             int schedID)
                                      throws BizException

Get a list of publish targets for this scheduled publish

Parameters:

context - Context state information (current user, etc.).

schedID - ID of the scheduled publish to update

Returns:

IListView of topics that are the publish targets

Throws:

BizException

listScheduledPublishes

IListView<IScheduledPublish> listScheduledPublishes(IContext context)
                                             throws BizException

Get a list of scheduled publishes created by the current user.

Parameters:

context - Context state information (current user, etc.).

Returns:

IListView of scheduled publishes

Throws:

BizException

listScheduledPublishesForResource

IListView<IScheduledPublish> listScheduledPublishesForResource(IContext context,
                                                               IThingID thingID)
                                                        throws BizException

Get a list of scheduled publishes created by the current user for the passed thing

Parameters:

context - Context state information (current user, etc.).

thingID - IThingID of the item to publish

Returns:

IListView of scheduled publishes

Throws:

BizException