jp.co.intra_mart.product.collaboration.message.service

インタフェース ReceiveMessageService

public interface ReceiveMessageService

受信伝言メモに対する操作を提供するサービスです。

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

導入されたバージョン:

8.0.0

バージョン:

8.0.13

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Integer	delete(MessageKey[] keys) 受信伝言メモを削除します。
ReceivedMessageMemo	find(MessageKey key) 受信伝言メモを取得します。
ReceivePaginCollection	find(ReceiveMessageFilter receiveMessageFilter, PagingParameter target) 受信伝言メモを取得します。
List<ReadStatus>	findReadflgMap(MessageKey key) 既読情報を取得します。
Integer	updateReadStatus(MessageKey[] keys, Boolean isRead) 受信伝言メモを既読/未読に更新します。

メソッドの詳細

delete

Integer delete(MessageKey[] keys)
        throws InvalidParameterException

受信伝言メモを削除します。

送信側の伝言メモは削除しません。

パラメータ:

keys - 伝言メモキー

戻り値:

処理件数

例外:

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

find

ReceivedMessageMemo find(MessageKey key)
                  throws InvalidParameterException

受信伝言メモを取得します。

該当データがない場合、NULLを返却します。

パラメータ:

key - 伝言メモキー

戻り値:

受信伝言メモ情報

例外:

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

find

ReceivePaginCollection find(ReceiveMessageFilter receiveMessageFilter,
                            PagingParameter target)
                     throws InvalidParameterException

受信伝言メモを取得します。

指定した検索条件に該当する受信伝言メモをページ情報分取得します。
該当データがない場合、空の配列を返却します。

パラメータ:

receiveMessageFilter - 検索条件

target - ページ情報

戻り値:

受信伝言メモ情報

例外:

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

findReadflgMap

List<ReadStatus> findReadflgMap(MessageKey key)
                         throws InvalidParameterException

既読情報を取得します。

指定したメッセージコードを受信したユーザの既読情報を取得します。
該当データがない場合、空の配列を返却します。

パラメータ:

key - MessageKey メッセージコード

戻り値:

既読情報リスト

例外:

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

updateReadStatus

Integer updateReadStatus(MessageKey[] keys,
                         Boolean isRead)
                  throws InvalidParameterException

受信伝言メモを既読/未読に更新します。

パラメータ:

keys - 伝言メモキー

isRead - true : 既読 / false : 未読

戻り値:

処理件数

例外:

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