OPRO X Server API

net.opro.product.odcaw.api
クラス CooperateParameterImpl

Object
  拡張net.opro.product.odcaw.api.CooperateParameterImpl
すべての実装インタフェース:
CooperateParameter
直系の既知のサブクラス:
FaxParameter, MailParameter, PrintParameter

public abstract class CooperateParameterImpl
extends Object
implements CooperateParameter

OXSParameter で使用するための、 連携サーバ・サービスを利用するためのパラメータを定義する全てのクラスに共通のスーパークラスです。

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

コンストラクタの概要
CooperateParameterImpl(String UserName, String Password)
          Constructs a CooperateParameterImpl which has no CooperateServer.
 
メソッドの概要
 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 の数を返します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CooperateParameterImpl

public CooperateParameterImpl(String UserName,
                              String Password)
Constructs a CooperateParameterImpl which has no CooperateServer.

パラメータ:
UserName - the user name to login to cooperated server|service
Password - the password to login to cooperated server|service
メソッドの詳細

getUserName

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

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

定義:
インタフェース CooperateParameter 内の getUserName
戻り値:
連携サーバ・サービスへのログイン名

getPassword

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

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

定義:
インタフェース CooperateParameter 内の getPassword
戻り値:
連携サーバ・サービスへのログインパスワード

setConfirmation

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

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

定義:
インタフェース CooperateParameter 内の setConfirmation
パラメータ:
Value - 設定する確認メールの宛先メールアドレス

getConfirmation

public String getConfirmation()
インタフェース CooperateParameter の記述:
setConfirmation で設定した確認メールの宛先メールアドレスを返します。

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

定義:
インタフェース CooperateParameter 内の getConfirmation
戻り値:
setConfirmation で設定した確認メールの宛先メールアドレス

addServer

public CooperateServer addServer()
インタフェース CooperateParameter の記述:
連携サーバ・サービスに関するパラメータを定義する CooperateServer を追加します。

定義:
インタフェース CooperateParameter 内の addServer
戻り値:
追加された CooperateServer
関連項目:
CooperateServer

addServer

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

定義:
インタフェース CooperateParameter 内の addServer
パラメータ:
Name - 追加された CooperateServer に設定する連携サーバ・サービス名
戻り値:
追加された CooperateServer
関連項目:
CooperateServer

sizeServer

public int sizeServer()
インタフェース CooperateParameter の記述:
CooperateServer の数を返します。

定義:
インタフェース CooperateParameter 内の sizeServer
戻り値:
CooperateServer の数

removeServer

public void removeServer(int Index)
インタフェース CooperateParameter の記述:
指定した CooperateServer を削除します。

定義:
インタフェース CooperateParameter 内の removeServer
パラメータ:
Index - 削除する CooperateServer のインデックス

removeServer

public void removeServer(String Name)
インタフェース CooperateParameter の記述:
指定した名前の CooperateServer を削除します。
CooperateServer が見つからない場合は、何もしません。

定義:
インタフェース CooperateParameter 内の removeServer
パラメータ:
Name - 削除する CooperateServer の名前

removeServer

public void removeServer(CooperateServer server)
インタフェース CooperateParameter の記述:
指定した CooperateServer を削除します。

定義:
インタフェース CooperateParameter 内の removeServer
パラメータ:
server - 削除する CooperateServer

clearServer

public void clearServer()
インタフェース CooperateParameter の記述:
全ての CooperateServer を削除します。

定義:
インタフェース CooperateParameter 内の clearServer

serverAt

public CooperateServer serverAt(int Index)
インタフェース CooperateParameter の記述:
指定した CooperateServer を返します。

定義:
インタフェース CooperateParameter 内の serverAt
パラメータ:
Index - 返される CooperateServer のインデックス
戻り値:
指定した CooperateServer

serverAt

public CooperateServer serverAt(String Name)
インタフェース CooperateParameter の記述:
指定した名前の CooperateServer を返します。

定義:
インタフェース CooperateParameter 内の serverAt
パラメータ:
Name - 検索する CooperateServer の名前
戻り値:
指定した名前の CooperateServer。見つからない場合は null。

serverIndexOf

public int serverIndexOf(CooperateServer server)
インタフェース CooperateParameter の記述:
指定した CooperateServer のインデックスを返します。

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

OPRO Japan Co.,Ltd.