ItemManager オブジェクト

ItemManagerオブジェクト
商品に関連する情報の参照、更新を行うマネージャオブジェクトです。

商品に関連する情報を操作する場合に用いる 商品情報オブジェクトの構成は以下の通りです。

なお、有効期間開始日時と有効期間終了日時をともに設定する場合は、
「有効期間開始日時 < 有効期間終了日時」を満たす必要があります。

商品情報オブジェクト
商品情報
オブジェクト
(Object)
itemCode 商品コード (String)
productModelCode 製品型番 (String)
notes 備考 (String)
terms[0..*] 期間化情報の配列 (Array) startDate 有効期間開始日時 (Date)
endDate 有効期間終了日時 (Date)
salesUnitPrice 販売単価 (Number)
purchaseUnitPrice 仕入単価 (Number)
locales 期間国際化情報 (Object) Locale ID
(ja, en等のロケールID)

(Object)
itemName 商品名 (String)
itemCaption 商品通称 (String)


商品属性に関連する情報を操作する場合に用いる 商品属性情報オブジェクトの構成は以下の通りです。
商品属性情報オブジェクト
商品属性情報
オブジェクト
(Object)
itemCode 商品コード (String)
templateCode テンプレートコード (String)
templateDetailCode テンプレート明細コード (String)
numberValue 属性数値 (Number)
locales 国際化情報 (Object) Locale ID
(ja, en等のロケールID)

(Object)
stringValue 属性文字列 (String)


商品カタログに関連する情報を操作する場合に用いる 商品カタログ情報オブジェクトの構成は以下の通りです。
商品カタログ情報オブジェクト
商品カタログ情報
オブジェクト
(Object)
itemCode 商品コード (String)
itemCatalogueCode 商品カタログコード (String)
mediaCls 媒体種類 (Number)
media 媒体 (String)
notes 備考 (String)
sortKey ソートキー (Number)


処理結果オブジェクトの構成は以下の通りです。
処理結果オブジェクト
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(失敗) (Number)
message エラー発生時のメッセージ (String)

バージョン:1.0
導入されたバージョン:5.1

コンストラクタの概要
ItemManager(String user ,String group)
コンストラクタ

メソッドの概要
Object addItem(Object item)
商品情報を新規登録します。
Object deleteCatalogue(Object catalogue)
商品カタログ情報を削除します。
Object deleteItem(Object item)
商品情報を削除します。
Object getAttributes(商品コード(String) itemCode)
指定された商品の属性情報を取得します。
Object getCatalogue(String itemCode ,String catalogueCode)
指定されたカタログ情報を返します。
Object getCatalogueMediaFileName(Object catalogue)
商品カタログの媒体が保存されてるファイルパスを取得します。
Object getCatalogues(String itemCode)
指定された商品のカタログ情報を返します。
Object getItem(String itemCode)
指定された商品コードに対する商品の情報を返します。
Object getItems([Date date])
存在する商品の情報を返します。
Object getItemsByKey(String code ,String name [,Date date])
条件に合致する商品の情報を返します。
Object removeAttribute(Object attribute)
指定された商品属性情報を削除します。
Object setAttribute(Object attribute)
商品属性情報を設定します。
Object setCatalogue(Object catalogue [,String data])
商品カタログ情報を設定します。
Object updateItem(Object item)
商品情報を更新します。

コンストラクタの詳細
ItemManager

ItemManager(String user ,String group)
コンストラクタ
パラメータ
user String ログインユーザ
group String ログイングループ

メソッドの詳細
addItem

Object addItem(Object item)

商品情報を新規登録します。
商品情報には、期間情報と期間国際化情報を設定してください。
もし設定されてないものがある場合は、 処理失敗となります。

商品の期間は、途切れることができません。
期間に途切れがある場合は、 処理失敗となります。
パラメータ
item Object 商品情報オブジェクト
返却値
Object 処理結果オブジェクト

deleteCatalogue

Object deleteCatalogue(Object catalogue)

商品カタログ情報を削除します。
指定されたカタログ情報が存在しない場合は 処理失敗となります。
パラメータ
catalogue Object 商品カタログ情報オブジェクト
返却値
Object 処理結果オブジェクト

deleteItem

Object deleteItem(Object item)

商品情報を削除します。
指定された商品情報が存在しない場合は 処理失敗となります。
パラメータ
item Object 商品情報オブジェクト
返却値
Object 処理結果オブジェクト

getAttributes

Object getAttributes(商品コード(String) itemCode)

指定された商品の属性情報を取得します。
パラメータ
itemCode 商品コード(String)
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品属性情報オブジェクト の一覧 (Array)
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

getCatalogue

Object getCatalogue(String itemCode ,String catalogueCode)

指定されたカタログ情報を返します。
パラメータ
itemCode String カタログ情報を指定する商品コード
catalogueCode String カタログ情報を指定するカタログコード
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品カタログ情報オブジェクト
(該当データが存在しない場合はnull が返却されます。)

getCatalogueMediaFileName

Object getCatalogueMediaFileName(Object catalogue)

商品カタログの媒体が保存されてるファイルパスを取得します。

商品カタログの媒体種類がファイルの時のみ有効です。
ファイルパスの区切りは'/'です。
媒体種類がファイル以外の時はnullを返します。
パラメータ
catalogue Object 商品カタログ情報オブジェクト
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品カタログの媒体が保存されているファイルパス(String)
媒体種類がファイル以外の時はnullを返します。

getCatalogues

Object getCatalogues(String itemCode)

指定された商品のカタログ情報を返します。
パラメータ
itemCode String 商品カタログ情報の一覧を指定する商品コード
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品カタログ情報オブジェクト の一覧 (Array)
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

getItem

Object getItem(String itemCode)

指定された商品コードに対する商品の情報を返します。
パラメータ
itemCode String 商品情報を指定する商品コード
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品情報オブジェクト
(該当データが存在しない場合はnull が返却されます。)

getItems

Object getItems([Date date])

存在する商品の情報を返します。
パラメータ
date Date 商品情報を指定する日付(省略可能)
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品情報オブジェクト の一覧 (Array)
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

getItemsByKey

Object getItemsByKey(String code ,String name [,Date date])

条件に合致する商品の情報を返します。

検索キーは、コードは商品コード、製品型番に対して使用されます。名称は商品名、商品略称に対して使用されます。
パラメータ
code String 商品コード、製品コードを指定する検索キー
name String 商品名、商品通称を指定する検索キー
date Date 商品情報を指定する日付(省略可能)
返却値
Object 処理結果オブジェクト

処理結果オブジェクトの構成は以下のとおりです。
処理結果
オブジェクト
(Object)
error true(失敗) or false(成功) (Boolean)
code 0(成功) or -1(処理失敗) or -2(引数オブジェクト不正) (Number)
message エラー発生時のメッセージ (String)
data 商品情報オブジェクト の一覧 (Array)
(該当データが存在しない場合は要素数 0 の Array が返却されます。)

removeAttribute

Object removeAttribute(Object attribute)

指定された商品属性情報を削除します。
指定された属性情報が存在しない場合は 処理失敗となります。
パラメータ
attribute Object 商品属性情報オブジェクト
返却値
Object 処理結果オブジェクト

setAttribute

Object setAttribute(Object attribute)

商品属性情報を設定します。

指定された商品属性情報が存在しない場合は新規登録します。商品属性情報すでに存在する場合は更新を行います。

このメソッドでは、複数の商品属性テンプレートの属性情報を設定することはできません。 もし登録済みのものとは異なる商品属性テンプレートの属性情報が指定された場合は、 処理失敗となります。
パラメータ
attribute Object 商品属性情報オブジェクト
返却値
Object 処理結果オブジェクト

setCatalogue

Object setCatalogue(Object catalogue [,String data])

商品カタログ情報を設定します。
パラメータ
catalogue Object 商品カタログ情報オブジェクト
data String 商品カタログのファイルの内容(省略可能)
返却値
Object 処理結果オブジェクト

updateItem

Object updateItem(Object item)

商品情報を更新します。
商品情報には、期間情報と期間国際化情報を設定してください。
もし設定されてないものがある場合は、 処理失敗となります。

商品の期間は、途切れることができません。
期間に途切れがある場合は、処理失敗となります。
パラメータ
item Object 商品情報オブジェクト
返却値
Object 処理結果オブジェクト