ページの先頭行へ戻る
Interstage List Works for 大規模 V11.0.0 APIリファレンス
第3章 Web連携機能API > 3.2 ListGateway > 3.2.5 Javaクラス(KeepSheetAttribute)
前次

3.2.5 Javaクラス(KeepSheetAttribute)

以下に、Javaクラス(KeepSheetAttribute)のメソッドを示します。

メソッド

機能

getAccessCount

アクセス回数の取得

getAutoDelete

[有効期限を過ぎたら削除対象にする]が設定されているかどうかの取得

getComment

帳票のコメントの取得

getCreateDate

帳票の作成日時の取得

getCreatorName

帳票の作成者名の取得

getDataSpaceType

印刷データの空白文字の扱いの取得

getFileName

ファイル名の取得

getFiling

ファイリングされているかどうかの取得

getFlagInfo

フラグ情報の取得

getIndexFind

抜き出し検索ができるかどうかの取得

getItem

帳票に記入情報が記入されているかどうかの取得

getMask

マスク文字の有無を取得

getNForm

二次帳票の生成可否を取得

getNodeId

帳票の識別子の取得

getNote1

備考1の取得

getNote2

備考2の取得

getNote3

備考3の取得

getNote4

備考4の取得

getReferenceDate

最終参照日時の取得

getRegistDate

登録日時の取得

getSepSheet

結合帳票かどうかの取得

getSepSheetCount

結合帳票を構成する帳票数の取得

getSerialSheetNo

帳票番号の取得

getTitle

帳票名の取得

getTotalPage

ページ数の取得

getValid

有効・無効フラグの取得

getValidDate

登録有効期限の取得

setValid

有効・無効フラグの設定


3.2.5.1 getAccessCount(アクセス回数の取得)

記述形式

KeepSheetAttribute.getAccessCount()

機能

アクセス回数を取得します。


パラメタの説明

なし


復帰値

int型のアクセス回数


使用例

保管フォルダ内の0番の帳票について、帳票のアクセス回数を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getAccessCount();

3.2.5.2 getAutoDelete(［有効期限を過ぎたら削除対象にする］が設定されているかどうかの取得)

記述形式

KeepSheetAttribute.getAutoDelete()

機能

[有効期限を過ぎたら削除対象にする]が設定されているかどうかを取得します。


パラメタの説明

なし


復帰値

byte型の[有効期限を過ぎたら削除対象にする]が設定されているかどうか

0

[有効期限を過ぎたら削除対象にする]が設定されていない

1

[有効期限を過ぎたら削除対象にする]が設定されている


使用例

保管フォルダ内の0番の帳票について、[有効期限を過ぎたら削除対象にする]が設定されているかどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getAutoDelete();

3.2.5.3 getComment(帳票のコメントの取得)

記述形式

KeepSheetAttribute.getComment()

機能

帳票のコメントを取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票のコメント


使用例

保管フォルダ内の0番の帳票について、帳票のコメントを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getComment();

3.2.5.4 getCreateDate(帳票の作成日時の取得)

記述形式

KeepSheetAttribute.getCreateDate()

機能

帳票の作成日時を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票の作成日時


使用例

保管フォルダ内の0番の帳票について、帳票の作成日時を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getCreateDate();

3.2.5.5 getCreatorName(帳票の作成者名の取得)

記述形式

KeepSheetAttribute.getCreatorName()

機能

帳票の作成者名を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票の作成者名


使用例

保管フォルダ内の0番の帳票について、帳票の作成者名を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getCreatorName();

3.2.5.6 getDataSpaceType(印刷データの空白文字の扱いの取得)

記述形式

KeepSheetAttribute.getDataSpaceType()

機能

帳票（印刷データ）の空白文字が有効となっているかどうかを取得します。

パラメタの説明

なし

復帰値

byte型の印刷データの空白文字の扱い

0

空白文字を無効とする（無視する）

1

空白文字を有効とする

使用例

保管フォルダ内の0番の帳票について、空白文字が有効となっているかどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getDataSpaceType();

3.2.5.7 getFileName(ファイル名の取得)

記述形式

KeepSheetAttribute.getFileName()

機能

帳票のファイル名を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票のファイル名


使用例

保管フォルダ内の0番の帳票について、帳票のファイル名を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getFileName();

3.2.5.8 getFiling(ファイリングされているかどうかの取得)

記述形式

KeepSheetAttribute.getFiling()

機能

ファイリングされているかどうかを取得します。
Linux版の場合、常に「0」が復帰します。


