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

iac_schedule.UserServiceオブジェクト

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

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

操作ユーザが以下のロールを保有している場合は、アクセス権判定処理を行いません。

  • Schedule アクセス権除外ユーザ

メソッドの概要

返却値の型 メソッド名
ResultObject findUserByName (AuthzAclType type, String userNameStr, Integer listLimit)
ユーザを取得します。
ResultObject findUserByName (String userNameStr, Integer listLimit)
ユーザを取得します。
ResultObject findUser (AuthzAclType type, Array userCds)
ユーザを取得します。
ResultObject findUser (String[] userCds)
ユーザを取得します。

メソッドの詳細

ResultObject findUserByName (AuthzAclType type, String userNameStr, Integer listLimit)
ユーザを取得します。

以下のすべての条件に合致するユーザを取得します。

  • ユーザコード・ユーザ名・フリガナのいずれかに検索キーワードを含んでいるもの（前方一致）
  • システムデフォルトのタイムゾーンによる現在日時において有効なもの
  • （権限判定を行う場合のみ） コンテキストユーザがカレント組織において該当の権限を保有するもの
権限種別は、スケジュール認可を利用している場合のみ有効です。共有グループアクセス権の場合は権限種別は無視されます。
権限種別のそれぞれの動作は以下の通りです。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#WRITE WRITE の場合：登録/編集が可能かつ有効なユーザを返却します。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#READ READ の場合：登録/編集/参照が可能かつ有効なユーザを返却します。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#NONE NONE の場合：権限判定を行わず有効なユーザをすべて返却します。
権限種別にnullを指定した場合は以下の設定によって動作が異なります。
  • 設定ファイル：WEB-INF/conf/iac-schedule-config.xml
  • タグ：iac-schedule-config/authz-config/authz-type-throw-error-with-null
    • 設定がtrueの場合 : nullは不正な権限種別としてエラーとします。
    • 設定がfalseの場合 : jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#NONE NONE と同様に権限判定を行わず有効なユーザをすべて返却します。
検索キーワードが指定されていない場合は、キーワードによる絞り込みは行われません。

検索および取得の対象となる名称（ユーザ名・フリガナ）は、コンテキストのロケールを使用して探索します。
該当するユーザが存在しない場合は、空の配列を返却します。
返却値の順序は、ソートキーの昇順となります。
指定された取得件数について、以下の場合は 0 として空の配列を返却します。
  • 0 以下の場合
  • null の場合
パラメータ
type : AuthzAclType
権限種別
userNameStr : String
ユーザ名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、UserSearchResult[] が設定されます。
ResultObject findUserByName (String userNameStr, Integer listLimit)
ユーザを取得します。

以下のすべての条件に合致するユーザを取得します。

  • ユーザコード・ユーザ名・フリガナのいずれかに検索キーワードを含んでいるもの（前方一致）
  • システムデフォルトのタイムゾーンによる現在日時において有効なもの
  • （権限判定を行う場合のみ） コンテキストユーザがカレント組織において該当の権限を保有するもの
検索キーワードが指定されていない場合は、キーワードによる絞り込みは行われません。

検索および取得の対象となる名称（ユーザ名・フリガナ）は、コンテキストのロケールを使用して探索します。
該当するユーザが存在しない場合は、空の配列を返却します。
返却値の順序は、ソートキーの昇順となります。
指定された取得件数について、以下の場合は 0 として空の配列を返却します。
  • 0 以下の場合
  • null の場合
パラメータ
userNameStr : String
ユーザ名検索キーワード
listLimit : Integer
取得件数
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、UserSearchResult[] が設定されます。
ResultObject findUser (AuthzAclType type, Array userCds)
ユーザを取得します。

指定されたユーザのうち、以下のすべての条件に合致するユーザを抽出します。

  • （権限判定を行う場合のみ） コンテキストユーザがカレント組織において該当の権限を保有するもの
権限判定を行わない場合は、指定されたユーザのユーザ名の取得処理のみ行います。
権限種別は、スケジュール認可を利用している場合のみ有効です。共有グループアクセス権の場合は権限種別は無視されます。
権限種別のそれぞれの動作は以下の通りです。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#WRITE WRITE の場合：登録/編集が可能かつ有効なユーザを返却します。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#READ READ の場合：登録/編集/参照が可能かつ有効なユーザを返却します。
  • jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#NONE NONE の場合：権限判定を行わず有効なユーザをすべて返却します。
権限種別にnullを指定した場合は以下の設定によって動作が異なります。
  • 設定ファイル：WEB-INF/conf/iac-schedule-config.xml
  • タグ：iac-schedule-config/authz-config/authz-type-throw-error-with-null
    • 設定がtrueの場合 : nullは不正な権限種別としてエラーとします。
    • 設定がfalseの場合 : jp.co.intra_mart.product.collaboration.schedule.enums.AuthzAclType#NONE NONE と同様に権限判定を行わず有効なユーザをすべて返却します。

ユーザ名の取得には以下の条件を使用します。
  • コンテキストのロケールに一致するもの
  • コンテキストのタイムゾーンによる現在日時において有効なもの
ユーザ名が取得できなかった場合は、代替文字列として以下の設定値が使用されます。 
 （既定値：空文字）
該当するユーザが存在しない場合は、空の配列を返却します。

パラメータ
type : AuthzAclType
権限種別
userCds : Array
ユーザコード(String)の配列
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、UserSearchResult[] が設定されます。
ResultObject findUser (String[] userCds)
ユーザを取得します。

指定されたユーザのうち、以下のすべての条件に合致するユーザを抽出します。

  • （権限判定を行う場合のみ） コンテキストユーザがカレント組織において該当の権限を保有するもの
権限判定を行わない場合は、指定されたユーザのユーザ名の取得処理のみ行います。

ユーザ名の取得には以下の条件を使用します。
  • コンテキストのロケールに一致するもの
  • コンテキストのタイムゾーンによる現在日時において有効なもの
ユーザ名が取得できなかった場合は、代替文字列として以下の設定値が使用されます。 
 （既定値：空文字）
該当するユーザが存在しない場合は、空の配列を返却します。

パラメータ
userCds : String[]
ユーザコード
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、UserSearchResult[] が設定されます。

Copyright © 2012 NTT DATA INTRAMART CORPORATION