jp.co.intra_mart.product.collaboration.workspace.item.opinion.service

インタフェース OpinionService

public interface OpinionService

オピニオンアイテムに対する操作を提供するサービスです。

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

[ 操作可能なアイテムについて ]
操作ユーザが操作したいアイテムのワークスペースメンバーである必要があります。

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
OpinionContribute	addContribute(OpinionContributeRegistration parameter) 意見を追加します。
Opinion	addItem(ItemKey itemKey) オピニオンアイテムを追加します。
ContributeTotals	countContribute(ItemKey itemKey) アイテム内の各異見の票数を取得します。
int	deleteContribute(ItemKey itemKey) 意見を削除します。
int	deleteItem(ItemKey itemKey) オピニオンアイテムを削除します。
OpinionContribute	findContribute(ItemKey itemKey) 意見を取得します。
List<OpinionContribute>	findContribute(ItemKey itemKey, OpinionType opinionType) 意見を取得します。
Opinion	findItem(ItemKey itemKey) オピニオンアイテムを取得します。
int	updateCloseFlag(ItemKey itemKey, boolean isClose) 意見の締め切り状態を更新します。
int	updateContribute(OpinionContributeUpdate parameter) 意見を更新します。
int	updateTheme(OpinionThemeUpdate parameter) テーマを更新します。

メソッドの詳細

addContribute

OpinionContribute addContribute(OpinionContributeRegistration parameter)
                         throws InvalidParameterException,
                                AuthenticationException,
                                OperationException

意見を追加します。

パラメータ:

parameter - オピニオン情報

戻り値:

登録したオピニオン情報

例外:

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

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

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

addItem

Opinion addItem(ItemKey itemKey)
         throws InvalidParameterException,
                AuthenticationException

オピニオンアイテムを追加します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。

• ワークスペースに対してオーナー権限を保持している
• ワークスペースのアイテム追加を許可されている

パラメータ:

itemKey - アイテムキー

戻り値:

登録したオピニオン情報

例外:

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

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

countContribute

ContributeTotals countContribute(ItemKey itemKey)
                          throws InvalidParameterException,
                                 AuthenticationException,
                                 OperationException

アイテム内の各異見の票数を取得します。

パラメータ:

itemKey - アイテムキー

戻り値:

各意見の票数情報

例外:

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

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

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

deleteContribute

int deleteContribute(ItemKey itemKey)
              throws InvalidParameterException,
                     AuthenticationException,
                     OperationException

意見を削除します。

操作ユーザの意見を削除します。

パラメータ:

itemKey - アイテムキー

戻り値:

処理件数

例外:

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

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

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

deleteItem

int deleteItem(ItemKey itemKey)
        throws InvalidParameterException,
               OperationException,
               AuthenticationException

オピニオンアイテムを削除します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。

• ワークスペースに対してオーナー権限を保持している
• アイテム登録者

パラメータ:

itemKey - アイテムキー

戻り値:

処理件数

例外:

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

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

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

findContribute

OpinionContribute findContribute(ItemKey itemKey)
                          throws InvalidParameterException,
                                 AuthenticationException,
                                 OperationException

意見を取得します。

操作ユーザの意見を取得します。
該当データがない場合、NULLを返却します。

パラメータ:

itemKey - アイテムキー

戻り値:

意見情報

例外:

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

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

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

findContribute

List<OpinionContribute> findContribute(ItemKey itemKey,
                                       OpinionType opinionType)
                                throws InvalidParameterException,
                                       AuthenticationException,
                                       OperationException

意見を取得します。

指定した意見種別に該当する意見を取得します。
該当データがない場合、空のリストを返却します。

パラメータ:

itemKey - アイテムキー

opinionType - 意見種別

戻り値:

意見情報

例外:

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

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

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

findItem

Opinion findItem(ItemKey itemKey)
          throws InvalidParameterException,
                 AuthenticationException

オピニオンアイテムを取得します。

パラメータ:

itemKey - アイテムキー

戻り値:

オピニオン情報

例外:

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

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

updateCloseFlag

int updateCloseFlag(ItemKey itemKey,
                    boolean isClose)
             throws InvalidParameterException,
                    OperationException,
                    AuthenticationException

意見の締め切り状態を更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。

• ワークスペースに対してオーナー権限を保持している
• アイテム登録者

パラメータ:

itemKey - アイテムキー

isClose - true : 締め切り / false : 締め切りを解除

戻り値:

処理件数

例外:

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

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

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

updateContribute

int updateContribute(OpinionContributeUpdate parameter)
              throws InvalidParameterException,
                     AuthenticationException,
                     OperationException

意見を更新します。

操作ユーザの意見を更新します。

パラメータ:

parameter - 意見情報

戻り値:

処理件数

例外:

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

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

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

updateTheme

int updateTheme(OpinionThemeUpdate parameter)
         throws InvalidParameterException,
                OperationException,
                AuthenticationException

テーマを更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。

• ワークスペースに対してオーナー権限を保持している
• アイテム登録者

パラメータ:

parameter - テーマ情報

戻り値:

処理件数

例外:

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

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

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