FIN 5.3.1 中文文档

外观

finScheduler ​

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793914382/FIN+5.3.1+finScheduler 中文整理基于 FIN 5.3.1

finScheduler ​

FIN 调度器应用程序

classes ​

BacnetTime
CalendarAdapter
CalendarDate
CalendarDateObject
CalendarEntry
CalendarGridObject
CalendarRange
CalendarRule
CalendarWeekNDay
DayToSchedule
FinXCalendarObject
FinXScheduleObject
ScheduleAdapter
ScheduleEventObject
ScheduleGridObject
ScheduleUtils
SchedulerMod
SchedulerQueryHelper
SkysparkCalendarObject
SkysparkScheduleObject
SpecialEvent
TimeToVal

enums ​

CalendarType
ScheduleType

BacnetTime ​

const class BacnetTime : Obj

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

hour
hundredths
minute
second

方法

toDict

插槽详情 ​

hour ​

const Number? 小时

hundredths ​

const Number? 百分位

makeFromSkysparkObj ​

new makeFromSkysparkObj(Time 时间对象)

makeFromUiObj ​

new makeFromUiObj(Dict 时间)

minute ​

常量 Number? 分钟

second ​

const Number? second

toDict ​

转为字典()

CalendarAdapter ​

const class CalendarAdapter : Obj

方法

fromFinxToSkysparkCalendar
fromFolioToSkySpark
fromSkysparkToFinxCalendar
fromSkysparkToFolioCalendar
fromUiToFinxCalendar
getSkySparkCalendarDates

插槽详情 ​

fromFinxToSkysparkCalendar ​

static SkysparkCalendarObject 从 FinxCalendar 转换为 SkysparkCalendar(FinXCalendarObject finxCalendarObject)

fromFolioToSkySpark ​

static SkysparkCalendarObject 从Folio到SkySpark(Obj folioCalendarObject)

fromSkysparkToFinxCalendar ​

static FinXCalendarObject 从 Skyspark 到 FinxCalendar(Obj folioCalendarObject)

fromSkysparkToFolioCalendar ​

static Dict 从Skyspark到Folio日历(SkysparkCalendarObject calendarObject)

fromUiToFinxCalendar ​

static FinXCalendarObject 从 Ui 到 Finx 日历(Obj uiCalendarObject)

getSkySparkCalendarDates ​

static CalendarDateObject[] 获取SkySpark日历日期(CalendarGridObject calendarGridObject, Str start, Str end, SkysparkCalendarObject skysparkCalendar)

CalendarDate ​

const class CalendarDate : CalendarEntry

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

dayOfMonth
month
year

方法

toDict

插槽详情 ​

dayOfMonth ​

const Number? dayOfMonth

makeFromSkysparkObj ​

new makeFromSkysparkObj(Str strDate)

makeFromUiObj ​

new makeFromUiObj(Number dayOfMonth, Number month, Number? year)

month ​

常量 数字？ 月

toDict ​

转为字典()

year ​

const Number? 年

CalendarDateObject ​

const class CalendarDateObject : Obj

构造函数

makeFromSkysparkObj

字段

date

方法

createDatesFromSkySparkObj
toDict

插槽详情 ​

createDatesFromSkySparkObj ​

static CalendarDateObject[] 从 SkySpark 对象创建日期(CalendarGridObject calendarGridObject, Str start, Str end, SkysparkCalendarObject calendar)

date ​

const 日期 date

makeFromSkysparkObj ​

新的 makeFromSkysparkObj(Date date)

toDict ​

转为字典()

CalendarEntry ​

抽象常量类 CalendarEntry : Obj

字段

entryType

插槽详情 ​

entryType ​

const Str? entryType

CalendarGridObject ​

const class CalendarGridObject : Obj

构造函数

makeFromFinxObject
makeFromFolio

字段

date
dateRule
dateSpan
type
val
weekdays

方法

toDict

插槽详情 ​

date ​

常量 Str? 日期

dateRule ​

const Str? dateRule

dateSpan ​

const Str? dateSpan

makeFromFinxObject ​

新的 makeFromFinxObject(CalendarEntry 条目, Str 值)

makeFromFolio ​

new makeFromFolio(对象 folio对象)

toDict ​

转为字典()

type ​

常量 CalendarType 类型

val ​

常量 Str? val

weekdays ​

常量 Str? weekdays

CalendarRange ​

const class CalendarRange : CalendarEntry

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

everyYear
lowBound
upBound

方法

toDict

插槽详情 ​

