public interface FacilityService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
操作ユーザが以下のロールを保有している場合は、施設に対する権限判定処理を行いません。
FacilityKey[] findAvailableFacility(FacilityKey[] facilityKeys, jp.co.intra_mart.foundation.i18n.datetime.DateTime startDate, jp.co.intra_mart.foundation.i18n.datetime.DateTime endDate) throws InvalidParameterException
指定した検索条件に該当する施設を取得します。
facilityKeys
- 施設キーstartDate
- 開始日endDate
- 終了日InvalidParameterException
- 入力項目値に不正があった場合に発生します。FacilityOverview[] findFacilities(AuthzAclType type, CategoryKey categoryKey) throws InvalidParameterException, AuthenticationException
以下のすべての条件に合致する施設の概要を取得します。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてInvalidParameterExceptionを返却します。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
type
- 権限種別categoryKey
- 施設カテゴリキーInvalidParameterException
- 指定された施設カテゴリキーおよび権限種別が不正の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設カテゴリに対して、 操作ユーザがカレント組織において該当の権限を保有していない場合に発生します。FacilityOverview[] findFacilities(AuthzAclType type, String keyword, Integer listLimit)
以下のすべての条件に合致する施設の概要を取得します。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてエラーとします。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
null
の場合type
- 権限種別keyword
- 施設名検索キーワードlistLimit
- 取得件数FacilityOverview[] findFacilitiesOverview(CategoryKey categoryKey) throws InvalidParameterException, AuthenticationException
以下のすべての条件に合致する施設の概要を取得します。
categoryKey
- 施設カテゴリキーInvalidParameterException
- 指定された施設カテゴリキーが不正の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設カテゴリに対して、 操作ユーザがカレント組織において参照可能な権限を保有していない場合に発生します。findFacilities(AuthzAclType, CategoryKey)
FacilityOverview[] findFacilitiesOverview(String keyword, Integer listLimit)
以下のすべての条件に合致する施設の概要を取得します。
null
の場合keyword
- 施設名検索キーワードlistLimit
- 取得件数findFacilities(AuthzAclType, String, Integer)
ReferenceFacility findFacility(AuthzAclType type, FacilityKey facilityKey) throws InvalidParameterException, AuthenticationException
該当する施設が存在しない場合は、null
を返却します。 権限種別は、スケジュール認可を利用している場合のみ有効です。共有グループアクセス権の場合は権限種別は無視されます。
権限種別は、スケジュール認可を利用している場合のみ有効です。共有グループアクセス権の場合は権限種別は無視されます。
権限種別のそれぞれの動作は以下の通りです。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてInvalidParameterExceptionを返却します。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
type
- 権限種別facilityKey
- 施設キーInvalidParameterException
- 指定された施設キーが不正の場合、 および該当施設がシステムデフォルトのタイムゾーンによる現在日時において有効期間外の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設の施設カテゴリに対して、 操作ユーザがカレント組織において該当の権限を保有していない場合に発生します。ReferenceFacility findFacility(FacilityKey facilityKey) throws InvalidParameterException, AuthenticationException
該当する施設が存在しない場合は、null
を返却します。
権限種別は、スケジュール認可を利用している場合のみ有効です。共有グループアクセス権の場合は権限種別は無視されます。
権限種別のそれぞれの動作は以下の通りです。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてInvalidParameterExceptionを返却します。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
facilityKey
- 施設キーInvalidParameterException
- 指定された施設キーが不正の場合、 および該当施設がシステムデフォルトのタイムゾーンによる現在日時において有効期間外の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設の施設カテゴリに対して、 操作ユーザがカレント組織において参照可能な権限を保有していない場合に発生します。findFacility(AuthzAclType, FacilityKey)
FacilityListItem[] findFacilityByName(AuthzAclType type, String filterName, Integer listLimit) throws InvalidParameterException
以下のすべての条件に合致する施設を取得します。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてInvalidParameterExceptionを返却します。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
null
の場合type
- 権限種別filterName
- 施設名検索キーワードlistLimit
- 取得件数InvalidParameterException
- 入力項目値に不正があった場合に発生します。FacilityListItem[] findFacilityByName(String filterName, Integer listLimit) throws InvalidParameterException
以下のすべての条件に合致する施設を取得します。
null
の場合filterName
- 施設名検索キーワードlistLimit
- 取得件数InvalidParameterException
- 入力項目値に不正があった場合に発生します。findFacilityByName(AuthzAclType, String, Integer)
FacilityListItem[] findFacilityList(AuthzAclType type, CategoryKey categoryKey) throws InvalidParameterException, AuthenticationException
以下のすべての条件に合致する施設を取得します。
WRITE
の場合:登録/編集が可能かつ有効な施設を返却します。READ
の場合:登録/編集/参照が可能かつ有効な施設を返却します。NONE
の場合:権限判定を行わず有効な施設をすべて返却します。null
を指定した場合は以下の設定によって動作が異なります。
true
の場合 : null
は不正な権限種別としてInvalidParameterExceptionを返却します。
false
の場合 : NONE
と同様に権限判定を行わず有効な施設をすべて返却します。
type
- 権限種別categoryKey
- 施設カテゴリキーInvalidParameterException
- 指定された施設カテゴリキーが不正の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設カテゴリに対して、 操作ユーザがカレント組織において該当の権限を保有していない場合に発生します。FacilityListItem[] findFacilityList(CategoryKey categoryKey) throws InvalidParameterException, AuthenticationException
以下のすべての条件に合致する施設を取得します。
categoryKey
- 施設カテゴリキーInvalidParameterException
- 指定された施設カテゴリキーが不正の場合に発生します。AuthenticationException
- 権限判定を行う場合で、指定された施設カテゴリに対して、 操作ユーザがカレント組織において参照可能な権限を保有していない場合に発生します。findFacilityList(AuthzAclType, CategoryKey)
Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION