Accel Collaboration スクリプト開発API
  • CalDAV スケジュール連携情報オブジェクト
  • CaldavUrlInfo

iac_schedule.FacilityAdminServiceオブジェクト

コンポーネント情報
version8.0.23
since8.0.0
コンポーネント概要
施設に対する管理操作を提供するサービスです。

[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。

[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。

  • Collaboration 管理者ロールを持つユーザ
  • Schedule 機能管理者ロールを持つユーザ
  • Schedule オーナーロールを持つユーザ

[ Collaboration 管理者の場合 ]
Collaboration 管理者として操作可能な施設は、認可で許可された会社の施設カテゴリの施設に限ります。

[ Schedule 機能管理者の場合 ]
Schedule 機能管理者として操作可能な施設は、操作ユーザのカレント組織の会社に一致する施設カテゴリの施設に限ります。

[ Schedule オーナーの場合 ]
Schedule オーナーとして操作可能な施設は、操作ユーザにオーナー設定された施設カテゴリの施設に限ります。

メソッドの概要

返却値の型 メソッド名
ResultObject deleteFacilityImage (FacilityKey facilityKey)
施設の画像ファイルを削除します。
ResultObject deleteFacility (FacilityKey[] facilityKeys)
施設を削除します。
ResultObject findEditFacility (FacilityKey facilityKey)
施設を取得します。
ResultObject findFacilitiesOverview (CategoryKey categoryKey)
施設の概要を取得します。
ResultObject findFacilitiesOverview (String keyword, Integer listLimit)
施設の概要を取得します。
ResultObject findFacilitiesOverview (String companyCd, String keyword, Integer listLimit)
施設の概要を取得します。
ResultObject findFacilityByName (String filterName, Integer listLimit)
施設を取得します。
ResultObject findFacilityByName (String companyCd, String filterName, Integer listLimit)
施設を取得します。
ResultObject findFacilityDetail (FacilityKey facilityKey)
施設詳細を取得します。
ResultObject findFacilityList (CategoryKey categoryKey)
施設を取得します。
ResultObject findFacility (FacilityKey facilityKey)
施設を取得します。
ResultObject registerFacility (Facility facility)
施設を登録します。
ResultObject updateFacility (Facility facility)
施設を更新します。

メソッドの詳細

ResultObject deleteFacilityImage (FacilityKey facilityKey)
施設の画像ファイルを削除します。
パラメータ
facilityKey : FacilityKey
施設キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject deleteFacility (FacilityKey[] facilityKeys)
施設を削除します。
パラメータ
facilityKeys : FacilityKey[]
施設キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject findEditFacility (FacilityKey facilityKey)
施設を取得します。

ここでは、編集用の施設情報を取得します。

パラメータ
facilityKey : FacilityKey
施設キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、EditFacility が設定されます。
ResultObject findFacilitiesOverview (CategoryKey categoryKey)
施設の概要を取得します。

以下のすべての条件に合致する施設の概要を取得します。

  • 指定された施設カテゴリに属しているもの

有効期間外の施設も対象となります。
検索および取得の対象となる名称（施設カテゴリ名・施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

なお、ログインユーザが以下のいずれかの管理者ロールを保有していない場合は例外が発生します。
  • Collaboration 管理者
  • Schedule 機能管理者
  • Schedule オーナー
パラメータ
categoryKey : CategoryKey
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityOverview[] が設定されます。
ResultObject findFacilitiesOverview (String keyword, Integer listLimit)
施設の概要を取得します。

以下のすべての条件に合致する施設の概要を取得します。

  • 施設名に検索キーワードを含んでいるもの（部分一致）
  • 機能管理者の場合、ログインユーザのカレント会社の施設カテゴリに属しているもの
  • オーナーの場合、オーナー権限を保有している施設カテゴリに属しているもの
有効期間外の施設も対象となります。
検索キーワードが指定されていない場合は、施設名での絞り込みは行われません。

検索および取得の対象となる名称（施設カテゴリ名・施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

取得件数について、以下の場合は無制限として扱われます。
  • 取得件数が 0 以下の場合
  • 取得件数が null の場合

なお、ログインユーザが以下のいずれかの管理者ロールを保有していない場合は例外が発生します。
  • Schedule 機能管理者
  • Schedule オーナー
パラメータ
keyword : String
施設名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityOverview[] が設定されます。
ResultObject findFacilitiesOverview (String companyCd, String keyword, Integer listLimit)
施設の概要を取得します。

以下のすべての条件に合致する施設の概要を取得します。

  • 施設名に検索キーワードを含んでいるもの（部分一致）
  • 指定された会社の施設カテゴリに属しているもの
有効期間外の施設も対象となります。
検索キーワードが指定されていない場合は、施設名での絞り込みは行われません。

検索および取得の対象となる名称（施設カテゴリ名・施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

取得件数について、以下の場合は無制限として扱われます。
  • 取得件数が 0 以下の場合
  • 取得件数が null の場合

なお、ログインユーザが以下の管理者ロールを保有していない場合は例外が発生します。
  • Collaboration 管理者
パラメータ
companyCd : String
会社コード
keyword : String
施設名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityOverview[] が設定されます。
ResultObject findFacilityByName (String filterName, Integer listLimit)
施設を取得します。

以下のすべての条件に合致する施設を取得します。

  • 施設名に検索キーワードを含んでいるもの（部分一致）
  • 機能管理者の場合、ログインユーザのカレント会社の施設カテゴリに属しているもの
  • オーナーの場合、オーナー権限を保有している施設カテゴリに属しているもの
有効期間外の施設も対象となります。
検索キーワードが指定されていない場合は、施設名での絞り込みは行われません。

検索および取得の対象となる名称（施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

取得件数について、以下の場合は無制限として扱われます。
  • 取得件数が 0 以下の場合
  • 取得件数が null の場合

なお、ログインユーザが以下のいずれかの管理者ロールを保有していない場合は例外が発生します。
  • Schedule 機能管理者
  • Schedule オーナー
パラメータ
filterName : String
施設名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityListItem[] が設定されます。
ResultObject findFacilityByName (String companyCd, String filterName, Integer listLimit)
施設を取得します。

以下のすべての条件に合致する施設を取得します。

  • 施設名に検索キーワードを含んでいるもの（部分一致）
  • 指定された会社の施設カテゴリに属しているもの
有効期間外の施設も対象となります。
検索キーワードが指定されていない場合は、施設名での絞り込みは行われません。

検索および取得の対象となる名称（施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

取得件数について、以下の場合は無制限として扱われます。
  • 取得件数が 0 以下の場合
  • 取得件数が null の場合

なお、ログインユーザが以下の管理者ロールを保有していない場合は例外が発生します。
  • Collaboration 管理者
パラメータ
companyCd : String
会社コード
filterName : String
施設名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityListItem[] が設定されます。
ResultObject findFacilityDetail (FacilityKey facilityKey)
施設詳細を取得します。
パラメータ
facilityKey : FacilityKey
施設キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityDetail が設定されます。
ResultObject findFacilityList (CategoryKey categoryKey)
施設を取得します。

以下のすべての条件に合致する施設を取得します。

  • 指定された施設カテゴリに属しているもの

有効期間外の施設も対象となります。
検索および取得の対象となる名称（施設名）は、コンテキストのロケールを使用して探索します。
該当ロケールの名称が未定義の場合は標準表示名が対象となります。
取得結果の順序は、施設名（昇順）、施設コード（昇順）となります。
該当する施設が存在しない場合は、空の配列を返却します。

なお、ログインユーザが以下のいずれかの管理者ロールを保有していない場合は例外が発生します。
  • Collaboration 管理者
  • Schedule 機能管理者
  • Schedule オーナー
パラメータ
categoryKey : CategoryKey
施設カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、FacilityListItem[] が設定されます。
ResultObject findFacility (FacilityKey facilityKey)
施設を取得します。

ここでは、参照用の施設を取得します。

パラメータ
facilityKey : FacilityKey
施設キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ReferenceFacility が設定されます。
ResultObject registerFacility (Facility facility)
施設を登録します。
パラメータ
facility : Facility
施設情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Facility が設定されます。
ResultObject updateFacility (Facility facility)
施設を更新します。
パラメータ
facility : Facility
施設情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 が設定されます。

Copyright © 2012 NTT DATA INTRAMART CORPORATION