everyYear ​

const Obj? 每年

lowBound ​

const Date? lowBound

makeFromSkysparkObj ​

new makeFromSkysparkObj(Str strDateRange)

makeFromUiObj ​

new makeFromUiObj(Date lowBound, Date upBound, Obj? everyYear)

toDict ​

转为字典()

upBound ​

const Date? 上限

CalendarRule ​

const class CalendarRule : CalendarEntry

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

calendarRule

方法

toDict

插槽详情 ​

calendarRule ​

const Str? calendarRule

makeFromSkysparkObj ​

new makeFromSkysparkObj(Str calendarRule)

makeFromUiObj ​

new makeFromUiObj(Str calendarRule)

toDict ​

转为字典()

CalendarType ​

@Serializable { simple=true } 枚举类 CalendarType : Enum

枚举

DATE
DATE_SPAN
WEEKDAYS
DATE_RULE
UNKNOWN

构造函数

fromStr返回指定名称的 CalendarType 实例。

字段

val
vals按序号索引的 CalendarType 值列表

方法

get

插槽详情 ​

DATE ​

const static CalendarType DATE := ...

日期规则 ​

const static CalendarType DATE_RULE := ...

日期范围 ​

const static CalendarType DATE_SPAN := ...

UNKNOWN ​

const static CalendarType UNKNOWN := ...

WEEKDAYS ​

const static CalendarType WEEKDAYS := ...

fromStr ​

static new fromStr(Str name, Bool checked := true)

返回指定名称的 CalendarType 实例。如果名称无效且 checked 为 false，则返回 null，否则抛出 ParseErr。

get ​

static CalendarType? get(Int val)

val ​

const Int 值

vals ​

const static CalendarType[] vals := ...

按序号索引的 CalendarType 值列表

CalendarWeekNDay ​

const class CalendarWeekNDay : CalendarEntry

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

dayOfWeek
month
weekOfMonth

方法

toDict

插槽详情 ​

dayOfWeek ​

const Number? 星期几

makeFromSkysparkObj ​

new makeFromSkysparkObj(Str day := "", Str month := "", Str weekOfMonth := "")

makeFromUiObj ​

new makeFromUiObj(数字 dayOfWeek)

month ​

常量 数字？ 月

toDict ​

转为字典()

weekOfMonth ​

const Number? 月中的周

DayToSchedule ​

const class DayToSchedule : Obj

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

dailySchedule
dayOfWeek
strToNumWeekday

方法

toDict

插槽详情 ​

dailySchedule ​

const TimeToVal[] 每日计划

dayOfWeek ​

const Number 星期几

makeFromSkysparkObj ​

new makeFromSkysparkObj(Number day, TimeToVal[] dailyScheduleList)

makeFromUiObj ​

new makeFromUiObj(Number day, TimeToVal dailySchedule)

strToNumWeekday ​

const Str:Number strToNumWeekday := ...

toDict ​

转为字典()

FinXCalendarObject ​

const class FinXCalendarObject : Obj

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

calendarRef
dis
entries
id

方法

toDict

插槽详情 ​

calendarRef ​

const Ref? calendarRef

dis ​

const Str dis

entries ​

const CalendarEntry[]? 条目

id ​

常量引用？ id

makeFromSkysparkObj ​

new makeFromSkysparkObj(SkysparkCalendarObject 日历对象)

makeFromUiObj ​

new makeFromUiObj(对象 calendarObj)

toDict ​

转为字典()

FinXScheduleObject ​

const 类 FinXScheduleObject : Obj

构造函数

makeFromSkysparkObj
makeFromUi

字段

curVal
defaultVal
dis
effectivePeriod
enumValues
exceptionSchedule
id
kind
nextTime
nextVal
tz
weeklySchedule

方法

toDict

插槽详情 ​

curVal ​

const Obj? curVal

defaultVal ​

const Obj? defaultVal

dis ​

const Str dis

effectivePeriod ​

const CalendarRange? 有效期

enumValues ​

const Obj? 枚举值

exceptionSchedule ​

const SpecialEvent[]? 例外时间表

id ​

常量引用？ id

kind ​

const Str 种类

makeFromSkysparkObj ​

new makeFromSkysparkObj(SkysparkScheduleObject scheduleObject)

makeFromUi ​

new makeFromUi(Obj scheduleObject)

nextTime ​

const DateTime? 下次时间

nextVal ​

const Obj? nextVal

toDict ​

转为字典()

tz ​

常量 时区 tz

weeklySchedule ​

const DayToSchedule[]? 每周计划

ScheduleAdapter ​

const class ScheduleAdapter : Obj

方法

fromFinxToSkyspark
fromFolioToSkySpark
fromSkySparkToFinx
fromSkysparkToFolio
fromUiToFinx
getSkySparkScheduleEvents

插槽详情 ​

fromFinxToSkyspark ​

static SkysparkScheduleObject 从 Finx 转换为 Skyspark(FinXScheduleObject finxScheduleObject)

fromFolioToSkySpark ​

static SkysparkScheduleObject 从Folio到SkySpark(Obj folioScheduleObject)

fromSkySparkToFinx ​

static FinXScheduleObject 从 SkySpark 到 FinX(Obj skysparkScheduleObject)

fromSkysparkToFolio ​

static Dict fromSkysparkToFolio(SkysparkScheduleObject skysparkSchedule)

fromUiToFinx ​

static FinXScheduleObject 从 Ui 到 Finx(Obj uiScheduleObject)

getSkySparkScheduleEvents ​

static ScheduleEventObject[] 获取SkySpark日程事件(ScheduleGridObject scheduleGridObject, Str start, Str end, SkysparkScheduleObject skysparkSchedule)

ScheduleEventObject ​

const class ScheduleEventObject : Obj

构造函数

makeFromSkysparkObj

字段

color
dis
endDate
startDate
val

方法

createEventsFromSkySparkObj
getDateFromRule
toDict

插槽详情 ​

color ​

const Str? color

createEventsFromSkySparkObj ​

static ScheduleEventObject[] 从 SkySpark 对象创建事件(ScheduleGridObject scheduleGridObject, Str start, Str end, SkysparkScheduleObject schedule)

dis ​

const Str dis

endDate ​

const DateTime 结束日期

getDateFromRule ​

static Date? 从规则获取日期(Str rule, Int year)

makeFromSkysparkObj ​

new makeFromSkysparkObj(DateTime start, DateTime end, Obj? val, Str dis, Str? color := null)

startDate ​

const DateTime startDate

toDict ​

转为字典()

val ​

const Obj? val

ScheduleGridObject ​

const class ScheduleGridObject : Obj

构造函数

makeFromDefaultFinXObj
makeFromEventFinXObj
makeFromFolio
makeFromWeekFinXObj

字段

calendar
color
date
dateRule
dateSpan
defaultEvent
dis
end
priority
start
type
val
weekdays
weekly

方法

toDict

插槽详情 ​

calendar ​

常量 Str? 日历

color ​

const Str? color

date ​

常量 Str? 日期

dateRule ​

const Str? dateRule

dateSpan ​

const Str? dateSpan

defaultEvent ​

const Marker? defaultEvent

dis ​

const Str? dis

end ​

const 时间 结束

makeFromDefaultFinXObj ​

new makeFromDefaultFinXObj(Obj defaultVal)

makeFromEventFinXObj ​

new makeFromEventFinXObj(特殊事件 specialEvent)

makeFromFolio ​

new makeFromFolio(对象 folio对象)

makeFromWeekFinXObj ​

new makeFromWeekFinXObj(Number dayOfWeek, TimeToVal dailySchedule)

priority ​

常量 Number? priority

start ​

const 时间 start

toDict ​

转为字典()

type ​

const ScheduleType 类型

val ​

const Obj? val

weekdays ​

const Str[]? 星期几

weekly ​

常量 Marker？每周

ScheduleType ​

@Serializable { simple=true } 枚举类 ScheduleType : Enum

枚举

WEEKLY
DATE_RULE
DATE_SPAN
WEEKDAYS
DATE
CALENDAR
UNKNOWN

构造函数

fromStr返回指定名称的 ScheduleType 实例。

字段

val
vals按序号索引的 ScheduleType 值列表

方法

get

插槽详情 ​

CALENDAR ​

const static ScheduleType CALENDAR := ...

DATE ​

const static ScheduleType DATE := ...

日期规则 ​

const static ScheduleType DATE_RULE := ...

日期范围 ​

const static ScheduleType DATE_SPAN := ...

UNKNOWN ​

const static ScheduleType UNKNOWN := ...

WEEKDAYS ​

const static ScheduleType WEEKDAYS := ...

WEEKLY ​

const static ScheduleType WEEKLY := ...

fromStr ​

static new fromStr(Str name, Bool checked := true)

返回指定名称的 ScheduleType 实例。如果名称无效且 checked 为 false，则返回 null，否则抛出 ParseErr。

