Cisco License Manager 用 Java API リファレンス ガイド
フォルダ管理関数
フォルダ管理関数
発行日;2012/01/08 | 英語版ドキュメント(2009/10/27 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

フォルダ管理関数

addPAKsToFolder

createFolder

deleteFolder

listAllFolders

removePAKsFromFolder

renameFolder

フォルダ管理関数

この章では、次のフォルダ管理関数に関する情報を示します。

「addPAKsToFolder」

「createFolder」

「deleteFolder」

「listAllFolders」

「removePAKsFromFolder」

「renameFolder」

addPAKsToFolder

構文

IDStatus addPAKsToFolder(UserToken token, String[] pak_ids, String folder) throws RemoteException;

説明

この関数は、指定したフォルダに PAK を追加します。PAK は複数のフォルダに追加できます。PAK を 1 つのフォルダに保持することがクライアント プログラムの要件である場合は、removePAKsFromFolder() を呼び出して前のフォルダから PAK を削除します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

pak_ids

String の配列、必須

--

フォルダに追加する PAK ID の配列。

folder

String、必須

--

フォルダの名前。

 

戻り値

この関数は IDStatus オブジェクトを返します。操作が成功した場合は、エラー番号が SUCCESS になります。IDStatus には IDStatusItem の配列が含まれます。IDStatusItem は、PAK ID、エラー番号、およびエラー メッセージで構成されます。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

システムレベルのエラーが発生して操作が完了できなかったとき、IDStatus には操作全体のステータスが含まれます。IDStatus のエラー コードは SUCCESS 以外になり、エラーの原因がわかっている場合はエラー メッセージが返されます。IDStatus には、各 ID に対応する要素を持つ IDStatusItem の配列が含まれます。各 IDStatusItem には、ID、個々のステータスを示すエラー コード、およびエラー メッセージが含まれます。

createFolder

構文

Status createFolder(UserToken token, String folder) throws RemoteException;

説明

この関数は、指定した名前を持つ新しいフォルダを作成します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

folder

String、必須

x21 ~ x7A の範囲の ASCII 文字を含む最大 64 文字の文字列

フォルダの名前。

戻り値

この関数は、SUCCESS のエラー コードを含む Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、この関数は、エラー コードを含む Status オブジェクトを返します。

deleteFolder

構文

Status deleteFolder(UserToken token, String folder) throws RemoteException;

説明

この関数は、システムからフォルダを削除します。このフォルダに含まれる PAK は削除されません。これらの PAK は、別のフォルダに属していない場合、デフォルト フォルダに移動されます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

folder

String、必須

--

フォルダの名前。

戻り値

この関数は、SUCCESS のエラー コードを含む Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、この関数は、エラー コードを含む Status オブジェクトを返します。

listAllFolders

構文

IDPagingInfo listAllFolders(UserToken token,Pagination pageinfo) throws RemoteException;

説明

この関数は、ステータス、総数、およびフォルダ名の配列を含む IDPagingInfo オブジェクトを返します。

有効なオフセットと最大数を指定してページ分割オプションを設定できます。次の例は、オフセットと最大数を指定してページ分割を設定する方法を示します。

1 ページ目を取得するには、次のようにします。

Pagination p = new Pagination(0, 10)

5 ページ目を取得するには、次のようにします。

Pagination p = new Pagination(50, 10)

ページ分割せずにすべてのレコードを取得するには、次のようにします。

Pagination p = new Pagination(0, -1)

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

pageinfo

offset と max を含むページ分割オブジェクト。offset は、この関数によって取得する、最初のレコード セットからの相対的なオフセットを指定します。max は、取得するレコードの最大数を指定します。max を -1 に設定すると、値が -1 であるすべてのレコードが返されます。

戻り値

この関数はフォルダ名の文字列配列を返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、この関数は null を返します。

removePAKsFromFolder

構文

IDStatus removePAKsFromFolder(UserToken token, String[] pak_ids, String folder) throws RemoteException;

説明

この関数は、指定したフォルダから PAK を削除します。PAK が 1 つのフォルダだけに属している場合は操作が失敗します。PAK は少なくとも 1 つのフォルダに属している必要があります。インベントリから PAK を削除するには、deletePAKs() 関数を使用します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

pak_ids

String の配列、必須

--

フォルダから削除する PAK ID の配列。

folder

String、必須

--

フォルダの名前。

戻り値

この関数は IDStatus オブジェクトを返します。操作が成功した場合は、エラー コードが SUCCESS になります。IDStatus には IDStatusItem の配列が含まれます。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

操作が失敗した場合、IDStatus エラー コードは ClmErrors 以外になります。

renameFolder

構文

Status renameFolder(UserToken token, String folder, String new_name) throws RemoteException;

説明

この関数は、特定の PAK フォルダの名前を変更します。フォルダに含まれる PAK は変更されません。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

folder

String、必須

--

フォルダの現在の名前。

new_name

String、必須

--

PAK フォルダの新しい名前。

戻り値

この関数は、SUCCESS のエラー コードを含む Status オブジェクトを返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

エラーが発生した場合、この関数は、エラー コードを含む Status オブジェクトを返します。