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

インタフェース SendMessageService

public interface SendMessageService

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

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

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Integer	delete(MessageKey[] keys) 送信伝言メモを削除します。
Integer	delete(MessageKey[] keys, Boolean isReceive) 送信伝言メモを削除します。
SendMessageMemo	find(MessageKey key) 送信伝言メモを取得します。
SendPagingCollection	find(SendMessageFilter sendMessageFilter, PagingParameter target) 送信伝言メモを取得します。
RegisterMessageMemo	register(RegisterMessageMemo messageMemo) 伝言メモを登録します。

メソッドの詳細

delete

Integer delete(MessageKey[] keys)
        throws InvalidParameterException

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

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

パラメータ:

keys - 伝言メモキー

戻り値:

処理件数

例外:

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

delete

Integer delete(MessageKey[] keys,
               Boolean isReceive)
        throws InvalidParameterException

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

ここでは受信側の伝言メモも削除することが可能です。

パラメータ:

keys - 伝言メモキー

isReceive - true : 受信側の伝言メモも削除 / false : 送信側の伝言メモのみ

戻り値:

処理件数

例外:

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

find

SendMessageMemo find(MessageKey key)
              throws InvalidParameterException

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

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

パラメータ:

key - 伝言メモキー

戻り値:

送信伝言メモ情報

例外:

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

find

SendPagingCollection find(SendMessageFilter sendMessageFilter,
                          PagingParameter target)
                   throws InvalidParameterException

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

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

パラメータ:

sendMessageFilter - 検索条件

target - ページ情報

戻り値:

送信伝言メモ情報

例外:

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

register

RegisterMessageMemo register(RegisterMessageMemo messageMemo)
                      throws InvalidParameterException

伝言メモを登録します。

パラメータ:

messageMemo - 伝言メモ情報

戻り値:

登録した伝言メモ情報

例外:

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