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

インタフェース AdminTitleFixedSentenceService

public interface AdminTitleFixedSentenceService

タイトル定型文に対する管理操作を提供するサービスです。

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

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

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

[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なタイトル定型文は、認可で許可された会社のタイトル定型文に限ります。

[ Message機能管理者の場合 ]
Message機能管理者として操作可能なタイトル定型文は、操作ユーザのカレント組織の会社に一致するタイトル定型文に限ります。

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Integer	changeSort(TemplateKey key, Integer toSort) タイトル定型文の表示順序を更新します。
Integer	delete(TemplateKey[] keys) タイトル定型文を削除します。
FixedSentence	find(TemplateKey key) タイトル定型文を取得します。
FixedSentenceListItem[]	findList() タイトル定型文を取得します。
FixedSentenceListItem[]	findList(String companyCd) タイトル定型文を取得します。
FixedSentence	register(FixedSentence sentence) タイトル定型文を登録します。
FixedSentence	register(String companyCd, FixedSentence sentence) タイトル定型文を登録します。
Integer	update(FixedSentence sentence) タイトル定型文を更新します。

メソッドの詳細

changeSort

Integer changeSort(TemplateKey key,
                   Integer toSort)
            throws InvalidParameterException,
                   AuthenticationException

タイトル定型文の表示順序を更新します。

パラメータ:

key - 移動元のタイトル定型文キー

toSort - 移動先の表示順位置

戻り値:

処理件数

例外:

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

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

delete

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

タイトル定型文を削除します。

パラメータ:

keys - タイトル定型文キー

戻り値:

処理件数

例外:

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

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

find

FixedSentence find(TemplateKey key)
            throws InvalidParameterException,
                   AuthenticationException

タイトル定型文を取得します。

パラメータ:

key - タイトル定型文キー

戻り値:

タイトル定型文情報

例外:

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

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

findList

FixedSentenceListItem[] findList()
                          throws AuthenticationException

タイトル定型文を取得します。

操作ユーザが操作できるすべてのタイトル定型文を取得します

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

• Message機能管理者

戻り値:

タイトル定型文情報

例外:

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

findList

FixedSentenceListItem[] findList(String companyCd)
                          throws AuthenticationException

タイトル定型文を取得します。

指定した会社に該当するタイトル定型文を取得します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

• Collaboration管理者

パラメータ:

companyCd - 会社コード

戻り値:

タイトル定型文情報

例外:

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

register

FixedSentence register(FixedSentence sentence)
                throws InvalidParameterException,
                       AuthenticationException

タイトル定型文を登録します。

操作ユーザのカレント組織の会社のタイトル定型文として登録します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

• Message機能管理者

パラメータ:

sentence - タイトル定型文情報

戻り値:

登録したタイトル定型文情報

例外:

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

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

register

FixedSentence register(String companyCd,
                       FixedSentence sentence)
                throws InvalidParameterException,
                       AuthenticationException

タイトル定型文を登録します。

指定した会社のタイトル定型文として登録します。

[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。

• Collaboration機能管理者

パラメータ:

companyCd - 会社コード

sentence - タイトル定型文情報

戻り値:

登録したタイトル定型文情報

例外:

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

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

update

Integer update(FixedSentence sentence)
        throws InvalidParameterException,
               AuthenticationException

タイトル定型文を更新します。

パラメータ:

sentence - タイトル定型文情報

戻り値:

更新したタイトル定型文情報

例外:

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

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