CompanyManager オブジェクト

CompanyManagerオブジェクト。

会社や組織に関連する情報の参照、更新を行うマネージャオブジェクトです。

会社に関連する情報を操作する場合に用いる 会社情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
会社情報オブジェクト
会社情報
オブジェクト
(Object)
companyCode 会社コード (String)
notes 備考 (String)
sortKey ソートキー (Number)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
telephoneNumber 電話番号 (String)
faxNumber FAX番号 (String)
extensionNumber 内線番号 (String)
extensionFaxNumber 内線FAX番号 (String)
countryCode 国コード (String)
zipCode 郵便番号 (String)
emailAddress1 メールアドレス1 (String)
emailAddress2 メールアドレス2 (String)
url URL (String)
locales 期間国際化情報 (Object) Locale ID
(ja, en等のロケールID)

(Object)
name 会社名 (String)
nameSyllabary 会社名カナ (String)
nameEnglish 会社名英字 (String)
address1 住所1 (String)
address2 住所2 (String)


組織に関連する情報を操作する場合に用いる 組織情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
組織情報オブジェクト
組織情報
オブジェクト
(Object)
companyCode 会社コード (String)
departmentCode 組織コード (String)
notes 備考 (String)
sortKey ソートキー (Number)
extended 拡張情報 (拡張マップオブジェクト ExtendedMap)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
telephoneNumber 電話番号 (String)
faxNumber FAX番号 (String)
extensionNumber 内線番号 (String)
extensionFaxNumber 内線FAX番号 (String)
countryCode 国コード (String)
zipCode 郵便番号 (String)
emailAddress1 メールアドレス1 (String)
emailAddress2 メールアドレス2 (String)
url URL (String)
extended 拡張情報 (拡張マップオブジェクト ExtendedMap)
locales 期間国際化情報 (Object) Locale ID
(ja, en等のロケールID)

(Object)
name 組織名 (String)
nameSyllabary 組織名カナ (String)
nameEnglish 組織名英字 (String)
address1 住所1 (String)
address2 住所2 (String)
extended 拡張情報 (拡張マップオブジェクト ExtendedMap)


役職に関連する情報を操作する場合に用いる 役職情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
役職情報オブジェクト
役職情報
オブジェクト
(Object)
companyCode 会社コード (String)
postCode 役職コード (String)
notes 備考 (String)
sortKey ソートキー (Number)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
locales 期間国際化情報 (Object) Locale ID
(ja, en等のロケールID)

(Object)
name 役職名 (String)


役職に関連する情報を操作する場合に用いる 非構造化役職情報オブジェクトの構成は以下の通りです。
非構造化役職情報オブジェクトは1つのオブジェクトの中で、役職についての期間および言語に関する情報を扱います。
非構造化役職情報オブジェクト
非構造化
役職情報
オブジェクト
(Object)
companyCode 会社コード (String)
postCode 役職コード (String)
postName 役職名 (String)
notes 備考 (String)
sortKey ソートキー (String)
startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
locale 役職名に対する言語(ja, en等のロケールID) (String)


会社構成バージョンに関連する情報を操作する場合に用いる 会社構成バージョン情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
会社構成バージョン情報オブジェクト
会社構成バージョン情報
オブジェクト
(Object)
companyCode 会社コード (String)
versionCode バージョンコード (String)
startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
notes 備考 (String)


組織への所属に関連する情報を操作する場合に用いる 組織への所属情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
組織への所属情報オブジェクト
組織への所属情報
オブジェクト
(Object)
userCode ユーザコード (String)
companyCode 会社コード (String)
departmentCode 組織コード (String)
sortKey ソートキー (Number)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
postCode 役職コード (String)


会社組織分類区分に関連する情報を操作する場合に用いる 会社組織分類区分情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
会社組織分類区分情報オブジェクト
会社組織分類区分情報
オブジェクト
(Object)
companyCode 会社コード (String)
departmentCode 組織コード (String)
categoryClassCode 分類区分コード (String)
categoryCode 分類コード (String)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)


