jp.co.intra_mart.product.collaboration.core.interfaces

インタフェース ISharedTagAdminService

既知のサブインタフェースのリスト:

SharedTagAdminService, SharedTagAdminService, SharedTagAdminService

public interface ISharedTagAdminService

機能ごとの共有タグに対する管理操作を提供するサービスです。

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

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

• Collaboration管理者ロールを持つユーザ
• 各機能の機能管理者ロールを持つユーザ

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SharedTag	add(SharedTag tag) 共有タグを追加します。
SharedTag	add(String companyCd, SharedTag tag) 共有タグを追加します。
Integer	delete(SharedTagKey[] keys) 共有タグを削除します。
SharedTag	find(SharedTagKey key) 共有タグの詳細情報を取得します。
SharedTagListItem[]	findList(SharedTagFilter filter) 共有タグを取得します。
SharedTagListItem[]	findList(String companyCd, SharedTagFilter filter) 共有タグを取得します。
Integer	update(SharedTag tag) 共有タグを更新します。

メソッドの詳細

add

SharedTag add(SharedTag tag)
       throws InvalidParameterException,
              AuthenticationException,
              OperationException

共有タグを追加します。

カレント組織の会社の共有タグとして追加します。

[ 利用可能な管理者について ]
このAPIは、機能管理者ロールをもつユーザのみ操作可能です。
またユーザコンテキストのカレント組織に所属組織情報が存在する必要があります。

パラメータ:

tag - 共有タグ情報

戻り値:

登録した共有タグ情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

add

SharedTag add(String companyCd,
              SharedTag tag)
       throws InvalidParameterException,
              AuthenticationException,
              OperationException

共有タグを追加します。

指定した会社の共有タグとして追加します。

[ 利用可能な管理者について ]
このAPIは、Collaboration管理者ロールをもつユーザのみ操作可能です。
また指定した会社コードが、認可で許可された会社である必要があります。

パラメータ:

companyCd - 会社コード

tag - 共有タグ情報

戻り値:

登録した共有タグ情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

delete

Integer delete(SharedTagKey[] keys)
        throws InvalidParameterException,
               AuthenticationException

共有タグを削除します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ:

keys - 共有タグキー

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

find

SharedTag find(SharedTagKey key)
        throws InvalidParameterException,
               AuthenticationException

共有タグの詳細情報を取得します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、ユーザコンテキストのカレント組織の会社コードに一致すること。

パラメータ:

key - 共有タグキー

戻り値:

共有タグ情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findList

SharedTagListItem[] findList(SharedTagFilter filter)
                      throws InvalidParameterException,
                             AuthenticationException

共有タグを取得します。

[ 利用可能な管理者について ]
このAPIは、機能管理者ロールをもつユーザのみ操作可能です。
また、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ:

filter - 検索条件

戻り値:

共有タグ情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findList

SharedTagListItem[] findList(String companyCd,
                             SharedTagFilter filter)
                      throws InvalidParameterException,
                             AuthenticationException

共有タグを取得します。

[ 利用可能な管理者について ]
このAPIは、Collaboration管理者ロールをもつユーザのみ操作可能です。
また、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、認可で許可された会社であること。

パラメータ:

companyCd - 会社コード

filter - 検索条件

戻り値:

共有タグ情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

update

Integer update(SharedTag tag)
        throws InvalidParameterException,
               AuthenticationException,
               OperationException

共有タグを更新します。

[ Collaboration管理者の場合 ]
Collaboration管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、認可で許可された会社であること。

[ 機能管理者の場合 ]
機能管理者として、このAPIを利用する場合、以下の条件に該当している必要があります。

• 指定した共有タグキーの会社コードが、カレント組織の会社コードに一致すること。

パラメータ:

tag - 共有タグ情報

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - ユーザオペレーション例外