Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleScheduleFrequency

すべての頻度型のベースclassです。こちらのclassは、頻度スケジュールのデータベース属性を保持します。各フィールドのデータベース値に基づく有効なデータを設定し、取得するユーザーフレンドリーなメソッドを提供するのが各subclassの責任です。

例:月の曜日は頻度単位に保存されることもありますが、スケジュールタイプが月の曜日をまったく持たない場合は保存されません。subclassはまた、検証を強制します。

 

パラメーターデータ型説明

FrequencyTypeCode

Stringこちらのオブジェクトの頻度タイプです。オブジェクトタイプの決定に使用されます。
FrequencyCodeString頻度タイプコードに応じて、異なる意味合いを持ちます。
FrequencyUnitInteger頻度タイプコードに応じて、異なる意味合いを持ちます。
LocalRunTimeIntegerこちらのスケジュールを実行する真夜中からの秒数を返します(こちらのスケジュールのタイムゾーンに関連します)。注意:MinutesFrequencyなど、いくつかのスケジュールタイプは、こちらを適切に使用しません。
LocalTimezoneCodeString指定されたローカルの実行時間を、Yellowfinのサーバ時間に変換するために使用するフルタイムゾーンコード(例:AUSTRALIA / SYDNEYなど)です。
DayOrdinalsString序数に対応する曜日名の順序付き一覧です。

 

以下は、ScheduleFrequency classのいくつかのsub classの例です。

ScheduleFrequency Sub Class説明フィールド
AnnualFrequency

特定の月の特定の日に設定された時間です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する月の英語名を大文字で表記しなくてはいけません。
  • FrequencyUnit:こちらのスケジュールを実行する月の曜日を指定します。
BiannualFrequency一年の中で等間隔に配置された二ヶ月の特定の日に設定された時間です。X月と(6 + X)月で、Xは「MonthOfYear」属性です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する最初の月の数字名を英語の大文字で表記しなくてはいけません。例えば、スケジュールが一月と七月に実行される場合、値は「ONE」(年の最初の月、そしてこれに6ヶ月を追加します)です。最大値はSIXです。
  • FrequencyUnit:スケジュールを実行する月の曜日を指定します。
DailyFrequency毎日設定された時間です。こちらのclassに追加フィールドはなく、localRun Timeのみが必要です。 
EndOfMonthFrequency毎月最終日に設定された時間です。こちらのclassに追加フィールドはなく、localRun Timeのみが必要です。 
FortnightlyFrequency二週間に一度、特定の曜日に設定された時間です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する曜日の英語名を大文字で表記しなくてはいけません。(例:MONDAY)
  • FrequencyUnit:上記のFrequencyCodeで使用されている曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。
    例:MONDAY=1、SUNDAY=0、など
MinutesFrequency毎X分です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyUnit:スケジュールの実行間隔です。
MonthlyFrequency各月の特定の曜日に設定された時間です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyUnit:こちらのスケジュールを実行する月の曜日です。
QuarterlyFrequency各四半期の第一、第二、または第三月の特定の曜日に設定された時間です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する各四半期の月の数字を英語の大文字で表記しなくてはいけません。例えば、スケジュールを四半期の最初の月に実行する場合、値は「ONE」になり、スケジュールは一月、四月、七月、十月に実行されます。値の最大値はTHREEです。
  • FrequencyUnit:こちらのスケジュールを実行する月の曜日を指定します。
WeekdaysFrequency すべての平日に設定された時間です。こちらのclassに追加フィールドはなく、localRunTimeのみが必要です。 
WeeklyFrequency 特定の曜日に設定された時間です。

こちらのclassは、以下のフィールドを含みます。

  • FrequencyCode:こちらの頻度コードは、こちらのスケジュールを実行する週の曜日を英語名の大文字で表記しなくてはいけません。例:MONDAY
  • FrequencyUnit:上記のfrequencyCodeで使用する曜日の序数を指定します。序数は、提供されるdayOrdinals定数と一致しなくてはいけないことに注意をしてください。
    例:MONDAY=1、SUNDAY=0、など

 

 

 

clientOrgId

Integer

clientOrgRef

String

sourceId

Integer