com.webmethods.portal.service.meta2.system

Interface ISchedule

All Superinterfaces:

Cloneable, ICacheObjectListener, IScheduleInfo, ISortInfo, IThing, IThingBaseInfo, IThingBaseView, IThingDateInfo, IThingDateView, IThingIDBase, IThingInfo, IThingInfoView, IThingKeywordsInfo, IThingNameInfo, IThingNameView, IThingNoteInfo, IThingParentInfo, IThingParentView, Serializable

public interface ISchedule
extends IScheduleInfo, IThing

A Schedule is a recurring event. It maintains two fields - 'interval' and 'at'. Interval is the recurring period. At is a time within that period. Note: You must explicitly call setNextTime() to update that value in the database.

Nested Class Summary

Nested classes/interfaces inherited from interface com.webmethods.portal.service.meta2.thing.IThingNameInfo

IThingNameInfo.INameAtom

Field Summary

Fields inherited from interface com.webmethods.portal.service.meta2.thing.IThing

INVALID_ID

Fields inherited from interface com.webmethods.portal.service.meta2.thing.IThingBaseInfo

ACL_CAPABILITY, ACL_FREE, ACL_LEVEL_0, ACL_LEVEL_1, ACL_LEVEL_2, ACL_NORMAL, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_NTLM

Method Summary

Modifier and Type	Method and Description
long	computeNextTime(long currentTime) Compute next execution time
boolean	isPaused() Determine whether the schedule is paused or not
void	lock() Set a flag in the database to indicate this Schedule is locked
void	pause() Set a flag in the database to indicate this Schedule is paused
void	resume() Clear a flag in the database to indicate this Schedule is paused
void	setNextTime(long time)
void	unlock() Clear a flag in the database to indicate this Schedule is locked

Methods inherited from interface com.webmethods.portal.service.meta2.system.IScheduleInfo

getAt, getEventName, getEvery, getNextTime, putScheduleInfo, setScheduleInfo

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThing

addToContainer, copy, deactivate, deactivate, delete, delete, destroy, getThingID, getTreePath, getVersionInfo, hashCode, loadThings, onLoad, onSave, reactivate, relate, removeFromContainer, setProperties, setXTypeID, unrelate

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingIDBase

getDbID, getTypeID, getXTypeID

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingBaseInfo

putIsVersioned, putState, putThingInfo, setThingInfo

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingBaseView

getAuthLevel, getIsVersioned, getOwnerID, getState, getStyleID

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingParentInfo

putParentID, setParentID

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingParentView

getParentID

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingDateInfo

putDates, setModified, setModified

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingDateView

getCreationDate, getLastModifiedDate

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingNameInfo

getAllLanguages, getDescription, getName, getNames, getThingLang, putNameDesc, setDescription, setDescription, setName, setName, setNameDesc

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingNameView

getDescription, getName

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingNoteInfo

addNote, getNotes, removeNote

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingInfo

putInfo, setInfo

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingInfoView

getInfo

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingKeywordsInfo

getKeywords, putKeywords, setKeywords

Methods inherited from interface com.webmethods.portal.service.cache.ICacheObjectListener

evictCallback, refreshCallback

Methods inherited from interface com.webmethods.portal.service.meta2.storage.ISortInfo

getSortID, putSortInfo, setSortID

Method Detail

setNextTime

void setNextTime(long time)
          throws MetaException

Throws:

MetaException

lock

void lock()
   throws MetaException

Set a flag in the database to indicate this Schedule is locked

Throws:

MetaException

unlock

void unlock()
     throws MetaException

Clear a flag in the database to indicate this Schedule is locked

Throws:

MetaException

computeNextTime

long computeNextTime(long currentTime)
              throws MetaException

Compute next execution time

Throws:

MetaException

pause

void pause()
    throws MetaException

Set a flag in the database to indicate this Schedule is paused

Throws:

MetaException

resume

void resume()
     throws MetaException

Clear a flag in the database to indicate this Schedule is paused

Throws:

MetaException

isPaused

boolean isPaused()
          throws MetaException

Determine whether the schedule is paused or not

Throws:

MetaException