WebCatalogServiceサービス

WebCatalogServiceサービスを使用して、カタログのナビゲートおよび管理を行うメソッドを提供し、XML形式でカタログ・オブジェクトを読み書きします。

列挙およびメソッドの名前	説明
ErrorDetailsLevel列挙	メソッドの有効な値のリストを指定します。
ReadObjectsReturnOptions列挙	メソッドの有効な値のリストを指定します。
copyItem()メソッド	カタログ内のある場所から別の場所へオブジェクトをコピーします。
copyItem2()メソッド	カタログからアーカイブ・ファイルを生成します。
createFolder()メソッド	カタログに新しいフォルダを作成します。
createLink()メソッド	カタログへのリンクを作成します。
deleteItem()メソッド	カタログからオブジェクトを削除します。
getItemInfo()メソッド	オブジェクトのカタログ情報を取得します。
getMaintenanceMode()メソッド	メンテナンス・モード・ステータスを取得します。
getObjectCategories()メソッド	サポートされているカテゴリをすべて取得します。
getObjectCreateList()メソッド	作成可能なオブジェクトをすべて取得します。
getObjectTypes()メソッド	サポートされているカテゴリ・オブジェクト・タイプをすべて取得します。
getSubItems()メソッド	カタログ内のオブジェクトの子サブ項目のコレクションを取得します。
getUserHomeDirPath()メソッド	ユーザーのホーム・ディレクトリ・パスを取得します。
maintenanceMode()メソッド	メンテナンスの間、カタログをロックします。
moveItem()メソッド	カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。
pasteItem2()メソッド	コピーした項目を貼り付けます。
readObjects()メソッド	カタログからオブジェクトを読み取ります。
removeFolder()メソッド	カタログからフォルダを削除します。
setItemAttributes()メソッド	指定したカタログ項目の属性フラグを設定します。
setItemProperty()メソッド	カタログ内のオブジェクトのプロパティを設定します。
setOwnership()メソッド	指定した項目の所有権を取得します。
updateCatalogItemACL()メソッド	カタログ内の項目のアクセス制御リストを更新します。
writeObjects()メソッド	オブジェクトのリストをカタログに書き込みます。

ErrorDetailsLevel列挙

ErrorDetailsLevel列挙では、WebCatalogServiceサービス内のメソッドの有効な値のリストを指定します。

「WebCatalogServiceサービス」を参照してください。

ノート:

ErrorDetailsLevelの1つの値のみが選択されます。

表9-1 ErrorDetailsLevelの列挙値

値	説明
String ErrorCode	ErrorInfo.errorCodeフィールドにデータを移入することを指定します。
String ErrorCodeAndText	ErrorInfo.errorCodeフィールドおよびErrorInfo.messageフィールドにデータを移入することを指定します。
String FullDetails	すべてのErrorInfoフィールドにデータを移入することを指定します。

ReadObjectsReturnOptions列挙

ReadObjectsReturnOptions列挙では、WebCatalogServiceサービス内のメソッドの有効な値のリストを指定します。

この列挙では、「WebCatalogServiceサービス」内のメソッドの有効な値のリストを指定します。

値	説明
String NoObject	catalogObjectフィールドおよびcatalogObjectBytesフィールドにデータを移入しないことを指定します。
String ObjectAsString	catalogObjectフィールドにはデータを移入し、catalogObjectBytesフィールドにはデータを移入しないことを指定します。
String ObjectAsBinary	catalogObjectフィールドにはデータを移入せず、catalogObjectBytesフィールドにはデータを移入することを指定します。
String ObjectAsBinaryUseMtom	catalogObjectフィールドにはデータを移入せず、catalogObjectBytesにはデータを移入し、SOAPメッセージが戻すコンテンツをMTOMを使用してエンコードすることを指定します。

copyItem()メソッド

copyItem()メソッドを使用して、カタログ内のある場所からそのカタログ内の別の場所にオブジェクトをコピーします。

シグネチャ

void copyItem(String pathSrc, String pathDest, int flagACL, String sessionID);

