UserPersonalizationServiceサービス

UserPersonalizationServiceサービスを使用して、お気に入りおよびお気に入りカテゴリを管理します。

メソッド名	説明
addFavorite()メソッド	カタログ・オブジェクトをお気に入りとしてお気に入りリストに追加します。
addFavoriteCategory()メソッド	カテゴリ・オブジェクトをお気に入りマネージャに追加します。
deleteFavorite()メソッド	既存のお気に入り項目をお気に入りマネージャから削除します。
deleteFavoriteCategory()メソッド	既存のお気に入りカテゴリをお気に入りマネージャから削除します。
getFavorites()メソッド	すべての既存のお気に入り項目およびカテゴリを戻します。
updateFavorites()メソッド	すべての既存のお気に入り項目およびカテゴリを削除し、すべてのお気に入りマネージャ項目を指定のお気に入り項目のリストを使用して再生成します。
getMostRecents()メソッド	すべての最近使用した項目を戻します。

addFavorite()メソッド

addFavorite()メソッドを使用して、カタログ・オブジェクトをお気に入りとしてお気に入りリストに追加します。

シグネチャ

void addFavorite(String catalogObjectPath, String categoryPath, String sessionID);

引数	説明
String catalogObjectPath	お気に入りとして追加するカタログ・オブジェクト・パスを指定します。
String categoryPath	お気に入り項目を作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空白の場合、お気に入り項目はお気に入りマネージャにルート要素として追加されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

addFavoriteCategory()メソッド

addFavoriteCategory()メソッドを使用して、カテゴリ・オブジェクトをお気に入りマネージャに追加します。

シグネチャ

void addFavoriteCategory(String categoryName, String categoryPath, String sessionID);

引数	説明
String categoryName	お気に入りとして追加するカタログ・オブジェクト・パスを指定します。
String categoryPath	新しいカテゴリを作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空の場合、新しいカテゴリはお気に入りマネージャのルートに追加されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

deleteFavorite()メソッド

deleteFavorite()メソッドを使用して、既存のお気に入り項目をお気に入りマネージャから削除します。

シグネチャ

void deleteFavorite(String catalogObjectPath, String categoryPath, String sessionID);

引数	説明
String catalogObjectPath	お気に入り項目を削除するカテゴリ・オブジェクト・パスを指定します。
String categoryPath	お気に入り項目を削除する必要がある(お気に入りマネージャでの)カテゴリの場所を指定します。空の場合、カテゴリ・オブジェクトはすべてのカテゴリから削除されます。つまり、非お気に入りオブジェクトとマークされます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

deleteFavoriteCategory()メソッド

deleteFavoriteCategory()メソッドを使用して、既存のお気に入りカテゴリをお気に入りマネージャから削除します。

シグネチャ

void deleteFavoriteCategory(String categoryPath, String sessionID);

引数	説明
String categoryPath	削除する必要がある(お気に入りマネージャでの)カテゴリの完全パスを指定します。このパスは/rootで始まります。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getFavorites()メソッド

getFavorites()メソッドを使用して、すべての既存のお気に入り項目およびカテゴリを戻します。

シグネチャ

List[] getFavorites(String categoryPath, boolean recursive, boolean categoryOnly, String sessionID);

引数	説明
String categoryPath	お気に入り項目を作成する(お気に入りマネージャでの)カテゴリの場所を指定します。空白の場合、お気に入り項目はお気に入りマネージャにルート要素として追加されます。
Boolean recursive	子レベルのカテゴリを結果に含めるかどうかを指定します。
Boolean categoryOnly	すべてのお気に入り項目を除外してカテゴリのみを結果に含めるか、否かを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

すべての既存のお気に入り項目およびカテゴリ。

updateFavorites()メソッド

updateFavorites()メソッドを使用して、すべての既存のお気に入り項目およびカテゴリを削除し、すべてのお気に入りマネージャ項目を指定のお気に入り項目のリストを使用して再生成します。

シグネチャ

void updateFavorites(List [] favoriteItems, String sessionID);

引数	説明
List [] favoriteItems	FavoriteItem構造体(詳細は、「ForgetAccount構造体」を参照)のリストを指定します。このFavoriteItem構造体では、ItemInfo構造体(「ItemInfo構造体」を参照)を入力する必要はなく、name、pathおよびtypeの各パラメータのみが必須です。catalogPath引数は、お気に入りマネージャにカタログ・オブジェクトを追加する場合に必要です。さらに、オプションのsubItemsについては、ネストしたFavoriteItemリストを含めることができます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getMostRecents()メソッド

getMostRecents()メソッドを使用して、すべての最近使用した項目を戻します。

シグネチャ

List[] getMostRecents(UnsignedShort listType, String sessionID);

引数	説明
UnsignedShort listType	listType値は次のフラグのいずれかです。 1 = 最近更新 2 = 最近表示 3 = 頻繁に表示 4 = 最近 5 = 候補
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

MRUItemのリスト。

「MRUItem構造体」を参照してください。