主所属情報に関連する情報を操作する場合に用いる 主所属情報オブジェクトの構成は以下の通りです。
(なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、 「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。)
主所属情報オブジェクト
主所属情報
オブジェクト
(Object)
userCode ユーザコード (String)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
companyCode 会社コード (String)
departmentCode 組織コード (String)


組織の階層情報オブジェクトの構成は以下の通りです。
組織の階層情報オブジェクト
組織の階層
オブジェクト
(Object)
companyCode 会社コード (String)
departmentCode 組織コード (String)
name 会社名または組織名 (String)


処理結果オブジェクトの構成は以下の通りです。
処理結果オブジェクトの data 属性は検索処理が成功 (error ステータスが false) の場合にのみ定義されます。
data属性には、呼び出されたメソッドの結果に応じたオブジェクトが設定されます。
処理結果オブジェクト
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 任意のオブジェクト (検索処理の成功時のみ)

バージョン:1.0
導入されたバージョン:5.0

コンストラクタの概要
CompanyManager(String user ,String group)
コンストラクタ

メソッドの概要
Object addCompany(Object company)
会社を登録します。
Object addDepartment(Object department)
組織を登録します。
Object addPost(Object post)
役職を登録します。
Object addVersion(Object version)
会社構成バージョンを登録します。
Object copyVersion(String company ,String srcVersion ,String destVersion ,Date startDate ,Date endDate)
登録済の会社構成バージョンの内容をコピーします。
Object deleteCompany(Object company)
登録済の会社を削除します。
Object deleteDepartment(Object department)
登録済の組織情報を削除します。
Object deleteMember(Object departmentAttach)
組織から人員をはずします。
Object deletePost(Object post)
登録済の役職情報を削除します。
Object deleteVersion(Object version)
登録済の会社構成バージョンを削除します。
Object getAttachedDepartments(String userCode [,Date date])
ユーザが所属する組織の一覧を取得します。
Object getDepartment(String companyCode ,String departmentCode)
組織の詳細情報を取得します。
Object getDepartmentAttach(String userCode ,String companyCode ,String departmentCode)
ユーザの組織への所属情報を取得します。
Object getDepartmentMain(String userCode)
ユーザの主所属情報を取得します。
Object getDepartmentStructs(String company ,String department ,Date date ,String locale)
組織の階層構造を取得します。
Object getMember(String companyCode ,String departmentCode [,Date date])
組織に所属する人員の一覧を取得します。
Object getPostsInCompany(String company [,Date date] [,String locale])
会社に登録されている役職の一覧を取得します。
Object getPostsOfUser(String company ,String user [,Date date] [,String locale])
ユーザに対して設定されている役職の一覧を取得します。
Object getVersion(String companyCode [,Date date])
会社構成バージョン情報を取得します。
Object joinDepartment(String company ,String parentDepartment ,String department ,String version)
組織構成に組織を登録します。
Object leaveDepartment(String company ,String department ,String version)
組織構成から組織情報を離脱させます。
Object moveDepartment(String company ,String parentDepartment ,String department ,String version)
組織構成に登録済の組織情報を移動します。
Object removeCategoryDetail(Object category)
組織に対して指定された分類区分情報を削除します。
Object removeMain(Object main)
指定されたユーザの主所属を削除します。
Object setCategoryDetail(Object category)
組織に対して指定された分類区分情報を設定します。
Object setMain(Object main)
ユーザが主所属する組織を設定します。
Object setMember(Object departmentAttach)
組織に人員を割り当てます。
Object updateDepartment(Object department)
登録済の組織情報を更新します。
Object updatePost(Object post)
登録済の役職情報を更新します。
Object updateVersion(Object version)
登録済の会社構成バージョンを更新します。

コンストラクタの詳細
CompanyManager

CompanyManager(String user ,String group)
コンストラクタ
パラメータ
user String ログインユーザ
group String ログイングループ

メソッドの詳細
addCompany