引数	説明
String pathSrc	カタログ内のオブジェクトへの現在のパスを指定します。
String pathDest	カタログ内のオブジェクトをコピーする場所を指定します。
int flagACL	セキュリティとともに項目をコピーするかどうかを指定します。0は、セキュリティなしで項目をコピーすることを示します。1は、セキュリティとともに項目をコピーすることを示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

copyItem2()メソッド

copyItem2()メソッドを使用して、カタログからアーカイブ・ファイルを生成します。

シグネチャ

DataHandler copyItem2(List[] path, boolean recursive, boolean permissions, boolean timestamps, boolean useMtom, String skipPath, CopyItem2Params options, String sessionID);

引数	説明
List[] path	カタログ内のアーカイブの作成元の場所を指定します。
boolean recursive	子レベルのフォルダをアーカイブに含めるかどうかを指定します。
boolean permissions	項目をセキュリティとともにコピーするかどうかを指定します。
boolean timestamps	項目のタイムスタンプを保存するかどうかを指定します。
boolean useMtom	SOAPメッセージにより戻されたコンテンツのエンコードにMTOMを使用するかどうかを指定します。
String skipPath	アーカイブ中にスキップするフォルダの場所を指定します。
CopyItem2Params options	ソース・アプリケーションを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

createFolder()メソッド

createFolder()メソッドを使用して、カタログにフォルダを作成します。

シグネチャ

void createFolder(String path, boolean createIfNotExists, boolean createIntermediateDirs, String sessionID);

引数	説明
String path	カタログ内のフォルダを作成する場所を、新しいフォルダ名を含めて指定します。
boolean createIfNotExists	TRUEに設定されている場合、カタログ内にフォルダ・オブジェクトが存在しなければ、これを作成します。FALSEに設定されている場合、フォルダ・オブジェクトがすでに存在するならば、これを再作成しません。
boolean createIntermediateDirs	TRUEに設定されている場合、中間ディレクトリが作成されます。FALSEに設定されている場合、中間ディレクトリは作成されません。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

createLink()メソッド

createLink()メソッドを使用して、カタログへのリンクを作成します。

シグネチャ

void createLink(String path, String pathTarget, boolean overwriteIfExists, String sessionID);

引数	説明
String Path	カタログ内の親オブジェクトへのパスを指定します。
String TargetPath	カタログ内で、作成するリンクが参照する場所を指定します。
boolean overwriteIfExists	TRUEに設定されている場合、カタログ内にリンクがすでに存在するならば、これをオーバーライドします。FALSEに設定されている場合、カタログ内にリンクがすでに存在するならば、これをオーバーライドしません。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

deleteItem()メソッド

deleteItem()メソッドを使用して、カタログからオブジェクトを削除します。

フォルダを削除するには、「removeFolder()メソッド」を参照してください。

シグネチャ

void deleteItem(String path, String sessionID);

引数	説明
String path	カタログ内のオブジェクトへのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getItemInfo()メソッド

getItemInfo()メソッドを使用して、オブジェクトのカタログ情報を取得します。

シグネチャ

ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);

引数	説明
String path	カタログ内のオブジェクトへのパスを指定します。
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、Oracle Analyticsは、リンクが指すオブジェクトの情報を取得します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

ItemInfo構造体のオブジェクトのカタログ情報を戻します。

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

getMaintenanceMode()メソッド

getMaintenanceMode()メソッドを使用して、メンテナンス・モード・ステータスを取得します。

シグネチャ