get ​

static ScheduleType? get(Int val)

val ​

const Int 值

vals ​

const static ScheduleType[] vals := ...

按序号索引的 ScheduleType 值列表

ScheduleUtils ​

const class ScheduleUtils : Obj

字段

dayToNum
numToDay

方法

NumToStr
strToNumWeekday

插槽详情 ​

NumToStr ​

static Str NumToStr(Number dayNum)

dayToNum ​

const static Str:Number dayToNum := ...

numToDay ​

const static Number:Str numToDay := ...

strToNumWeekday ​

静态数字 strToNumWeekday(字符串 day)

SchedulerMod ​

const class SchedulerMod : SysMod

字段

api

插槽详情 ​

api ​

const static Str api := "finScheduler"

SchedulerQueryHelper ​

const class SchedulerQueryHelper : Obj

方法

adaptQuery
create
delete
update

插槽详情 ​

adaptQuery ​

static Str 调整查询(Str 查询)

create ​

static Dict? create(Proj proj, Dict record)

delete ​

static Dict? 删除(Proj proj, Dict record)

update ​

static Dict? update(Proj proj, Dict record, Dict updates)

SkysparkCalendarObject ​

const class SkysparkCalendarObject : Obj

构造函数

makeFromFinxObject
makeFromFolio

字段

calendarGridList
calendarRef
dis
id

方法

getCreationDict

插槽详情 ​

calendarGridList ​

const CalendarGridObject[]? calendarGridList

calendarRef ​

const Ref? calendarRef

dis ​

const Str dis

getCreationDict ​

Dict 获取创建字典()

id ​

常量引用？ id

makeFromFinxObject ​

new makeFromFinxObject(FinXCalendarObject finxCalendarObject)

makeFromFolio ​

new makeFromFolio(对象 folio对象)

SkysparkScheduleObject ​

const class SkysparkScheduleObject : Obj

构造函数

makeFromFinxObject
makeFromFolio

字段

calendarRef
curErr
curStatus
curVal
dis
effectivePeriod
enumValues
id
kind
nextTime
nextVal
scheduleGridList
tz

方法

getCreationDict
toDict

插槽详情 ​

calendarRef ​

const Ref? calendarRef

curErr ​

const Str? curErr

curStatus ​

const Str? 当前状态

curVal ​

const Obj? curVal

dis ​

const Str dis

effectivePeriod ​

const Str? 有效期

enumValues ​

const Obj? 枚举值

getCreationDict ​

Dict 获取创建字典()

id ​

常量引用？ id

kind ​

const Str 种类

makeFromFinxObject ​

new makeFromFinxObject(FinXScheduleObject finxScheduleObject)

makeFromFolio ​

new makeFromFolio(对象 folio对象)

nextTime ​

const DateTime? 下次时间

nextVal ​

const Obj? nextVal

scheduleGridList ​

const ScheduleGridObject[] scheduleGridList

toDict ​

转为字典()

tz ​

常量 时区 tz

SpecialEvent ​

const class SpecialEvent : Obj

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

calendarEntry
calendarRef
dailySchedule
priority

方法

toDict

插槽详情 ​

calendarEntry ​

const CalendarEntry? 日历条目

calendarRef ​

const Ref? calendarRef

dailySchedule ​

const TimeToVal dailySchedule

makeFromSkysparkObj ​

new makeFromSkysparkObj(时间 start, 时间 end, 对象? val, 字符串 dis, 数字? priority, 日历条目? entry := null, 字符串? color := null, 引用? calRef := null)

makeFromUiObj ​

new makeFromUiObj(TimeToVal dailySchedule, Obj priority, CalendarEntry? entry := null, Ref? calendarRef := null)

priority ​

const Int 优先级

toDict ​

转为字典()

TimeToVal ​

const class TimeToVal : Obj

构造函数

makeFromSkysparkObj
makeFromUiObj

字段

color
dis
endTime
scheduledVal
startTime

方法

toDict

插槽详情 ​

color ​

const Str? color

dis ​

const Str dis

endTime ​

const BacnetTime 结束时间

makeFromSkysparkObj ​

new makeFromSkysparkObj(Time start, Time end, Obj? val, Str dis, Str? color := null)

makeFromUiObj ​

new makeFromUiObj(BacnetTime start, BacnetTime end, Obj? val, Str dis, Str? color := null)

scheduledVal ​

const Obj? scheduledVal

startTime ​

const BacnetTime startTime

toDict ​

转为字典()