Object addCompany(Object company)

会社を登録します。

このメソッドを実行すると下記のような動作が行われます。
  1. 会社を新規登録する。
  2. 会社に対応する組織を新規登録する。
パラメータ
company Object 会社情報オブジェクト
返却値
Object 処理結果オブジェクト

addDepartment

Object addDepartment(Object department)

組織を登録します。

このメソッドを実行しただけではまだ会社の組織構成には追加されていません。
組織構成に追加したい場合はjoinDepartment(String, String, String, String) を使用してください。
パラメータ
department Object 組織情報オブジェクト
返却値
Object 処理結果オブジェクト

addPost

Object addPost(Object post)

役職を登録します。

パラメータ
post Object 役職情報オブジェクト
返却値
Object 処理結果オブジェクト

addVersion

Object addVersion(Object version)

会社構成バージョンを登録します。

追加された構成バージョンのトップレベルには、会社に該当する組織が自動的に追加されます。
パラメータ
version Object 会社構成バージョン情報オブジェクト
返却値
Object 処理結果オブジェクト

copyVersion

Object copyVersion(String company ,String srcVersion ,String destVersion ,Date startDate ,Date endDate)

登録済の会社構成バージョンの内容をコピーします。

コピー元の会社構成バージョンに関連する、
全ての組織内包がコピー先の会社構成バージョンに関連づくようにコピーされます。
コピー元のバージョンコードは登録済みのものを選択してください。
コピー先のバージョンコードは登録されていないものを選択してください。
パラメータ
company String コピー元、コピー先の会社構成バージョンの会社コード
srcVersion String コピー元の会社構成バージョンのバージョンコード
destVersion String コピー先の会社構成バージョンのバージョンコード
startDate Date コピー先のパブリックグループセット構成バージョンの有効期間開始日時
endDate Date コピー先のパブリックグループセット構成バージョンの有効期間終了日時
返却値
Object 処理結果オブジェクト

deleteCompany

Object deleteCompany(Object company)

登録済の会社を削除します。

このメソッドを実行すると指定された会社に関連する全ての情報が削除されます。
指定された会社の情報が存在しない場合は処理失敗となります。
パラメータ
company Object 会社情報オブジェクト
返却値
Object 処理結果オブジェクト

deleteDepartment

Object deleteDepartment(Object department)

登録済の組織情報を削除します。

指定された組織情報が存在しない場合は処理失敗となります。
パラメータ
department Object 組織情報オブジェクト
返却値
Object 処理結果オブジェクト

deleteMember

Object deleteMember(Object departmentAttach)

組織から人員をはずします。

指定された人員の情報が存在しない場合は処理失敗となります。
パラメータ
departmentAttach Object 組織から外す人員の情報
返却値
Object 処理結果オブジェクト

deletePost

Object deletePost(Object post)

登録済の役職情報を削除します。

指定された役職情報が存在しない場合は処理失敗となります。
パラメータ
post Object 役職情報オブジェクト
返却値
Object 処理結果オブジェクト

deleteVersion

Object deleteVersion(Object version)

登録済の会社構成バージョンを削除します。

指定された会社構成バージョンの情報が存在しない場合は処理失敗となります。
パラメータ
version Object 会社構成バージョン情報オブジェクト
返却値
Object 処理結果オブジェクト

getAttachedDepartments

Object getAttachedDepartments(String userCode [,Date date])

ユーザが所属する組織の一覧を取得します。

日付が指定されない場合は、システム日付を含む期間の情報を取得します。

検索結果は、処理結果オブジェクトの data属性に組織情報オブジェクトの配列 (Array) として設定されます。
検索条件に一致するデータが存在しない場合は、data属性に要素数が 0 の配列 (Array) が設定されます。

組織情報オブジェクトに設定される期間化情報は、検索で使用された日付を含む期間の情報のみが設定されます。
また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
パラメータ
userCode String ユーザコード
date Date 日付 (省略可能)
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

getDepartment

Object getDepartment(String companyCode ,String departmentCode)

組織の詳細情報を取得します。

検索結果は、処理結果オブジェクトの data属性に組織情報オブジェクトとして設定されます。
検索条件に一致するデータが存在しない場合は、data属性に null が設定されます。

パラメータ
companyCode String 会社コード
departmentCode String 組織コード
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

getDepartmentAttach

Object getDepartmentAttach(String userCode ,String companyCode ,String departmentCode)

ユーザの組織への所属情報を取得します。

検索結果は、処理結果オブジェクトの data属性に組織への所属情報オブジェクトとして設定されます。
検索条件に一致するデータが存在しない場合は、data属性に null が設定されます。

パラメータ
userCode String ユーザコード
companyCode String 会社コード
departmentCode String 組織コード
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

getDepartmentMain

Object getDepartmentMain(String userCode)

ユーザの主所属情報を取得します。

検索結果は、処理結果オブジェクトの data属性に主所属情報オブジェクトとして設定されます。
検索条件に一致するデータが存在しない場合は、data属性に null が設定されます。

パラメータ
userCode String ユーザコード
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

getDepartmentStructs

Object getDepartmentStructs(String company ,String department ,Date date ,String locale)

組織の階層構造を取得します。

検索結果は、処理結果オブジェクトの data属性に組織の階層情報オブジェクトの配列 (Array) として設定されます。

指定された日付に該当する会社構成バージョンが存在しない場合は、エラーとなります。
また、会社構成バージョンは存在するが該当する組織情報が存在しない場合は、data属性に要素数が 0 の配列 (Array) が設定されます。

パラメータ
company String 会社コード
department String 組織コード
date Date 日付
locale String 言語
返却値
Object 処理結果オブジェクト

getMember

Object getMember(String companyCode ,String departmentCode [,Date date])

組織に所属する人員の一覧を取得します。

日付が指定されない場合は、システム日付を含む期間の情報を取得します。

検索結果は、処理結果オブジェクトの data属性にユーザ情報オブジェクトの配列 (Array) として設定されます。
検索条件に一致するデータが存在しない場合は、data属性に要素数が 0 の配列 (Array) が設定されます。

ユーザ情報オブジェクトに設定される期間化情報は、検索で使用された日付を含む期間の情報のみが設定されます。
また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
パラメータ
companyCode String 会社コード
departmentCode String 組織コード
date Date 日付 (省略可能)
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

getPostsInCompany

Object getPostsInCompany(String company [,Date date] [,String locale])

会社に登録されている役職の一覧を取得します。

日付が指定されない場合は、システム日付を含む期間の情報を取得します。
また言語が指定されない場合は、ログインユーザのデフォルト言語の情報が取得されます。

検索結果は、処理結果オブジェクトの data属性に非構造化役職オブジェクト の配列 (Array) として設定されます。
検索条件に一致するデータが存在しない場合は、data属性に要素数が 0 の配列 (Array) が設定されます。

パラメータ
company String 会社コード
date Date 日付 (省略可能)
locale String 言語 (省略可能)
返却値
Object 処理結果オブジェクト

getPostsOfUser

Object getPostsOfUser(String company ,String user [,Date date] [,String locale])

ユーザに対して設定されている役職の一覧を取得します。

日付が指定されない場合は、システム日付を含む期間の情報を取得します。
また言語が指定されない場合は、ログインユーザのデフォルト言語の情報が取得されます。

検索結果は、処理結果オブジェクトの data属性に非構造化役職オブジェクト の配列 (Array) として設定されます。
検索条件に一致するデータが存在しない場合は、data属性に要素数が 0 の配列 (Array) が設定されます。

パラメータ
company String 会社コード
user String ユーザコード
date Date 日付 (省略可能)
locale String 言語 (省略可能)
返却値
Object 処理結果オブジェクト

getVersion

Object getVersion(String companyCode [,Date date])

会社構成バージョン情報を取得します。

日付が指定されない場合は、システム日付を含む期間のバージョン情報を取得します。