Boolean getMaintenanceMode(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

現在のメンテナンス・モード・ステータスを示すtrueまたはfalseの値を戻します。

「maintenanceMode()メソッド」を参照してください。

getObjectCategories()メソッド

getObjectCategories()メソッドを使用して、サポートされているカテゴリを取得します。

シグネチャ

Boolean getObjectCategories(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

サポートされているカテゴリのリストを戻します。

getObjectCreateList()メソッド

getObjectCreateList()メソッドを使用して、すべての作成可能なオブジェクトのリストを取得します。

シグネチャ

Boolean getObjectCreateList(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

作成可能なオブジェクトのリストを戻します。

getObjectTypes()メソッド

getObjectTypes()メソッドを使用して、サポートされているすべてカテゴリ・オブジェクト・タイプのリストを取得します。

シグネチャ

Boolean getObjectTypes(String sessionID);

引数	説明
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

サポートされているオブジェクト・タイプのリストを戻します。

getSubItems()メソッド

getSubItems()メソッドを使用して、カタログ内のオブジェクトの子サブ項目のコレクションを取得します。

シグネチャ

List[] getSubItems(String path, String mask, boolean resolveLinks, GetSubItemsParams options, String sessionID);

引数	説明
String path	カタログ内の親オブジェクトへのパスを指定します。
String mask	取得する子サブ項目を示すマスクを指定します。マスク文字はアスタリスク(*)です。すべての子サブ項目を取得するには、アスタリスク1つを使用します。
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、リンクが指すオブジェクトの子サブ項目の情報が取得されます。
GetSubItemsParams options	オプション。GetSubItemsParams構造体に提供するパラメータを指定します。GetSubItemsParams構造体の詳細は、「GetSubItemsParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

ItemInfo構造体の子サブ項目のコレクションを戻します。

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

getUserHomeDirPath()メソッド

getUserHomeDirPath()メソッドを使用して、ユーザーのホーム・ディレクトリ・パスを取得します。

シグネチャ

String getUserHomeDirPath(String user name, String sessionID);

引数	説明
String user name	ユーザーの名前を指定します
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

指定されたユーザーのホーム・ディレクトリのパスを返します。

maintenanceMode()メソッド

maintenanceMode()メソッドを使用して、メンテナンスの間、カタログをロックします。

シグネチャ

void maintenanceMode(boolean flag, String sessionID);

引数	説明
boolean flag	カタログをロックする場合、TRUEを設定します。
String sessionID)	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

moveItem()メソッド

moveItem()メソッドを使用して、カタログ内のオブジェクトをそのカタログ内の別の場所に移動します。

シグネチャ

void moveItem(String pathSrc, String pathDest, int flagACL, String sessionID);

引数	説明
String pathSrc	カタログ内のオブジェクトへの現在のパスを指定します。
String pathDest	カタログ内のオブジェクトを移動する場所を指定します。
int flagACL	セキュリティとともに項目を移動するかどうかを指定します。0は、セキュリティなしで項目を移動することを示します。1は、セキュリティとともに項目を移動することを示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

pasteItem2()メソッド

pasteItem2()メソッドを使用して、コピーした項目を貼り付けます。

シグネチャ

pasteItem2(Binary stream DataHandler archive, String replacePath, int flagACL, int flagOverwrite, String sessionID);

引数	説明
Binary stream DataHandler archive	戻される項目のコンテンツを文字列またはバイトとして指定します。このフィールドで指定するものは、readObjectsメソッドによって決まります。
String replacePath	コピーした項目を貼り付ける場所を指定します。
int flagACL	セキュリティとともに項目を貼り付けるかどうかを指定します。0は、セキュリティなしで項目を貼り付けることを示します。1は、セキュリティとともに項目を貼り付けることを示します。
int flagOverwrite	貼り付ける項目が既存の項目をオーバーライドするかどうかを指定します。0は、すべて置換することを示し、1は、古い項目を置換することを示し、2は、何も置換しないことを示し、3は、強制置換を示します。
int flagReplaceReferences	xmlオブジェクトのパス参照を置換するかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

readObjects()メソッド

readObjects()メソッドを使用して、カタログからオブジェクトを読み込み、CatalogObject構造体を戻します。

シグネチャ

List[] readObjects(List[] paths, boolean resolveLinks, ErrorDetailsLevel errorMode, ReadObjectsReturnOptions returnOptions, String sessionID);

引数	説明
List[] paths	カタログ内のオブジェクトの場所を指定します。
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。
ErrorDetailsLevel errorMode	CatalogObjects構造体のerrorInfoフィールドのエラー情報の量を指定します。詳細は、「CatalogObject構造体」を参照してください。
ReadObjectsReturnOptions returnOptions	有効な値のリストを指定します。詳細は、「ReadObjectsReturnOptions列挙」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

CatalogObject構造体オブジェクトの配列を戻します。

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

(無効なパスや権限が不十分であることなどにより)カタログ・オブジェクトに対する読取り操作に失敗した場合、そのオブジェクトのerrorInfoフィールドには、エラーの説明が含まれます。

removeFolder()メソッド

removeFolder()メソッドを使用して、フォルダとそのコンテンツをカタログから削除します。

フォルダとそのコンテンツ以外のオブジェクトを削除するには、「deleteItem()メソッド」を参照してください。

シグネチャ

void removeFolder(String path, boolean recursive, String sessionID);

引数	説明
String path	カタログ内のフォルダへのパスを指定します。
boolean recursive	TRUEに設定されている場合、指定したフォルダとそのコンテンツを削除します。FALSEに設定されている場合は、指定したフォルダが空の場合のみそのフォルダを削除し、空でなければ、例外メッセージを表示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

setItemAttributes()メソッド

setItemAttributes()メソッドを使用して、指定したカタログ項目の属性フラグを設定します。

シグネチャ

void setItemAttributes (List[] path, int value, int valueOff, boolean recursive, String sessionID);

引数	説明
List[] path	カタログ内のフォルダへのパスを指定します。
int value	追加する属性を指定します。次のフラグの組合せを指定します。 1 = 読取りのみ 2 = アーカイブ 4 = 非表示 8 = システム
int valueOff	削除する属性を指定します。フラグについては、前述のint valueの説明を参照してください。
boolean recursive	サブディレクトリ内の項目のプロパティを設定するかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

setItemProperty()メソッド

setItemProperty()メソッドを使用して、カタログ内のオブジェクトのプロパティを設定します。

シグネチャ

void setItemProperty(List[] path, List[] name, List[] value, boolean recursive, String sessionID);

引数	説明
List[] path	カタログ内のオブジェクトへのパスを指定します。
List[] name	設定するプロパティの名前を指定します。
List[] value	プロパティの新しい設定を指定します。
boolean recursive	サブディレクトリ内の項目のプロパティを設定するかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

setOwnership()メソッド

setOwnership()メソッドを使用して、指定した項目の所有権を取得します。

シグネチャ

void setOwnership(List[]path, Account owner, boolean recursive, String sessionID);

引数	説明
List[] path	カタログ内の所有権を取得するオブジェクトの場所を指定します。
Account owner	所有者として割り当てるアカウントを指定します。
boolean recursive	TRUEに設定されている場合、このアクションを指定したフォルダとそのコンテンツに適用します。FALSEに設定されている場合は、指定したフォルダが空の場合のみ、そのフォルダにこのアクションを適用し、空でなければ、例外メッセージを表示します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

updateCatalogItemACL()メソッド

updateCatalogItemACL()メソッドを使用して、カタログ内の項目のアクセス制御リストを更新します。

シグネチャ

void updateCatalogItemACL(List[] path, ACL acl, UpdateCatalogItemACLParams options, String sessionID);

フィールド	説明
List[] path	カタログ内のオブジェクトへのパスを指定します。
ACL acl	アクセス制御リストを指定します。詳細は、「ACL構造体」を参照してください。
UpdateCatalogItemACLParams options	追加パラメータを指定します。詳細は、「UpdateCatalogItemACLParams構造体」を参照してください。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

writeObjects()メソッド

writeObjects()メソッドを使用して、カタログにオブジェクトの配列を書き込みます。

シグネチャ

List[] writeObjects(List[] catalogObjects, boolean allowOverwrite, boolean createIntermediateDirs, ErrorDetailsLevel errorMode, String sessionID);

引数	説明
List [] catalogObjects	カタログに書き込むオブジェクトを指定します。これはCatalogObject構造体で提供されます。CatalogObject構造体の詳細は、「CatalogObject構造体」を参照してください。 オブジェクトに適用される項目プロパティの配列を除く、object.itemInfoのすべてのフィールドが無視されます。生成されるドキュメントのシグネチャは常にCOXmlDocument1となります。
boolean allowOverwrite	TRUEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされます。FALSEに設定されている場合、カタログ内にオブジェクトがすでに存在すると、これはオーバーライドされません。
boolean createIntermediateDirs	TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。
ErrorDetailsLevel errorMode	CatalogObject構造体のerrorInfoフィールドのエラー情報量を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

ErrorInfo構造体オブジェクトの配列。

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