3.3.1 帳票管理アプリケーションの作成手順と記述例

帳票管理Javaインタフェースを利用したアプリケーションの作成手順と記述例について、以下の場合に分けて説明します。

論理あて先を取得/操作する場合
帳票を取得/操作する場合
ユーザを取得する場合
ユーザグループを取得する場合

●論理あて先を取得/操作する場合

＜作成手順＞

List Managerのユーザ認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
1.で取得したLMUserクラスのインスタンスオブジェクトを引数に渡し、LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
LogicalDestinationクラスを取得します。
LogicalDestinationManagerクラスのgetLogicalDestinationsメソッドを呼び出して、LogicalDestinationクラスのインスタンスオブジェクトの配列を取得します。
ポイント
- 検索条件を指定して検索を行う場合は、LogicalDestinationFilterConditionクラスのインスタンスオブジェクトを生成し、検索条件を設定したものをgetLogicalDestinationsメソッドの引数に渡します。
- 取得した論理あて先のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものをgetLogicalDestinationsメソッドの引数に渡します。
取得したLogicalDestinationクラスのインスタンスオブジェクトから論理あて先の情報を取得するには、LogicalDestinationクラスの情報取得メソッド（getまたはisで始まるメソッド）で取得できます。
論理あて先を操作します。
操作を行う論理あて先のLogicalDestinationクラスのメソッドを呼び出します。

＜記述例＞

論理あて先名が「ld1」の論理あて先を取得して、起動します。

import com.fujitsu.listmanager.operate.LMUser;
import com.fujitsu.listmanager.operate.LogicalDestination;
import com.fujitsu.listmanager.operate.LogicalDestinationFilterCondition;
import com.fujitsu.listmanager.operate.LogicalDestinationManager;
import com.fujitsu.listmanager.operate.UserAuthorization;
        :
        :

// List Managerのユーザ認証を行います
//ユーザIDが「user1」、パスワードが「psw1」のユーザを取得します
LMUser  user = UserAuthorization.authorize( "user1", "psw1" );

// LogicalDestinationManager クラスのインスタンスオブジェクトを生成します
LogicalDestinationManager logicalDestinationManager = new LogicalDestinationManager(user);

//論理あて先が「ld1」の論理あて先クラスを取得します
LogicalDestinationFilterCondition filter = new LogicalDestinationFilterCondition();
filter.setName( "ld1" );
LogicalDestination[] logicalDestinations = logicalDestinationManager.getLogicalDestinations
(filter,null);
LogicalDestination ld1 = logicalDestinations[0];

// LogicalDestinationクラスの情報を取得します
String name    = ld1.getName();        // 論理あて先名
String comment = ld1.getComment();     // コメント
int type       = ld1.getType();        // 論理あて先タイプ
String device  = ld1.getDeviceName();  // 論理デバイス名
boolean active = ld1.isActive();       // 論理あて先の状態
        :
        :
//論理あて先を起動します
ld1.start();
        :
        :

●帳票を取得/操作する場合

＜作成手順＞

List Managerのユーザ認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
1.で取得したLMUserクラスのインスタンスオブジェクトを引数に渡し、LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
LogicalDestinationクラスを取得します。
LogicalDestinationManagerクラスのgetLogicalDestinationsメソッドを呼び出して、
LogicalDestinationクラスのインスタンスオブジェクトの配列を取得します。
ポイント
- 検索条件を指定して検索を行う場合は、LogicalDestinationFilterConditionクラスのインスタンスオブジェクトを生成し、検索条件を設定したものをgetLogicalDestinationsメソッドの引数に渡します。
- 取得した論理あて先のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものをgetLogicalDestinationsメソッドの引数に渡します。
Formクラスを取得します。
LogicalDestinationクラスのgetFormsメソッドを呼び出して、Formクラスのインスタンスオブジェクトの配列を取得します。
取得する帳票の帳票IDが分かる場合は、LogicalDestinationクラスのgetFormメソッドを呼び出して、Formクラスのインスタンスオブジェクトを取得します。
ポイント
- 検索条件を指定して検索を行う場合は、FormFilterConditionクラスのインスタンスオブジェクトを生成し、検索条件を設定したものをgetFormsメソッドの引数に渡します。
- 取得した帳票のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものをgetFormsメソッドの引数に渡します。
取得したFormクラスのインスタンスオブジェクトから帳票属性を取得するには、Formクラスの情報取得メソッド（getまたはisで始まるメソッド）で取得できます。
帳票を操作します。
操作する帳票のFormクラスのメソッドを呼び出します。

＜記述例＞

出力状態が「失敗」（STATUS_FAILED）の帳票を取得して、削除します。

import com.fujitsu.listmanager.operate.LMUser;
import com.fujitsu.listmanager.operate.LogicalDestination;
import com.fujitsu.listmanager.operate.LogicalDestinationFilterCondition;
import com.fujitsu.listmanager.operate.LogicalDestinationManager;
import com.fujitsu.listmanager.operate.UserAuthorization;
import com.fujitsu.listmanager.operate.Form;
import com.fujitsu.listmanager.operate.FormFilterCondition;
import com.fujitsu.listmanager.operate.SortOrder;
    :
    :

