IMMItemManagerオブジェクト

コンポーネント情報
since	7.2

コンポーネント概要

品目マネージャ。

品目情報の操作を行うマネージャです。

コンストラクタの概要

IMMItemManager (String `[updateUserCd]`, String `[defaultLocale]`) コンストラクタ
IMMItemManager (String `updateUserCd`, String `defaultLocale`, String `loginGroupId`) 非推奨コンストラクタ IMMItemManager([String updateUserCd][,String defaultLocale])を使用してください。

メソッドの概要

返却値の型	メソッド名
BizApiResultInfo	count (String `companyCd`, AppCmnSearchCondition `condition`, Date `date`, String `locale`, Boolean `[isDisable]`) 指定された条件に該当するデータの件数を取得します。
BizApiResultInfo	getTermList (ItemBizKeyInfo `bizKey`, Boolean `[isDisable]`) 品目ビジネスキーから存在する期間の一覧を取得します。
BizApiResultInfo	getTerm (ItemBizKeyInfo `bizKey`, Date `termDate`) 品目ビジネスキーと日付から、対応する期間情報を取得します。
BizApiResultInfo	get (ItemBizKeyInfo `bizKey`, Date `termDate`, String `locale`, Boolean `[isDisable]`) 引数の品目ビジネスキーに該当する品目情報を取得します。
BizApiResultInfo	get (ItemBizKeyInfo `bizKey`, Boolean `[isDisable]`) 引数の品目ビジネスキーに該当する品目情報を取得します。
BizApiResultInfo	get (ItemBizKeyInfo `bizKey`, Date `termDate`, Boolean `[isDisable]`) 引数の品目ビジネスキーに該当する品目情報を取得します。
BizApiResultInfo	get (ItemBizKeyInfo `bizKey`, String `locale`, Boolean `[isDisable]`) 引数の品目ビジネスキーに該当する品目情報を取得します。
BizApiResultInfo	list (String `companyCd`, AppCmnSearchCondition `condition`, Date `date`, String `locale`, Number `[start]`, Number `[count]`, Boolean `[isDisable]`) 指定された条件を元に一覧を取得します。
BizApiResultInfo	mergeBackwardTerm (ItemBizKeyInfo `bizKey`, String `mergeTermCd`) 登録済の品目情報を隣接するひとつ過去のレコードと結合します。
BizApiResultInfo	mergeForwardTerm (ItemBizKeyInfo `bizKey`, String `mergeTermCd`) 登録済の品目情報を隣接するひとつ未来のレコードと結合します。
BizApiResultInfo	moveTerm (ItemBizKeyInfo `bizKey`, TermInfo `moveTerm`) 登録済みの品目情報についての、期間区切りを変更します。
BizApiResultInfo	remove (String `locale`) 非推奨指定されたロケールに対応するすべての期間の品目情報を削除します。 remove (ItemBizKeyInfo bizKey [,String locale]) を使用してください。
BizApiResultInfo	remove (ItemBizKeyInfo `bizKey`, String `[locale]`) 引数の品目ビジネスキーに該当するすべての期間の品目情報を削除します。
BizApiResultInfo	search (String `companyCd`, AppCmnSearchCondition `condition`, Date `date`, String `locale`, Number `[start]`, Number `[count]`, Boolean `[isDisable]`) 指定された条件を元に検索を行います。
BizApiResultInfo	separateTerm (ItemBizKeyInfo `bizKey`, String `sepTermCd`, Date `sepTermDate`) 登録済みの品目情報についての、期間分割を行います。
BizApiResultInfo	set (ItemInfo `item`) 品目情報を新規登録、もしくは更新処理を行います。
BizApiResultInfo	total (String `companyCd`, AppCmnSearchCondition `condition`, Date `date`, Boolean `[isDisable]`) 指定された条件に該当するデータの総数を取得します。

コンストラクタの詳細

IMMItemManager (String [updateUserCd], String [defaultLocale])

コンストラクタ

パラメータ

[updateUserCd] : String: 更新ユーザコード

[defaultLocale] : String: デフォルトロケール

IMMItemManager (String updateUserCd, String defaultLocale, String loginGroupId) 非推奨

IMMItemManager([String updateUserCd][,String defaultLocale])を使用してください。

コンストラクタ

パラメータ

updateUserCd : String: 更新ユーザコード

defaultLocale : String: デフォルトロケール

loginGroupId : String: ログイングループID

メソッドの詳細

BizApiResultInfo count (String companyCd, AppCmnSearchCondition condition, Date date, String locale, Boolean [isDisable])

指定された条件に該当するデータの件数を取得します。

conditionに指定できるテーブルは、imm_itemテーブルです。

パラメータ

companyCd : String: 対象会社コード

condition : AppCmnSearchCondition: 検索条件

date : Date: 対象日付

locale : String: 対象ロケールID

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得したデータの件数(Number)が設定されます。

BizApiResultInfo getTermList (ItemBizKeyInfo bizKey, Boolean [isDisable])

品目ビジネスキーから存在する期間の一覧を取得します。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

[isDisable] : Boolean: 期間の取得に関して、このパラメータがfalseの場合は削除フラグが有効な期間は取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した期間情報の配列(Array)が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo getTerm (ItemBizKeyInfo bizKey, Date termDate)

品目ビジネスキーと日付から、対応する期間情報を取得します。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

termDate : Date: 期間情報を取得する基準日付

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した期間情報が設定されます。
(該当データが存在しない場合は null が返却されます。)

BizApiResultInfo get (ItemBizKeyInfo bizKey, Date termDate, String locale, Boolean [isDisable])

引数の品目ビジネスキーに該当する品目情報を取得します。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

termDate : Date: 取得するレコードの基準日。この日付が含まれる期間のみが取得されます。

locale : String: 取得するレコードのロケールID

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目情報が設定されます。
(該当データが存在しない場合は null が返却されます。)

BizApiResultInfo get (ItemBizKeyInfo bizKey, Boolean [isDisable])

引数の品目ビジネスキーに該当する品目情報を取得します。

このメソッドでは、引数に該当する全期間のレコードを、全ロケール分取得します。
その際、戻り値のItemのデフォルトロケールはマネージャ初期化時に指定したものになります。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目情報の配列(Array)が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo get (ItemBizKeyInfo bizKey, Date termDate, Boolean [isDisable])

引数の品目ビジネスキーに該当する品目情報を取得します。

このメソッドでは、引数に該当するレコードを全ロケール分取得します。
その際、戻り値のItemのデフォルトロケールはマネージャ初期化時に指定したものになります。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

termDate : Date: 取得するレコードの基準日。この日付が含まれる期間のみが取得されます。

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目情報が設定されます。
(該当データが存在しない場合は null が返却されます。)

BizApiResultInfo get (ItemBizKeyInfo bizKey, String locale, Boolean [isDisable])

引数の品目ビジネスキーに該当する品目情報を取得します。

このメソッドでは、引数に該当する全期間のレコードを取得します。

パラメータ

bizKey : ItemBizKeyInfo: 取得する品目ビジネスキーオブジェクト

locale : String: 取得するレコードのロケールID

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目情報の配列(Array)が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo list (String companyCd, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])

指定された条件を元に一覧を取得します。
引数のロケールの情報が存在しない場合は、表示名にNULLが挿入されます。

conditionに指定できるテーブルは、imm_itemテーブルです。

パラメータ

companyCd : String: 取得対象会社コード

condition : AppCmnSearchCondition: 取得条件

date : Date: 対象日付

locale : String: 表示対象のロケールID

[start] : Number: 取得開始レコード行。この引数を利用する場合は取得レコード数(count)を設定してください。
このパラメータが省略された場合、1(先頭行)が設定されます。

[count] : Number: 取得レコード数。この引数を利用する場合は取得開始レコード行(start)を設定してください。
このパラメータが省略された場合、0(全件取得)が設定されます。

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目リスト情報の配列(Array)が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo mergeBackwardTerm (ItemBizKeyInfo bizKey, String mergeTermCd)

登録済の品目情報を隣接するひとつ過去のレコードと結合します。

隣接する過去のレコードが存在しない場合はエラーになります。

実行されるリスナ
更新：
ItemListener#updateTerm
削除：
ItemListener#removeTerm

パラメータ

bizKey : ItemBizKeyInfo: 結合元となる品目ビジネスキーオブジェクト

mergeTermCd : String: 結合対象の期間コード

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。

BizApiResultInfo mergeForwardTerm (ItemBizKeyInfo bizKey, String mergeTermCd)

登録済の品目情報を隣接するひとつ未来のレコードと結合します。

隣接する未来のレコードが存在しない場合はエラーになります。

実行されるリスナ
更新：
ItemListener#updateTerm
削除：
ItemListener#removeTerm

パラメータ

bizKey : ItemBizKeyInfo: 結合元となる品目ビジネスキーオブジェクト

mergeTermCd : String: 結合対象の期間コード

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。

BizApiResultInfo moveTerm (ItemBizKeyInfo bizKey, TermInfo moveTerm)

登録済みの品目情報についての、期間区切りを変更します。

期間区切り変更する場合、「変更対象のレコード」と「変更される日付と期間が重複するレコード群」の更新処理が行われます。
また、変更される期間の値が隣接するレコードの期間を越える場合、そのレコードは削除されます。

実行されるリスナ
作成：
ItemListener#createTerm
更新：
ItemListener#updateTerm
削除：
ItemListener#removeTerm

パラメータ

bizKey : ItemBizKeyInfo: 変更対象の品目ビジネスキーオブジェクト

moveTerm : TermInfo: 変更を行う期間コード及び、変更後の期間情報オブジェクト

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに期間区切りを変更する処理の際、新しく作成された期間情報の配列(Array)が設定されます。
(新しく作成されたデータが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo remove (String locale) 非推奨

remove (ItemBizKeyInfo bizKey [,String locale]) を使用してください。

指定されたロケールに対応するすべての期間の品目情報を削除します。

実行されるリスナ
削除：
ItemListener#remove

パラメータ

locale : String: 削除対象のロケールID

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。

BizApiResultInfo remove (ItemBizKeyInfo bizKey, String [locale])

引数の品目ビジネスキーに該当するすべての期間の品目情報を削除します。

実行されるリスナ
削除：
ItemListener#remove

パラメータ

bizKey : ItemBizKeyInfo: 削除対象の品目ビジネスキーオブジェクト

[locale] : String: 削除対象のロケールID
このパラメータが省略された場合、全ロケールを対象とします。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。

BizApiResultInfo search (String companyCd, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])

指定された条件を元に検索を行います。

conditionに指定できるテーブルは、imm_itemテーブルです。

パラメータ

companyCd : String: 検索対象会社コード

condition : AppCmnSearchCondition: 検索条件

date : Date: 対象日付

locale : String: 検索対象ロケールID

[start] : Number: 取得開始レコード行。この引数を利用する場合は取得レコード数(count)を設定してください。
このパラメータが省略された場合、1(先頭行)が設定されます。

[count] : Number: 取得レコード数。この引数を利用する場合は取得開始レコード行(start)を設定してください。
このパラメータが省略された場合、0(全件取得)が設定されます。

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得した品目リスト情報の配列(Array)が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

BizApiResultInfo separateTerm (ItemBizKeyInfo bizKey, String sepTermCd, Date sepTermDate)

登録済みの品目情報についての、期間分割を行います。

期間分割の場合、分割対象の品目情報の終了日を分割対象日付に設定して更新し、
同時に分割対象日付を開始日に設定した、同内容の品目情報を新たに登録します。

分割を行う基準日付が対象情報の期間内にない場合はエラーとなります。

実行されるリスナ
作成：
ItemListener#createTerm
更新：
ItemListener#updateTerm

パラメータ

bizKey : ItemBizKeyInfo: 分割を行う品目ビジネスキーオブジェクト

sepTermCd : String: 分割を行う期間コード

sepTermDate : Date: 分割を行う基準日付

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに分割後新たに作成された品目の期間情報が設定されます。

BizApiResultInfo set (ItemInfo item)

品目情報を新規登録、もしくは更新処理を行います。

引数として与えられた品目情報について、
期間コードが指定されていない場合は、品目情報を新規登録します。
期間コードが指定されている場合は、品目情報を更新します。

実行されるリスナ
作成：
ItemListener#create
更新：
ItemListener#update

パラメータ

item : ItemInfo: 品目情報オブジェクト

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに新規に登録した品目の期間情報の配列(Array)が設定されます。
(更新処理の場合には要素数 0 の Array が返却されます。)

BizApiResultInfo total (String companyCd, AppCmnSearchCondition condition, Date date, Boolean [isDisable])

指定された条件に該当するデータの総数を取得します。

conditionに指定できるテーブルは、imm_itemテーブルです。

パラメータ

companyCd : String: 対象会社コード

condition : AppCmnSearchCondition: 検索条件

date : Date: 対象日付

[isDisable] : Boolean: レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
このパラメータを省略した場合はfalseが設定されます。

返却値

BizApiResultInfo: BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得したデータの総数(Number)が設定されます。