検索結果は、処理結果オブジェクトの data属性に会社構成バージョン情報オブジェクトとして設定されます。
検索条件に一致するデータが存在しない場合は、data属性に null が設定されます。

パラメータ
companyCode String 会社コード
date Date 日付 (省略可能)
返却値
Object 処理結果オブジェクト
導入されたバージョン:5.1

joinDepartment

Object joinDepartment(String company ,String parentDepartment ,String department ,String version)

組織構成に組織を登録します。

新しく親となる組織と登録対象の組織は同一の会社に所属している必要があります。
バージョンコードは登録済みのものを指定する必要があります。

指定された組織が対象のバージョンにおいて既に登録されているときはこのメソッドは使用できません。
パラメータ
company String 会社コード
parentDepartment String 新規登録する組織の上位となる組織の組織コード(または会社の会社コード)
department String 新規登録する組織の組織コード(会社に該当する組織は指定できない)
version String バージョンコード
返却値
Object 処理結果オブジェクト

leaveDepartment

Object leaveDepartment(String company ,String department ,String version)

組織構成から組織情報を離脱させます。

このメソッドを実行すると、指定された組織を指定されたバージョンから削除します。
指定された組織が子組織を持っていた場合、それらの組織も再帰的にこのバージョンから削除されます。
このメソッドを実行しても組織情報そのものは残ります。
指定された組織が組織構成に登録されていない場合は処理失敗となります。
パラメータ
company String 会社コード
department String 離脱させる組織の組織コード(会社に該当する組織は指定できない)
version String バージョンコード
返却値
Object 処理結果オブジェクト

moveDepartment

Object moveDepartment(String company ,String parentDepartment ,String department ,String version)

組織構成に登録済の組織情報を移動します。

新しく上位となる組織と移動対象の組織は同一の会社に所属している必要があります。
また、組織構成が循環するような移動はできません。
バージョンコードは登録済みのものを指定する必要があります
パラメータ
company String 上位組織と移動対象の組織画所属する会社の会社コード
parentDepartment String 上位組織の組織コード(または会社の会社コード)
department String 移動する組織の組織コード(会社に該当する組織は指定できない)
version String バージョンコード
返却値
Object 処理結果オブジェクト

removeCategoryDetail

Object removeCategoryDetail(Object category)

組織に対して指定された分類区分情報を削除します。

パラメータ
category Object 削除する会社分類区分情報オブジェクト
返却値
Object 処理結果オブジェクト

removeMain

Object removeMain(Object main)

指定されたユーザの主所属を削除します。

パラメータ
main Object 主所属情報オブジェクト
返却値
Object 処理結果オブジェクト

setCategoryDetail

Object setCategoryDetail(Object category)

組織に対して指定された分類区分情報を設定します。

パラメータ
category Object 設定する会社分類区分情報オブジェクト
返却値
Object 処理結果オブジェクト

setMain

Object setMain(Object main)

ユーザが主所属する組織を設定します。

既存の主所属情報は新しい情報で上書きされます。
パラメータ
main Object 主所属情報オブジェクト
返却値
Object 処理結果オブジェクト

setMember

Object setMember(Object departmentAttach)

組織に人員を割り当てます。

人員の割当情報がすでに設定されている場合は、パラメータで渡された情報で完全に上書きされます。
パラメータ
departmentAttach Object 割当人員の情報
返却値
Object 処理結果オブジェクト

updateDepartment

Object updateDepartment(Object department)

登録済の組織情報を更新します。

パラメータ
department Object 組織情報オブジェクト
返却値
Object 処理結果オブジェクト

updatePost

Object updatePost(Object post)

登録済の役職情報を更新します。

パラメータ
post Object 役職情報オブジェクト
返却値
Object 処理結果オブジェクト

updateVersion

Object updateVersion(Object version)

登録済の会社構成バージョンを更新します。

パラメータ
version Object 会社構成バージョン情報オブジェクト
返却値
Object 処理結果オブジェクト