public interface AddressbookService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なアドレスブックは、認可で許可された会社のアドレスブックに限ります。
[ Addressbook機能管理者の場合 ]
Addressbook機能管理者として操作可能なアドレスブックは、操作ユーザのカレント組織の会社に一致するアドレスブックに限ります。
[ Addressbookオーナーの場合 ]
Addressbookオーナーとして操作可能なアドレスブックは、操作ユーザにオーナー設定されたアドレスブックに限ります。
修飾子とタイプ | メソッドと説明 |
---|---|
Integer |
delete(AddressbookKey addressbookKey)
アドレスブックを削除します。
|
AddressbookDisplayItem |
find(AddressbookKey addressbookKey)
アドレスブックを取得します。
|
PagingAddressbookListItems |
findList(AddressbookFilter addressbookFilter,
PagingParameter target)
アドレスブックを取得します。
|
PagingAddressbookListItems |
findList(String companyCd,
AddressbookFilter addressbookFilter,
PagingParameter target)
アドレスブックを取得します。
|
EditAddressbook |
register(EditAddressbook addressbook,
EditItemDefinition itemDefinition,
RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを登録します。
|
EditAddressbook |
register(EditAddressbook addressbook,
EditItemDefinition itemDefinition,
RegisterAdditionalItemsI[] additionalItemsI,
String companyCd)
アドレスブックを登録します。
|
Integer |
update(EditAddressbook addressbook,
EditItemDefinition itemDefinition,
RegisterAdditionalItemsI[] additionalItemsI)
アドレスブックを更新します。
|
Integer delete(AddressbookKey addressbookKey) throws InvalidParameterException, AuthenticationException
addressbookKey
- アドレスブックキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。AddressbookDisplayItem find(AddressbookKey addressbookKey) throws InvalidParameterException, AuthenticationException
addressbookKey
- アドレスブックキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。PagingAddressbookListItems findList(AddressbookFilter addressbookFilter, PagingParameter target) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当するアドレスブックをページ情報分取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
addressbookFilter
- 検索条件target
- ページ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。PagingAddressbookListItems findList(String companyCd, AddressbookFilter addressbookFilter, PagingParameter target) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当するアドレスブックをページ情報分取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
companyCd
- 会社コードaddressbookFilter
- 検索条件target
- ページ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。EditAddressbook register(EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI) throws InvalidParameterException, AuthenticationException
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
addressbook
- アドレスブック情報itemDefinition
- 項目定義情報additionalItemsI
- 独自項目定義(国際)情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。EditAddressbook register(EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI, String companyCd) throws InvalidParameterException, AuthenticationException
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
addressbook
- アドレスブック情報itemDefinition
- 項目定義情報additionalItemsI
- 独自項目定義(国際)情報companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer update(EditAddressbook addressbook, EditItemDefinition itemDefinition, RegisterAdditionalItemsI[] additionalItemsI) throws InvalidParameterException, AuthenticationException, OperationException
addressbook
- アドレスブック情報itemDefinition
- 項目定義情報additionalItemsI
- 独自項目定義(国際)情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION