imbox.CompanyOperationsオブジェクト

コンポーネント情報
version	8.0.6
since	8.0.0

コンポーネント概要

会社情報に対する操作を行うクラスです。

メソッドの概要

返却値の型	メソッド名
ResultObject	createCompanies () 会社情報を現在日のIM共通マスタを元に作成します。
ResultObject	createCompanies (Date `date`) 会社情報を与えられた基準日のIM共通マスタを元に作成します。
ResultObject	existsCompany (String `companyboxCd`) 会社情報の存在有無の判定を行います。
ResultObject	getAttachCompanies (String `start`) 所属している会社一覧の取得を行います。
ResultObject	getAttachUsers (String `companyboxCd`, String `start`) 会社所属ユーザ一覧の取得を行います。
ResultObject	getAttachUsers (String `companyboxCd`, String `start`, Boolean `deleteFlag`) 会社所属ユーザ一覧の取得を行います。
ResultObject	getCompany (String `companyboxCd`) 会社情報の取得を行います。

メソッドの詳細

ResultObject createCompanies ()

会社情報を現在日のIM共通マスタを元に作成します。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject createCompanies (Date date)

会社情報を与えられた基準日のIM共通マスタを元に作成します。

パラメータ

date : Date: 会社情報を取得する基準日

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject existsCompany (String companyboxCd)

会社情報の存在有無の判定を行います。

パラメータ

companyboxCd : String: カンパニーボックスコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、会社情報が存在する場合は true、それ以外は false が設定されます。

ResultObject getAttachCompanies (String start)

所属している会社一覧の取得を行います。
引数カンパニーボックスコード（start）を指定することにより、そのカンパニーボックスコード以降の会社情報が返却されます。
引数カンパニーボックスコード（start）にnullを指定した場合は先頭の会社情報から返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ

start : String: カンパニーボックスコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、会社情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getAttachUsers (String companyboxCd, String start)

会社所属ユーザ一覧の取得を行います。
引数ユーザコード（start）を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード（start）にnullを指定した場合は先頭のユーザから返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）
論理削除されているユーザの取得は行いません。

パラメータ

companyboxCd : String: カンパニーボックスコード

start : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getAttachUsers (String companyboxCd, String start, Boolean deleteFlag)

パラメータ

companyboxCd : String: カンパニーボックスコード

start : String: ユーザコード

deleteFlag : Boolean: 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getCompany (String companyboxCd)

会社情報の取得を行います。

パラメータ

companyboxCd : String: 会社情報を取得する会社のカンパニーボックスコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、会社情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。