jp.co.intra_mart.foundation.ticket.repository

インタフェース ImTicketRepository

public interface ImTicketRepository

チケットのリポジトリインタフェースです。

導入されたバージョン:

8.0.0

バージョン:

8.0.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	deleteTicket(int ticketId) チケットを削除します。
boolean	existsTicketByMasterId(String masterId) チケットが存在するかどうかを判定します。
boolean	existsTicketByMasterId(String masterId, int version) チケットが存在するかどうかを判定します。
AttachmentFileInfo	getAttachmentFile(String fileId) チケットの添付ファイル情報を取得します。
Collection<Integer>	getExistingId(int... ticketIds) 存在するチケット ID を取得します。
ImTicketInfo	getTicket(int ticketId) チケット情報を取得します。
int	registerTicket(ImTicketInfo ticket) チケットを登録します。
void	updateTicket(ImTicketInfo ticket) チケットを更新します。

メソッドの詳細

getTicket

ImTicketInfo getTicket(int ticketId)
                throws ImTicketException

チケット情報を取得します。

該当するチケットが存在しない場合は null を返却します。

パラメータ:

ticketId - チケット ID (1 ～)

戻り値:

チケット情報

例外:

IllegalArgumentException - チケット ID が 0 以下の場合

ImTicketException - カスタムフィールドのオブジェクト生成に失敗した場合

getAttachmentFile

AttachmentFileInfo getAttachmentFile(String fileId)

チケットの添付ファイル情報を取得します。

該当する添付ファイル情報が存在しない場合は null を返却します。

パラメータ:

fileId - ファイル ID

戻り値:

添付ファイル情報

例外:

NullPointerException - ファイル ID が null の場合

registerTicket

int registerTicket(ImTicketInfo ticket)
            throws ImTicketException

チケットを登録します。

パラメータ:

ticket - チケット情報

戻り値:

登録されたチケット ID (1 ～)

例外:

NullPointerException - チケットが null の場合

ImTicketException - カスタムフィールド情報の直列化に失敗した場合

updateTicket

void updateTicket(ImTicketInfo ticket)
           throws ImTicketException

チケットを更新します。

パラメータ:

ticket - チケット情報

例外:

NullPointerException - チケットが null の場合

ImTicketException - 該当するチケットが存在しない場合

deleteTicket

void deleteTicket(int ticketId)
           throws ImTicketException

チケットを削除します。

指定されたチケット ID に紐づくアプリケーション固有情報も同時に削除します。

パラメータ:

ticketId - チケット ID (1 ～)

例外:

IllegalArgumentException - チケット ID が 0 以下の場合

ImTicketException - 該当するチケットが存在しない場合

getExistingId

Collection<Integer> getExistingId(int... ticketIds)

存在するチケット ID を取得します。

指定されたチケット ID のうち、存在するチケット ID を返却します。
以下のいずれかの場合は空のリストを返却します。

• 指定されたチケット ID 一覧が null または空の場合
• 存在するチケット ID が 1 件もない場合

パラメータ:

ticketIds - 存在チェック対象のチケット ID (1 ～)

戻り値:

存在するチケット ID 一覧

例外:

IllegalArgumentException - チケット ID が 0 以下の場合

existsTicketByMasterId

boolean existsTicketByMasterId(String masterId)

チケットが存在するかどうかを判定します。

パラメータ:

masterId - チケットマスタ ID

戻り値:

存在有無 (true: 存在する / false: 存在しない)

例外:

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

existsTicketByMasterId

boolean existsTicketByMasterId(String masterId,
                               int version)

チケットが存在するかどうかを判定します。

パラメータ:

masterId - チケットマスタ ID

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

戻り値:

存在有無 (true: 存在する / false: 存在しない)

例外:

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

IllegalArgumentException - バージョン番号が 0 以下の場合