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

インタフェース ISharedTagService

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

SharedTagArticleService, SharedTagService, SharedTagService

public interface ISharedTagService

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

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

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SharedTag[]	find() 共有タグを取得します。
SharedTag[]	find(String companyCd) 共有タグを取得します。
SharedTag[]	find(String companyCd, SharedTagFilter filter) 共有タグを取得します。
SharedTag[]	findMarked(String functionCd) 付与している共有タグを取得します。
SharedTagKey[]	replace(String functionCd, SharedTagKey[] tagKeys) 共有タグの付与および解除します。

メソッドの詳細

find

SharedTag[] find()

共有タグを取得します。

カレント組織の会社コードに該当する共有タグを取得します。
該当するデータがない場合、空の配列を返却します。

戻り値:

共有タグ情報

find

SharedTag[] find(String companyCd)
          throws InvalidParameterException

共有タグを取得します。

指定された会社コードに該当する共有タグを取得します。
該当するデータがない場合、空の配列を返却します。

パラメータ:

companyCd - 会社コード

戻り値:

共有タグ

例外:

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

find

SharedTag[] find(String companyCd,
                 SharedTagFilter filter)
          throws InvalidParameterException

共有タグを取得します。

指定した検索条件に該当する共有タグを取得します。
検索条件に該当するデータがない場合、空の配列を返却します。

パラメータ:

companyCd - 会社コード

filter - 検索条件

戻り値:

共有タグ情報

例外:

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

findMarked

SharedTag[] findMarked(String functionCd)
                throws InvalidParameterException

付与している共有タグを取得します。

指定した機能コードに該当する共有タグを取得します。
該当するデータがない場合、空の配列を返却します。

パラメータ:

functionCd - 機能コード

戻り値:

共有タグ情報

例外:

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

replace

SharedTagKey[] replace(String functionCd,
                       SharedTagKey[] tagKeys)
                throws InvalidParameterException,
                       AuthenticationException,
                       OperationException

共有タグの付与および解除します。

以下に一つでも該当する場合、共有タグの付与および解除ができません。

• 指定した機能コードに対して、登録可能なアクセス権を保持していない。
• 機能コードに該当する会社コードと、指定した共有タグを管理している会社が一致しない。
  

パラメータ:

functionCd - 機能コード

tagKeys - 共有タグキー

戻り値:

付与した共有タグキー

例外:

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

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

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