パラメタの説明

なし


復帰値

byte型のファイリングされているかどうか

0

ファイリングされていない

1

ファイリングされている


使用例

保管フォルダ内の0番の帳票について、ファイリングされているかどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getFiling();

3.2.5.9 getFlagInfo(フラグ情報の取得)

記述形式

KeepSheetAttribute.getFlagInfo(設定フラグ情報)

機能

設定フラグ情報を取得します。


パラメタの説明

設定フラグ情報

何番目の設定フラグ情報を取得するかをint型で指定します。

  0：ポーリング印刷
  2：ローカル印刷（Windows版およびSolaris版のみ）

必ず指定します。


復帰値

byte型の設定フラグ情報

0

OFF

1

ON


使用例

保管フォルダ内の0番の帳票について、設定フラグ情報「ポーリング印刷」を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getFlagInfo(0);

保管フォルダ内の0番の帳票について、設定フラグ情報「ローカル印刷」を取得します。（Windows版およびSolaris版のみ）

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getFlagInfo(2);

3.2.5.10 getIndexFind(抜き出し検索ができるかどうかの取得)

記述形式

KeepSheetAttribute.getIndexFind()

機能

抜き出し検索ができるかどうかを取得します。


パラメタの説明

なし


復帰値

byte型の抜き出し検索ができるかどうか

0

抜き出し検索ができない

1

抜き出し検索ができる


使用例

保管フォルダ内の0番の帳票について、抜き出し検索可能かどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getIndexFind();

3.2.5.11 getItem(帳票に記入情報が記入されているかどうかの取得)

記述形式

KeepSheetAttribute.getItem()

機能

帳票に記入情報が記入されているかどうかを取得します。


パラメタの説明

なし


復帰値

byte型の帳票に記入情報が記入されているかどうか

0

帳票に記入情報が記入されていない

1

帳票に記入情報が記入されている


使用例

保管フォルダ内の0番の帳票について、記入情報が記入されているかどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getItem();

3.2.5.12 getMask(マスク文字の有無を取得)

記述形式

KeepSheetAttribute.getMask()


機能

帳票のデータにマスク文字が存在するかどうかを取得します。


パラメタの説明

なし


復帰値

byte型の帳票のデータにマスク文字が存在するかどうか

0

マスク文字が存在しない

1

マスク文字が存在する


使用例

保管フォルダ内の0番の帳票について、マスク文字が存在するかどうかを取得します。

KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
keepSheetAttribute.getMask();

3.2.5.13 getNForm(二次帳票の生成可否を取得)

記述形式

KeepSheetAttribute.getNForm()


機能

二次帳票が生成できるかどうかを取得します。


パラメタの説明

なし


復帰値

byte型の二次帳票の生成ができるかどうか

0

二次帳票を生成できない

1

二次帳票を生成できる


使用例

保管フォルダ内の0番の帳票について、二次帳票を生成できるかどうかを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute. getNForm();

3.2.5.14 getNodeId(帳票の識別子の取得)

記述形式

KeepSheetAttribute.getNodeId()

機能

帳票の識別子を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票の識別子


使用例

保管フォルダ内の0番の帳票について、帳票の識別子を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getNodeId();

3.2.5.15 getNote1(備考1の取得)

記述形式

KeepSheetAttribute.getNote1()

機能

備考1を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の備考1


使用例

保管フォルダ内の0番の帳票について、備考1を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getNote1();

3.2.5.16 getNote2(備考2の取得)

記述形式

KeepSheetAttribute.getNote2()

機能

備考2を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の備考2


使用例

保管フォルダ内の0番の帳票について、備考2を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getNote2();

3.2.5.17 getNote3(備考3の取得)

記述形式

KeepSheetAttribute.getNote3()

機能

備考3を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の備考3


使用例

保管フォルダ内の0番の帳票について、備考3を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getNote3();

3.2.5.18 getNote4(備考4の取得)

記述形式

KeepSheetAttribute.getNote4()

機能

備考4を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の備考4


使用例

保管フォルダ内の0番の帳票について、備考4を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getNote4();

3.2.5.19 getReferenceDate(最終参照日時の取得)

記述形式

KeepSheetAttribute.getReferenceDate()

機能

最終参照日時を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の最終参照日時


使用例

保管フォルダ内の0番の帳票について、最終参照日時を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getReferenceDate();

3.2.5.20 getRegistDate(登録日時の取得)

記述形式

