OZ Scheduler API > Class

Scheduler

Constructor Detail

Scheduler

public scheduler(String ip, int port)

Parameters

ip：OZ Scheduler ServerがインストールされているホストPCのIPアドレス

port：OZ Scheduler Serverのポート番号（既定値：9521）

Method Detail

createTask

public void createTask(ServerInfo s, SortProperties configMap, SortProperties exportMap) throws SchedulerException

フォームファイルを基準にスケジューリングタスクを生成してタスクＩＤを取得します。

CreateTaskメソッドで複数のタスク生成時、Viewerのキューに関わらずに実行されるViewerの個数までThreadとparamファイルが生成されます。

Parameters:

s : OZ Server情報

configMap : タスクの生成時に使用される設定オプション。（参照 : NameValueCollection）

exportMap : Schedulerでエクスポートされるファイルの設定オプション。（参照 : NameValueCollection）

getTask

public Vector getTask(ServerInfo s) throws SchedulerException

現在の生成されたスケジューリングタスクの結果物を取得します。

Parameters:

s : OZ Server情報

GetTaskResult

public TaskResult[] GetTaskResult(ServerInfo s, string from, string to, string taskId, int rollingIndex) throws SchedulerException

ローリングされたファイルを検索して、タスクの実行結果を取得します。

Parameters:

s：OZ Serverの情報

from：タスク結果を取得開始時刻

to：タスク結果を取得終了時刻

taskId：取得するタスクID

rollingIndex：ファイルインデックス

getTaskResults

public TaskResult[] getTaskResults(ServerInfo s, String from, String to, String taskId)

タスク結果を取得します。

Parameters:

s : OZ Server情報

from : タスク結果の取得開始時間

to : タスク結果の取得終了時間

taskId : 取得するタスクＩＤ

getTaskProperties

public SortProperties[] getTaskProperties(ServerInfo s, String taskId) throws SchedulerException

タスクの属性、Schedulerでタスクの生成時に使用される設定オプション(configMap)とす。

Schedulerでエクスポートされるファイルの設定オプション(exportMap)を取得します。

Parameters:

s : OZ Server情報

taskId : 属性を取得するタスクＩＤ

getTaskWaitTime

public int getTaskWaitTime(ServerInfo s, String taskId) throws SchedulerException

タスクが待機した時間を取得します。（単位：秒）

Parameters:

s : OZ Server情報

taskId : 取得するタスクＩＤ

getTaskWaitCount

public int getTaskWaitCount() throws SchedulerException

実行待機中のタスクの数を取得します。

removeTask

public void removeTask(ServerInfo s, String taskId) throws SchedulerException

スケジューリングタスクを削除します。

Parameters:

s : OZ Server情報

taskId : 削除するタスクＩＤ

modifyTask

public String modifyTask(ServerInfo s, String taskId, SortProperties configMap, SortProperties exportMap) throws SchedulerException

タスク属性を変更します。

Parameters:

s : OZ Server情報

taskId : 属性を変更するタスクＩＤ

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

taskPause

public boolean taskPause(ServerInfo s, String taskId) throws SchedulerException

スケジューリングタスクを中止します。

Parameters:

s : OZ Server情報

taskId : 中止するTaskＩＤ

taskResume

public boolean taskResume(ServerInfo s, String taskId) throws SchedulerException

中止されたスケジューリングタスクを再実行します。

Parameters:

s : OZ Server情報

taskId : 再実行するTaskＩＤ

stop

public void stop(ServerInfo s, boolean waitTaskId) throws SchedulerException

Schedulerを中止します。

Parameters:

s : OZ Server情報

waitTaskId : Schedulerを強制に中止するか否かの設定

export

public boolean export(ServerInfo s, SortProperties configMap, SortProperties exportMap) throws SchedulerException

Viewerパラメーターをそのまま使用してエクスポートしてエクスポートの結果を返します。

サーバーに設定されたSchedulerの環境設定中"ViewerType=None"ではない場合にのみ使用できます。

exportメソッドをAPIメソッドではなく、COMにマッピングしてASPで使用する方法は本マニュアルの"Appendix 1.Scheduler COM活用"部分を参照してください。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

makePDF

public boolean makePDF(ServerInfo s, SortProperties configMap, SortProperties exportMap) throws SchedulerException

Schedulerの作業リストに登録せずにPDFのエクスポートのみ実行してエクスポートの結果を返します。

サーバーに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合にのみ使用できます。

makePDFメソッドをAPIメソッドではなく、COMにマッピングしてASPで使用する方法は本マニュアルの"Appendix 1.SchedulerCOM活用"部分を参照してください。

Parameters:

s : OZ Server情報

configMap : エクスポートのためのフォーム情報。（参照 : NameValueCollection）

exportMap : PDFのエクスポート情報。（参照 : NameValueCollection）

public boolean print(ServerInfo s, SortProperties configMap, SortProperties printMap) throws SchedulerException

Viewerパラメーターを適用させてプリントし、成否結果を返します。(実際のプリント作業の成否はなくViewerへのプリントの呼び出し結果を返します)

"task_type=viewerTag"の場合にのみ使用でき、それ以外の値が入ると無視します。また、サーバーに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合にのみ使用できます。

print APIの呼び出し時タスク作業週期オプションに関わらずに即時1回のみプリント作業を呼び出し、タスクは生成せずにprint APIの呼び出し時メールの転送などのパラメーターを設定してもメール関連作業は実行されないままプリントのみ行います。

printメソッドをAPIで実装する場合、Viewerパラメーターで設定したパラメーター中次のパラメーターは常に該当値で固定されて動作します。

•viewer.allowmultiframe=true

•viewer.mode=print

•viewer.printcommand=true

•viewer.showerrormessage=false

•viewer.useprogressbar=false

