com.telelogic.cs.api

Class ScheduledEvent



  • public class ScheduledEvent
    extends TriggerEvent
    Sent at a scheduled time if scheduled, BSF triggers are enabled in pt.cfg.
    Since:
    4.7 06
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String TYPE 
    • Constructor Summary

      Constructors 
      Constructor and Description
      ScheduledEvent(User adminUser) 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      User getAdminUser()
      Gets information about the admin user for the database the trigger fired in.
      java.lang.String getTriggerType()
      Gets the type of this trigger, that is the type of action the spawned this trigger.
      User getTriggerUser()
      Returns the admin user since scheduled scripts are not initiated by a particular user.
      boolean isPostTrigger()
      Gets if this trigger is a post-trigger or not, true if a post-trigger false otherwise.
      boolean isPreTrigger()
      Gets if this trigger is a pre-trigger or not, true if a pre-trigger false otherwise.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ScheduledEvent

        public ScheduledEvent(User adminUser)
    • Method Detail

      • getAdminUser

        public User getAdminUser()
        Description copied from class: TriggerEvent
        Gets information about the admin user for the database the trigger fired in. Can be used in triggers to perform operations as an admin when triggers should run without security restrictions.
        Specified by:
        getAdminUser in class TriggerEvent
        Returns:
        details about the admin user.
      • getTriggerType

        public java.lang.String getTriggerType()
        Description copied from class: TriggerEvent
        Gets the type of this trigger, that is the type of action the spawned this trigger. Can be used to determine what kind of trigger is firing if the same trigger script is reused for multiple trigger types.
        Specified by:
        getTriggerType in class TriggerEvent
        Returns:
        a name for the type of operation this trigger is for.
      • getTriggerUser

        public User getTriggerUser()
        Returns the admin user since scheduled scripts are not initiated by a particular user.
        Specified by:
        getTriggerUser in class TriggerEvent
        Returns:
        same as getAdminUser.
      • isPreTrigger

        public boolean isPreTrigger()
        Description copied from class: TriggerEvent
        Gets if this trigger is a pre-trigger or not, true if a pre-trigger false otherwise.
        Specified by:
        isPreTrigger in class TriggerEvent
        Returns:
        True if a pre-trigger, false otherwise.
      • isPostTrigger

        public boolean isPostTrigger()
        Description copied from class: TriggerEvent
        Gets if this trigger is a post-trigger or not, true if a post-trigger false otherwise.
        Specified by:
        isPostTrigger in class TriggerEvent
        Returns:
        True if a post-trigger, false otherwise.

© Copyright IBM Corporation 2000, 2009
US Government Users Restricted Rights--Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Notices