Package com.ptc.windchill.enterprise.datamonitor

Class DataMonitor

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
com.ptc.windchill.enterprise.datamonitor._DataMonitor
com.ptc.windchill.enterprise.datamonitor.DataMonitor
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.inf.container._WTContained, WTContained, wt.recent.RecentlyVisited, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged
@GenAsPersistable(superClass=Item.class,interfaces={WTContained.class,wt.type.Typed.class},serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="name",type=java.lang.String.class,javaDoc="Name of the data monitor.",constraints=@PropertyConstraints(upperLimit=200,required=true)),@GeneratedProperty(name="description",type=java.lang.String.class,javaDoc="Description of the data monitor.",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="creator",type=WTPrincipalReference.class,constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="threshold",type=java.lang.Long.class,javaDoc="Number of rows in report threshold.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="reportFormat",type=java.lang.String.class,javaDoc="Format of the Generated Report.",constraints=@PropertyConstraints(upperLimit=200)),@GeneratedProperty(name="status",type=com.ptc.windchill.enterprise.datamonitor.DataMonitorStatus.class,javaDoc="Status of the data monitor.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="maxFirings",type=java.lang.Long.class,javaDoc="Maximum number of times to fire this Data Monitor."),@GeneratedProperty(name="immediateMode",type=boolean.class,initialValue="false",javaDoc="Execute immediately or schedule at a later time."),@GeneratedProperty(name="startTime",type=java.sql.Timestamp.class,javaDoc="Time to start schedule."),@GeneratedProperty(name="endTime",type=java.sql.Timestamp.class,javaDoc="Time to end schedule."),@GeneratedProperty(name="frequency",type=java.lang.String.class,javaDoc="Schedule Frequency."),@GeneratedProperty(name="frequencyDays",type=java.lang.String.class,javaDoc="Schedule Frequency Days.",constraints=@PropertyConstraints(upperLimit=4)),@GeneratedProperty(name="frequencyHours",type=java.lang.String.class,javaDoc="Schedule Frequency Hours."),@GeneratedProperty(name="frequencyMinutes",type=java.lang.String.class,javaDoc="Schedule Frequency Minutes."),@GeneratedProperty(name="subject",type=java.lang.String.class,javaDoc="The email subject to include in any notification emails sent for this data monitor."),@GeneratedProperty(name="message",type=java.lang.String.class,javaDoc="Additional message text to include in any notification emails sent for this subscription.",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="emailRecipients",type=java.lang.String.class,javaDoc="Recipients to receive notification when threshold is met."),@GeneratedProperty(name="emailRecipientsCC",type=java.lang.String.class,javaDoc="Recipients to receive notification via CC when threshold is met.")},foreignKeys={@GeneratedForeignKey(name="DataMonitorReportCriteriaForeignKeyLink",foreignKeyRole=@ForeignKeyRole(name="reportCriteria",type=ReportCriteria.class,owner=false,cascade=false,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="monitor")),@GeneratedForeignKey(name="DataMonitorScheduleItemForeignKeyLink",foreignKeyRole=@ForeignKeyRole(name="scheduleItem",type=wt.scheduler.ScheduleItem.class,cascade=false,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="schedule",cardinality=ONE))},tableProperties=@TableProperties(compositeUnique1="name")) public class DataMonitor extends com.ptc.windchill.enterprise.datamonitor._DataMonitor
This class represents the configuration of a periodic execution of a report. The execution result data is monitored and can trigger notifications based on a threshold value.

Supported API: true

Extendible: false
See Also:

  • Field Summary

    Fields inherited from class com.ptc.windchill.enterprise.datamonitor._DataMonitor

    CREATOR, DESCRIPTION, EMAIL_RECIPIENTS, EMAIL_RECIPIENTS_CC, END_TIME, EXTERNALIZATION_VERSION_UID, FREQUENCY, FREQUENCY_DAYS, FREQUENCY_HOURS, FREQUENCY_MINUTES, IMMEDIATE_MODE, MAX_FIRINGS, MESSAGE, NAME, REPORT_CRITERIA, REPORT_CRITERIA_REFERENCE, REPORT_FORMAT, SCHEDULE_ITEM, SCHEDULE_ITEM_REFERENCE, START_TIME, STATUS, SUBJECT, THRESHOLD

    Fields inherited from class wt.fc.Item

    SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.iba.value._IBAHolder

    ATTRIBUTE_CONTAINER

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.type._Typed

    TYPE_DEFINITION_REFERENCE

    Fields inherited from interface wt.inf.container._WTContained

    CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCE

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE

    Fields inherited from interface wt.inf.container.WTContained

    CONTAINER_ID

  • Method Summary

    Methods inherited from class com.ptc.windchill.enterprise.datamonitor._DataMonitor

    getAttributeContainer, getClassInfo, getConceptualClassname, getContainer, getContainerName, getContainerReference, getCreator, getDescription, getEmailRecipients, getEmailRecipientsCC, getEndTime, getFrequency, getFrequencyDays, getFrequencyHours, getFrequencyMinutes, getMaxFirings, getMessage, getName, getReportCriteria, getReportCriteriaReference, getReportFormat, getScheduleItem, getScheduleItemReference, getStartTime, getStatus, getSubject, getThreshold, getType, getTypeDefinitionReference, isImmediateMode, readExternal, readExternal, readVersion, setAttributeContainer, setContainer, setContainerReference, setCreator, setDescription, setEmailRecipients, setEmailRecipientsCC, setEndTime, setFrequency, setFrequencyDays, setFrequencyHours, setFrequencyMinutes, setImmediateMode, setMaxFirings, setMessage, setName, setReportCriteria, setReportFormat, setScheduleItem, setScheduleItemReference, setStartTime, setStatus, setSubject, setThreshold, setTypeDefinitionReference, super_readExternal_DataMonitor, super_readVersion_DataMonitor, super_writeExternal_DataMonitor, writeExternal, writeExternal

    Methods inherited from class wt.fc.Item

    initialize

    Methods inherited from class wt.fc._Item

    getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface wt.fc._Persistable

    getPersistInfo, setPersistInfo

    Methods inherited from interface wt.fc.Persistable

    checkAttributes, getIdentity