•print.ingnoreerror=false

•print.mode=silent

•export.confirmsave=false

•export.format=""

•information.debug=debug

Parameters:

S : OZ Server情報

configMap : Scheduler設定情報。（参照 : NameValueCollection）

exportMap : 出力情報。（参照 : NameValueCollection）

getCurrentStatus

public String getCurrentStatus() throws SchedulerException

スケジューラの使用メモリー・総メモリー・実行中のビューア数・待機中のビューア数を取得します。

getConfiguration

public SortProperties getConfiguration(ServerInfo s) throws SchedulerException

Scheduler設定値を取得します。

Parameters:

s : OZ Server情報

modifyConfiguration

public void modifyConfiguration(ServerInfo s, SortProperties configMap) throws SchedulerException

Schedulerの設定値を変更します。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

setReceiveTimeout

public void setReceiveTimeout(int timeout)

ソケットタイムアウトを設定します。（単位：秒）

Parameters:

timeout : ソケットタイムアウト

ping

public boolean ping()

サーバーか起動中であるか否かを確認します。

getOZSList

public String[] getOZSList(String path)

設定したパスにあるOZSファイルリストを取得します。(pathをファイル名で指定すると該当OZSファイルの情報にみ取得し、pathをフォルダ名で指定すると該当フォルダにある全てのOZSファイル情報を取得します。指定パスにファイルが存在しないか、存在しないフォルダを指定すると空白文字列を返します。)

Parameters:

Path : OZSファイルリストを取得するパス。OZSファイルリストを取得するパスは/%SCH_HOME%/[path]/で指定されます。例えば、pathをsampleと設定する場合には/%SCH_HOME%/sample/にあるOZSファイルのリストを取得します。

ozsVerConv

public void ozsVerConv(String oldPath, String newPath)

Ver.2.5のOZSファイルを最新バージョンに変換して保存します。

Parameters:

oldPath : 変換するOZSファイル名またはパス。指定パスは/%SCH_HOME%/[oldPath]/です。

newPath : 変換されたOZSファイルの保存パス。指定パスは/%SCH_HOME%/[newPath]/でnewPathはoldPathと異なる設定をする必要があります。

addTaskHolidayInfo

public boolean addTaskHolidayInfo(TaskHolidayInfo value)

タスク休日情報を追加します。

Parameters

value : タスク休日情報

modifyTaskHolidayInfo

public boolean modifyTaskHolidayInfo(String old_key, TaskHolidayInfo new_value)

タスク休日情報を修正します。

Parameters:

old_key : 修正するタスク休日名

new_value : 新しいタスク休日情報

deleteTaskHolidayInfo

public boolean deleteTaskHolidayInfo(String[] keys)

タスク休日情報を削除します。

Parameters:

keys : 削除するタスク休日名の配列

addTaskHolidayGroupInfo

public boolean addTaskHolidayGroupInfo(TaskHolidayGroupInfo value)

タスク休日グループ情報を追加します。

Parameters:

value : タスク休日グループ情報

modifyTaskHolidayGroupInfo

public boolean modifyTaskHolidayGroupInfo(String old_key, TaskHolidayGroupInfo new_value)

タスク休日グループ情報を修正します。

Parameters:

old_key : 修正するタスク休日グループ名

new_value : 新しいタスク休日グループ情報

deleteTaskHolidayGroup

public boolean deleteTaskHolidayGroupInfo(String key)

タスク休日グループ情報を削除します。

Parameters:

key : 削除するタスク休日グループ名

getTaskHolidayInfoList

public OZMap getTaskHolidayInfoList()

タスク休日情報リストを取得します。

getTaskHolidayGroupInfoList

public OZMap getTaskHolidayGroupInfoList()

タスク休日グループ情報リストを取得します。

saveTaskHoliday

public void saveTaskHoliday()

タスク休日情報をxmlファイルに保存します。

directExport

public DirectExportResult directExport(ServerInfo s, SortProperties configMap, SortProperties exportMap) throws SchedulerException

Viewerパラエーターを適用してエクスポートして結果情報を返します。

サーバーに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合にのみ使用できます。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

directExportFiles

public Hashtable[] directExportFiles(ServerInfo s, SortProperties configMap, SortProperties exportMap, String localTempPath) throws SchedulerException

Viewerパラメーターを適用してエクスポートした結果をローカルの一時保存パスに保存し、ファイル情報を返します。

サーバーに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合にのみ使用できます。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

localTempPath : エクスポートした結果を保存するローカルの一時保存パス

directExportResult

public DirectExportResult directExportResult (ServerInfo s, SortProperties configMap, SortProperties exportMap)

Viewerパラメーターを適用して印刷した結果情報を返します。

サーバーに設定されたSchedulerの環境設定の中task_typeがviewerTagで、ViewerTypeがActiveX或いはAppletの場合にのみ使用できます。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

directExportByteArray

public HashTable directExportByteArray(ServerInfo s, SortProperties configMap, SortProperties exportMap) throws SchedulerException

タスクを実行した後、実行結果の情報を返します。

タスクの実行結果をファイルに保存せずに、メモリにエクスポートするには、ude.classnameを設定した後、ViewerType=Applet、export_file= falseに設定してください。

サーバーに設定されたスケジューラの環境設定の"ViewerType=None"ではない場合のみ使用することができます。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

exportMap : エクスポート情報。（参照 : NameValueCollection）

directPrint

public DirectPrintResult directPrint(ServerInfo s, SortProperties configMap, SortProperties printMap) throws SchedulerException

Viewerパラメーターを適用して印刷した結果情報を返します。

Parameters:

s : OZ Server情報

configMap : Scheduler設定オプション。（参照 : NameValueCollection）

printMap : 出力情報。（参照 : NameValueCollection）