com.webmethods.portal.mech.schedule

Interface IScheduleMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IInitializable, IMechanics, ISubscribableMechanics, ISystemHandler, IViewableContainerMechanics, IViewableMechanics

public interface IScheduleMechanics
extends IBasicMechanics, IViewableContainerMechanics

Field Summary

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Method Summary

Modifier and Type	Method and Description
boolean	canCreate(IThingID userID, Map<?,?> capabilities) Returns true if the specified user can create a schedule.
void	checkCreate(IThingID userID, Map<?,?> capabilities) Throws a PortalAccessException if the specified user cannot create a schedule.
IThingID	createSchedule(IThingID ownerID, String interval, String timeAt, String eventName) Creates a schedule
IThingID	createSchedule(IThingID ownerID, String interval, String timeAt, String eventName, String callbackInfo) Creates a schedule
void	destroySchedule(IThingID scheduleID) Destroys the given schedule.
void	fireScheduleCreateEvent(IThingID scheduleID, IThingID userID, int status) Fires a schedule create event
void	fireScheduleDestroyEvent(IThingID scheduleID, IThingID userID, int status) Fires a schedule destroy event
void	fireScheduleUpdateEvent(IThingID scheduleID, IThingID userID, int status) Fires a schedule update event
IListView<IView>	listSchedules(IPagingCookie cookie) Lists the schedules in the system
IListView<IView>	listSchedules(IThingID userID, IPagingCookie cookie) Lists the schedules in the system filter for the user
void	setScheduleNextTime(IThingID scheduleID, long nextTime) Updates the schedule next firing time.
void	setSchedulePaused(IThingID scheduleID, boolean paused) Pauses/Unpauses schedule
void	setScheduleProperties(IThingID scheduleID, String interval, String timeAt, String eventName) Updates the schedule properties.
void	triggerSchedule(IThingID scheduleID) Causes an event to be fired for the schedule as if it's scheduled time was now.
IView	view(IURI itemId) Returns the standard view of the specified schedule.
IView	view(IURI itemId, IThingID userId) Returns the view of the specified schedule, filtered for the specified user.

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

Methods inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, isEnabled

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

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Methods inherited from interface com.webmethods.portal.mech.view.IViewableContainerMechanics

createPagingCookie

Method Detail

canCreate

boolean canCreate(IThingID userID,
                  Map<?,?> capabilities)
           throws PortalException

Returns true if the specified user can create a schedule.

Throws:

PortalException

checkCreate

void checkCreate(IThingID userID,
                 Map<?,?> capabilities)
          throws PortalException,
                 PortalAccessException

Throws a PortalAccessException if the specified user cannot create a schedule.

Throws:

PortalException

PortalAccessException

createSchedule

IThingID createSchedule(IThingID ownerID,
                        String interval,
                        String timeAt,
                        String eventName)
                 throws PortalException

Creates a schedule

Parameters:

ownerID - the Thing ID of the owner

interval - the time period that the schedule should repeat
examples: "1H" "1D" "4W" "04:00:00"

timeAt - the time that the schedule should occur
examples: "4F" "4FT12:00" "04:00:00"

eventName - name of event that will be raised

Returns:

the Thing ID of the schedule. This can be used to create a subscription.

Throws:

PortalException

See Also:

ISchedule

createSchedule

IThingID createSchedule(IThingID ownerID,
                        String interval,
                        String timeAt,
                        String eventName,
                        String callbackInfo)
                 throws PortalException

Creates a schedule

Parameters:

ownerID - the Thing ID of the owner

interval - the time period that the schedule should repeat
examples: "1H" "1D" "4W" "04:00:00"

timeAt - the time that the schedule should occur
examples: "4F" "4FT12:00" "04:00:00"

eventName - name of event that will be raised

callbackInfo - additional info to be passed in the schedule event

Returns:

the Thing ID of the schedule. This can be used to create a subscription.

Throws:

PortalException

See Also:

ISchedule

destroySchedule

void destroySchedule(IThingID scheduleID)
              throws PortalException

Destroys the given schedule.

Parameters:

scheduleID - IThingID of the schedule to destroy

Throws:

PortalException

setScheduleProperties

void setScheduleProperties(IThingID scheduleID,
                           String interval,
                           String timeAt,
                           String eventName)
                    throws PortalException

Updates the schedule properties.

Parameters:

scheduleID - top update

interval -

timeAt -

eventName - Properties include: timeAt, interval, and eventName.

Throws:

PortalException

setScheduleNextTime

void setScheduleNextTime(IThingID scheduleID,
                         long nextTime)
                  throws PortalException

Updates the schedule next firing time.

Parameters:

nextTime -

Throws:

PortalException

triggerSchedule

void triggerSchedule(IThingID scheduleID)
              throws PortalException

Causes an event to be fired for the schedule as if it's scheduled time was now.

Parameters:

scheduleID -

Throws:

PortalException

setSchedulePaused

void setSchedulePaused(IThingID scheduleID,
                       boolean paused)
                throws PortalException

Pauses/Unpauses schedule

Parameters:

scheduleID -

paused -

Throws:

PortalException

view

IView view(IURI itemId)
    throws PortalException

Returns the standard view of the specified schedule.

Specified by:

view in interface IViewableMechanics

Parameters:

itemId - schedule to view.

Returns:

View of item or null.

Throws:

PortalException - if an error occurs.

view

IView view(IURI itemId,
           IThingID userId)
    throws PortalException

Returns the view of the specified schedule, filtered for the specified user.

Specified by:

view in interface IViewableMechanics

Parameters:

itemId - Schedule to view.

userId - User for which to filter the view.

Returns:

View of item or null.

Throws:

PortalException - if an error occurs.

listSchedules

IListView<IView> listSchedules(IPagingCookie cookie)
                        throws PortalException

Lists the schedules in the system

Returns:

IListView

Throws:

PortalException

listSchedules

IListView<IView> listSchedules(IThingID userID,
                               IPagingCookie cookie)
                        throws PortalException

Lists the schedules in the system filter for the user

Parameters:

userID -

cookie -

Returns:

IListView

Throws:

PortalException

fireScheduleCreateEvent

void fireScheduleCreateEvent(IThingID scheduleID,
                             IThingID userID,
                             int status)
                      throws PortalException

Fires a schedule create event

Parameters:

scheduleID - ThingID of the created schedule

userID - User creating the schedule

status - Status of the event (sucessful, denied, error)

Throws:

PortalException

fireScheduleDestroyEvent

void fireScheduleDestroyEvent(IThingID scheduleID,
                              IThingID userID,
                              int status)
                       throws PortalException

Fires a schedule destroy event

Parameters:

scheduleID - ThingID of the destroyed schedule

userID - User destroying the schedule

status - Status of the event (successful, denied, error)

Throws:

PortalException

fireScheduleUpdateEvent

void fireScheduleUpdateEvent(IThingID scheduleID,
                             IThingID userID,
                             int status)
                      throws PortalException

Fires a schedule update event

Parameters:

scheduleID - ThingID of the updated schedule

userID - User updating the schedule

status - Status of the event (successful, denied, error)

Throws:

PortalException