jp.co.intra_mart.foundation.ticket.master

インタフェース ImTicketMasterService

public interface ImTicketMasterService

チケットマスタを管理するためのサービスインタフェースです。

導入されたバージョン:

8.0.0

バージョン:

8.0.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	addNewVersion(ImTicketMaster ticketMaster) チケットマスタの新しいバージョンを追加します。
void	deleteTicketMaster(String masterId) チケットマスタを削除します。
void	deleteTicketMaster(String masterId, int version) チケットマスタを削除します。
ImTicketMaster	getTicketMaster(String masterId) チケットマスタを取得します。
ImTicketMaster	getTicketMaster(String masterId, int version) チケットマスタを取得します。
Collection<ImTicketMaster>	getTicketMasterByCategory(String categoryId) 指定された親カテゴリ直下のチケットマスタ一覧を取得します。
void	registerTicketMaster(ImTicketMaster ticketMaster) チケットマスタを登録します。
void	updateTicketMaster(ImTicketMaster ticketMaster) チケットマスタを更新します。

メソッドの詳細

getTicketMasterByCategory

Collection<ImTicketMaster> getTicketMasterByCategory(String categoryId)

指定された親カテゴリ直下のチケットマスタ一覧を取得します。

チケットマスタ一覧の並び順は、ソート番号 (第 1 ソートキー)、チケットマスタ ID (第 2 ソートキー) の昇順となります。
該当するチケットマスタが存在しない場合は空のコレクションを返却します。

パラメータ:

categoryId - 親カテゴリ ID

戻り値:

チケットマスタ一覧

例外:

IllegalArgumentException - カテゴリ ID が null・空・空白の場合

registerTicketMaster

void registerTicketMaster(ImTicketMaster ticketMaster)
                   throws ImTicketException

チケットマスタを登録します。

パラメータ:

ticketMaster - チケットマスタ

例外:

NullPointerException - チケットマスタが null の場合

ImTicketException - 同一 ID に紐づくチケットマスタが既に存在する場合

addNewVersion

int addNewVersion(ImTicketMaster ticketMaster)
           throws ImTicketException

チケットマスタの新しいバージョンを追加します。

チケットマスタ本体の情報は引数で指定されたチケットマスタの内容で更新します。
バージョン情報は現在の最新バージョン番号 + 1 の新しいバージョン情報を生成します。

パラメータ:

ticketMaster - チケットマスタ

戻り値:

追加されたバージョン番号 (1 ～)

例外:

NullPointerException - チケットマスタが null の場合

ImTicketException - 対象のチケットマスタが存在しない場合

updateTicketMaster

void updateTicketMaster(ImTicketMaster ticketMaster)
                 throws ImTicketException

チケットマスタを更新します。

パラメータ:

ticketMaster - チケットマスタ

例外:

NullPointerException - チケットマスタが null の場合

ImTicketException - 更新対象のチケットマスタが存在しない場合

deleteTicketMaster

void deleteTicketMaster(String masterId)
                 throws ImTicketException

チケットマスタを削除します。

指定されたチケットマスタ ID に紐づくすべてのバージョンのチケットマスタを削除します。
該当のチケットマスタを使用したチケットが存在しない場合のみ削除できます。

パラメータ:

masterId - チケットマスタ ID

例外:

IllegalArgumentException - チケットマスタ ID が null・空・空白の場合

ImTicketException - 削除対象のチケットマスタが存在しない場合、チケットが存在する場合

deleteTicketMaster

void deleteTicketMaster(String masterId,
                        int version)
                 throws ImTicketException

チケットマスタを削除します。

該当のチケットマスタを使用したチケットが存在しない場合のみ削除できます。

パラメータ:

masterId - チケットマスタ ID

version - バージョン番号 (1 ～)

例外:

IllegalArgumentException - チケットマスタ ID が null・空・空白の場合、バージョン番号が 0 以下の場合

ImTicketException - 削除対象のチケットマスタが存在しない場合、チケットが存在する場合

getTicketMaster

ImTicketMaster getTicketMaster(String masterId)

チケットマスタを取得します。

指定されたチケットマスタ ID に紐づくチケットマスタの最新バージョンを取得します。
以下のいずれかの場合は null を返却します。

• 該当するチケットマスタが存在しない場合
• チケットマスタの有効なバージョン情報が存在しない場合

パラメータ:

masterId - チケットマスタ ID

戻り値:

チケットマスタ

例外:

IllegalArgumentException - チケットマスタ ID が null・空・空白の場合

getTicketMaster

ImTicketMaster getTicketMaster(String masterId,
                               int version)

チケットマスタを取得します。

指定されたチケットマスタ ID とバージョンに紐づくチケットマスタを取得します。
以下のいずれかの場合は null を返却します。

• 該当するチケットマスタが存在しない場合
• 該当するチケットマスタのバージョン情報が存在しない場合
• 該当するチケットマスタのバージョン情報が無効の場合

パラメータ:

masterId - チケットマスタ ID

version - バージョン番号 (1 ～)

戻り値:

チケットマスタ

例外:

IllegalArgumentException - チケットマスタ ID が null・空・空白の場合、バージョン番号が 0 以下の場合