net.opro.product.odcaw.api
インタフェース CooperateServer

すべてのスーパーインタフェース:

net.opro.product.odcaw.api.Parameter

既知の実装クラスの一覧:

CooperateServerImpl

public interface CooperateServer

extends net.opro.product.odcaw.api.Parameter

CooperateParameter で使用するための、 連携サーバ・サービスに関するパラメータを定義する機構を提供するインターフェースです。
連携サーバ・サービスには以下のものがあります。

• OXS Print Edition
• OXS Print Service
• OXS Fax Edition
• OXS Fax Service
• OXS Mail Service

導入されたバージョン:

2.2.1.0

関連項目:

CooperateParameter

メソッドの概要

CooperateDevice	addDevice() 連携サーバ・サービスで使用するデバイスに関するパラメータを定義する CooperateDevice を追加します。
CooperateDevice	addDevice(String Name) 連携サーバ・サービスで使用するデバイスに関するパラメータを定義する CooperateDevice を追加し、指定した名前を設定します。
void	clearDevice() 全ての CooperateDevice を削除します。
CooperateDevice	deviceAt(int Index) 指定した CooperateDevice を返します。
CooperateDevice	deviceAt(String Name) 指定した名前の CooperateDevice を返します。
int	deviceIndexOf(CooperateDevice device) 指定した CooperateDevice のインデックスを返します。
String	getName() setName で指定した連携サーバ・サービス名を返します。
void	removeDevice(CooperateDevice device) 指定した CooperateDevice を削除します。
void	removeDevice(int Index) 指定した CooperateDevice を削除します。
void	removeDevice(String Name) 指定した名前の CooperateDevice を削除します。
void	setName(String Value) 連携サーバ・サービス名を指定します。
int	sizeDevice() CooperateDevice の数を返します。

メソッドの詳細

setName

public void setName(String Value)

連携サーバ・サービス名を指定します。

HTTP によるリクエストの、TSパラメータに相当します。

定義:

インタフェース net.opro.product.odcaw.api.Parameter 内の setName

パラメータ:

Value - 指定する連携サーバ・サービス名

getName

public String getName()

setName で指定した連携サーバ・サービス名を返します。

HTTP によるリクエストの、TSパラメータに相当します。

定義:

インタフェース net.opro.product.odcaw.api.Parameter 内の getName

戻り値:

setName で指定した連携サーバ・サービス名

addDevice

public CooperateDevice addDevice()

連携サーバ・サービスで使用するデバイスに関するパラメータを定義する CooperateDevice を追加します。

現在の OXS では、制限により、複数のデバイスを使用することができません。
複数のデバイスを指定した場合は、予期しない結果となる場合があります。

戻り値:

追加された CooperateDevice

関連項目:

CooperateDevice

addDevice

public CooperateDevice addDevice(String Name)

連携サーバ・サービスで使用するデバイスに関するパラメータを定義する CooperateDevice を追加し、指定した名前を設定します。

現在の OXS では、制限により、複数のデバイスを使用することができません。
複数のデバイスを指定した場合は、予期しない結果となる場合があります。

パラメータ:

Name - 追加された CooperateDevice に設定するデバイス名

戻り値:

追加された CooperateDevice

関連項目:

CooperateDevice

sizeDevice

public int sizeDevice()

CooperateDevice の数を返します。

戻り値:

CooperateDevice の数

removeDevice

public void removeDevice(int Index)

指定した CooperateDevice を削除します。

パラメータ:

Index - 削除する CooperateDevice のインデックス

例外:

ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeDevice よりも大きい場合

removeDevice

public void removeDevice(String Name)

指定した名前の CooperateDevice を削除します。
CooperateDevice が見つからない場合は、何もしません。

パラメータ:

Name - 削除する CooperateDevice の名前

removeDevice

public void removeDevice(CooperateDevice device)

指定した CooperateDevice を削除します。

パラメータ:

device - 削除する CooperateDevice

clearDevice

public void clearDevice()

全ての CooperateDevice を削除します。

deviceAt

public CooperateDevice deviceAt(int Index)

指定した CooperateDevice を返します。

パラメータ:

Index - 返される CooperateDevice のインデックス

戻り値:

指定した CooperateDevice

例外:

ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeDevice よりも大きい場合

deviceAt

public CooperateDevice deviceAt(String Name)

指定した名前の CooperateDevice を返します。

パラメータ:

Name - 検索する CooperateDevice の名前

戻り値:

指定した名前の CooperateDevice。見つからない場合は null。

deviceIndexOf

public int deviceIndexOf(CooperateDevice device)

指定した CooperateDevice のインデックスを返します。

パラメータ:

device - 検索対象の CooperateDevice

戻り値:

指定した CooperateDevice のインデックス。見つからない場合は -1。