OPRO X Server API

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

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

public interface CooperateParameter

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

導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter

メソッドの概要
 CooperateServer addServer()
          連携サーバ・サービスに関するパラメータを定義する CooperateServer を追加します。
 CooperateServer addServer(String Name)
          連携サーバ・サービスに関するパラメータを定義する CooperateServer を追加し、指定した名前を設定します。
 void clearServer()
          全ての CooperateServer を削除します。
 String getConfirmation()
          setConfirmation で設定した確認メールの宛先メールアドレスを返します。
 String getPassword()
          連携サーバ・サービスへのログインパスワードを返します。
 String getUserName()
          連携サーバ・サービスへのログインユーザ名を返します。
 void removeServer(CooperateServer server)
          指定した CooperateServer を削除します。
 void removeServer(int Index)
          指定した CooperateServer を削除します。
 void removeServer(String Name)
          指定した名前の CooperateServer を削除します。
 CooperateServer serverAt(int Index)
          指定した CooperateServer を返します。
 CooperateServer serverAt(String Name)
          指定した名前の CooperateServer を返します。
 int serverIndexOf(CooperateServer server)
          指定した CooperateServer のインデックスを返します。
 void setConfirmation(String Value)
          処理完了後に送信される確認メールの宛先メールアドレスを指定します。
 int sizeServer()
          CooperateServer の数を返します。
 

メソッドの詳細

getUserName

public String getUserName()
連携サーバ・サービスへのログインユーザ名を返します。

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

戻り値:
連携サーバ・サービスへのログイン名

getPassword

public String getPassword()
連携サーバ・サービスへのログインパスワードを返します。

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

戻り値:
連携サーバ・サービスへのログインパスワード

setConfirmation

public void setConfirmation(String Value)
処理完了後に送信される確認メールの宛先メールアドレスを指定します。
指定されない場合は、OXS の設定ファイルの定義に従います。

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

パラメータ:
Value - 設定する確認メールの宛先メールアドレス

getConfirmation

public String getConfirmation()
setConfirmation で設定した確認メールの宛先メールアドレスを返します。

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

戻り値:
setConfirmation で設定した確認メールの宛先メールアドレス

addServer

public CooperateServer addServer()
連携サーバ・サービスに関するパラメータを定義する CooperateServer を追加します。

戻り値:
追加された CooperateServer
関連項目:
CooperateServer

addServer

public CooperateServer addServer(String Name)
連携サーバ・サービスに関するパラメータを定義する CooperateServer を追加し、指定した名前を設定します。

パラメータ:
Name - 追加された CooperateServer に設定する連携サーバ・サービス名
戻り値:
追加された CooperateServer
関連項目:
CooperateServer

sizeServer

public int sizeServer()
CooperateServer の数を返します。

戻り値:
CooperateServer の数

removeServer

public void removeServer(int Index)
指定した CooperateServer を削除します。

パラメータ:
Index - 削除する CooperateServer のインデックス
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeServer よりも大きい場合

removeServer

public void removeServer(String Name)
指定した名前の CooperateServer を削除します。
CooperateServer が見つからない場合は、何もしません。

パラメータ:
Name - 削除する CooperateServer の名前

removeServer

public void removeServer(CooperateServer server)
指定した CooperateServer を削除します。

パラメータ:
server - 削除する CooperateServer

clearServer

public void clearServer()
全ての CooperateServer を削除します。


serverAt

public CooperateServer serverAt(int Index)
指定した CooperateServer を返します。

パラメータ:
Index - 返される CooperateServer のインデックス
戻り値:
指定した CooperateServer
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の sizeServer よりも大きい場合

serverAt

public CooperateServer serverAt(String Name)
指定した名前の CooperateServer を返します。

パラメータ:
Name - 検索する CooperateServer の名前
戻り値:
指定した名前の CooperateServer。見つからない場合は null。

serverIndexOf

public int serverIndexOf(CooperateServer server)
指定した CooperateServer のインデックスを返します。

パラメータ:
server - 検索対象の CooperateServer
戻り値:
指定した CooperateServer のインデックス。見つからない場合は -1。

OPRO Japan Co.,Ltd.