KeepSheetAttribute.getRegistDate()

機能

帳票の登録日時を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の登録日時


使用例

保管フォルダ内の0番の帳票について、登録日時を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getRegistDate();

3.2.5.21 getSepSheet（結合帳票かどうかの取得）

記述形式

KeepSheetAttribute.getSepSheet()

機能

結合帳票かどうかを取得します。


パラメタの説明

なし


復帰値

byte型の結合帳票かどうか。

0

結合帳票ではない

1

結合帳票である

使用例

保管フォルダ内にある0番の帳票について、結合帳票かどうかを取得します。

KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
keepSheetAttribute.getSepSheet();

3.2.5.22 getSepSheetCount(結合帳票を構成する帳票数の取得)

記述形式

KeepSheetAttribute.getSepSheetCount()


機能

結合帳票を構成する帳票数を取得します。


パラメタの説明

なし


復帰値

int型の結合帳票を構成する帳票数。

対象の帳票が結合帳票でない場合は、0が復帰されます。


使用例

保管フォルダ内にある0番の帳票について、結合帳票を構成する帳票数を取得します。

KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
keepSheetAttribute.getSepSheetCount();

3.2.5.23 getSerialSheetNo(帳票番号の取得)

記述形式

KeepSheetAttribute.getSerialSheetNo()

機能

帳票番号を取得します。


パラメタの説明

なし


復帰値

int型の帳票番号


使用例

保管フォルダ内の0番の帳票について、帳票番号を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getSerialSheetNo();

3.2.5.24 getShowDate（参照有効期限の取得）

記述形式

KeepSheetAttribute.getShowDate()

機能

帳票の参照有効期限を取得します。


パラメタの説明

なし


復帰値

java.lang.String 型の帳票の参照有効期限


使用例

保管フォルダ内の0 番目の帳票について、帳票の参照有効期限を取得します。

KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
keepSheetAttribute.getShowDate();

3.2.5.25 getShowType（表示対象の取得）

記述形式

KeepSheetAttribute.getShowType()

機能

帳票に[参照有効期限が過ぎても表示する]が設定されているかを取得します。


パラメタの説明

なし


復帰値

byte型の[参照有効期限を過ぎても表示する]が設定されているかどうか

0

[参照有効期限を過ぎても表示する]が設定されていない

1

[参照有効期限を過ぎても表示する]が設定されている


使用例

保管フォルダ内の0番目の帳票について、[参照有効期限を過ぎても表示する]が設定されているかどうかを取得します。

KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
keepSheetAttribute.getShowType();

3.2.5.26 getTitle(帳票名の取得)

記述形式

KeepSheetAttribute.getTitle()

機能

帳票名を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票名


使用例

保管フォルダ内の0番の帳票について、帳票名を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getTitle();

3.2.5.27 getTotalPage(ページ数の取得)

記述形式

KeepSheetAttribute.getTotalPage()

機能

ページ数を取得します。


パラメタの説明

なし


復帰値

long型のページ数


使用例

保管フォルダ内の0番の帳票について、ページ数を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getTotalPage();

3.2.5.28 getValid(有効・無効フラグの取得)

記述形式

KeepSheetAttribute.getValid()

機能

setValidメソッドで設定した有効・無効フラグを取得します。


パラメタの説明

なし


復帰値

true

有効

false

無効


使用例

保管フォルダ内の0番の帳票について、setValidメソッドで設定した有効・無効フラグを取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getValid();

3.2.5.29 getValidDate(登録有効期限の取得)

記述形式

KeepSheetAttribute.getValidDate()

機能

帳票の登録有効期限を取得します。


パラメタの説明

なし


復帰値

java.lang.String型の帳票の登録有効期限


使用例

保管フォルダ内の0番目の帳票について、帳票の登録有効期限を取得します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.getValidDate();

3.2.5.30 setValid(有効・無効フラグの設定)

記述形式

KeepSheetAttribute.setValid(有効・無効フラグ)

機能

有効・無効フラグを設定します。
有効・無効フラグは、ある条件に一致する帳票に印をつける場合など、帳票を区別するために使用します。


パラメタの説明

有効・無効フラグ

有効・無効フラグをboolean型で指定します。

  true：有効にする
  false：無効にする

必ず指定します。


復帰値

なし


使用例

保管フォルダ内の0番の帳票に、無効フラグを設定します。

  KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0);
  keepSheetAttribute.setValid(false);

前次
Copyright 1995-2025 Fujitsu Limited