// List Manager のユーザ認証を行います
//ユーザIDが「user1」、パスワードが「psw1」のユーザを取得します
LMUser user = UserAuthorization.authorize("user1", "psw1");

// LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します
LogicalDestinationManager logicalDestinationManager = new LogicalDestinationManager(user);

// 論理あて先が「ld1」のLogicalDestinationクラスを取得します
LogicalDestinationFilterCondition filter = new LogicalDestinationFilterCondition();
filter.setName("ld1");
LogicalDestination[] logicalDestinations = logicalDestinationManager.getLogicalDestinations
(filter,null);
LogicalDestination ld1 = logicalDestinations[0];

// 論理あて先から、出力状態が「失敗」の帳票を取得します（取得した帳票は、帳票ID、帳票名の順で
ソートします）
FormFilterCondition formFilter = new FormFilterCondition();
int[] outputStatus = {Form.STATUS_FAILED};
formFilter.setOutputStatus(outputStatus);
SortOrder[] sort = {new SortOrder(SortOrder.ITEM_FORM_ID),
                    new SortOrder(SortOrder.ITEM_FORM_NAME)}
Form[] forms = ld1.getForms(formFilter, sort);

// 帳票を削除します
for (int i = 0; i < forms.length; i++) {
    forms[i].delete();
}
    :
    :

●ユーザを取得する場合

＜作成手順＞

List Managerユーザの認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
ここでは、List Managerの管理者権限で認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
LMUserManagerクラスを取得します。
1.で取得したLMUserクラスのインスタンスオブジェクトをキャストして、LMUserManagerクラスのインスタンスオブジェクトを取得します。
ユーザを取得します。
LMUserManagerクラスのgetUsersメソッドを呼び出し、LMUserクラスのインスタンスオブジェクトの配列を取得します。
ポイント
取得したユーザのソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものをgetUsersメソッドの引数に渡します。
取得したLMUserクラスのインスタンスオブジェクトからユーザ情報を取得するには、LMUserクラスの情報取得メソッド（getで始まるメソッド）で取得できます。

＜記述例＞

ユーザIDが「userid1」のユーザを取得します。

import com.fujitsu.listmanager.operate.LMUser;
import com.fujitsu.listmanager.operate.LMUserManager;
import com.fujitsu.listmanager.operate.UserAuthorization;
    :
    :

// List Managerの管理者権限で、認証を行います
LMUser user = UserAuthorization.authorize("admin1","adpsw1");

//LMUserManagerクラスを取得します
LMUserManager manager = null;
if (user instanceof LMUserManager) {
    manager = (LMUserManager)user;
}

//ユーザIDが「userid1」のユーザを取得します
LMUser[] users = manager.getUsers("userid1", null, null);
LMUser user1 = users[0];

//ユーザの情報を取得します。
String fullname = user1.getFullName(); //フルネーム
String comment = user1.getComment();   //コメント
    :
    :

●ユーザグループを取得する場合

＜作成手順＞

List Managerユーザの認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
ここでは、List Managerの管理者権限で認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
LMUserManagerクラスを取得します。
1.で取得したLMUserクラスのインスタンスオブジェクトをキャストして、LMUserManagerクラスのインスタンスオブジェクトを取得します。
ユーザグループを取得します。
LMUserManagerクラスのgetUserGroupsメソッドを呼び出し、LMUserGroupクラスのインスタンスオブジェクトの配列を取得します。
ポイント
取得したユーザグループのソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものをgetUserGroupsメソッドの引数に渡します。
取得したLMUserGroupクラスのインスタンスオブジェクトからユーザグループ情報を取得するには、LMUserGroupクラスの情報取得メソッド（getで始まるメソッド）で取得できます。

＜記述例＞

ユーザグループIDが「usergroupid1」のユーザを取得します。

import com.fujitsu.listmanager.operate.LMUser;
import com.fujitsu.listmanager.operate.LMUserGroup;
import com.fujitsu.listmanager.operate.LMUserManager;
import com.fujitsu.listmanager.operate.UserAuthorization;
    :
    :

// List Managerの管理者権限で、認証を行います
LMUser user = UserAuthorization.authorize("admin1","adpsw1");

//LMUserManagerクラスを取得します
LMUserManager manager = null;
if (user instanceof LMUserManager) {
    manager = (LMUserManager)user;
}

//ユーザグループID が「usergroupid1」のユーザを取得します
LMUserGroup[] userGroups = manager.getUserGroups("usergroupid1",null);
LMUserGroup userGroup1 = userGroups[0];

//ユーザグループの情報を取得します。
String groupName = userGroup1.getGroupName(); //ユーザグループ名
String comment = userGroup1.getComment();     //コメント
   :
   :