付録A.1  DocumentBroker Standard GUI Development Kitで使用するプロパティ

DocumentBroker Standard GUI Development Kitで使用するプロパティの一覧を次の表に示します。

表A-1  DocumentBroker Standard GUI Development Kitで使用するプロパティ

プロパティ名称説明更新指定の省略
dmaProp_OIIDオブジェクトのOIID値が表示されます。
文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクトで使用されます。
×
esysProp_Name次に示すオブジェクトの名前,または表示名のプロパティです。
  • 文書,およびフォルダ:「名前」のプロパティを示します。
  • 文書種別マスタ:「文書種別マスタ名」のプロパティを示します。
  • 属性値マスタ:「表示名」のプロパティを示します。
指定できるバイト数は255バイトまでです。
作成時:×
 
更新時:○
edmProp_OwnerId文書,またはフォルダオブジェクトの検索時用所有者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
dbrProp_OwnerId文書,またはフォルダオブジェクトのプロパティ値取得時の所有者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
dbuUserProp_OwnerName文書,またはフォルダオブジェクトの所有者名のプロパティが表示されます。
255バイトまでの値が設定されます。
×
esysProp_CreateTime文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクト作成日時プロパティが表示されます。
表示されるのは,1970/01/01からの通算秒値,またはtime_t型の値です。
255バイトまでの値が設定されます。
×
esysProp_Creator文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクトに対する作成者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
esysProp_ModifyTime文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクトの更新日時プロパティが表示されます。
表示されるのは,1970/01/01からの通算秒値,またはtime_t型の値です。
×
esysProp_Modifier文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクトに対する更新者IDプロパティが表示されます。
255バイトまでの値が設定されます。
×
dbuUserProp_ModifierName文書,フォルダ,文書種別マスタ,属性値マスタのオブジェクトに対する更新者名プロパティが表示されます。
255バイトまでの値が設定されます。
×
dbuUserProp_ReservedUserIdフォルダオブジェクトに対するチェックアウト中ユーザIDプロパティが表示されます。
255バイトまでの値が設定されます。
×
dbuUserProp_ReservedUserNameフォルダオブジェクトに対するチェックアウト中ユーザ名プロパティが表示されます。
255バイトまでの値が設定されます。
×
esysProp_Comment文書,またはフォルダのオブジェクトに対するコメントプロパティです。
指定できるバイト数は1,024バイトまでです。
ecmProp_FolderTypeフォルダ種別が表示されます。
次の値でフォルダ種別を判断します。
  • 1:ノードフォルダ
  • 2:文書フォルダ
  • 3:公開フォルダ
×
ecmProp_FolderLevelフォルダ階層のレベルのプロパティが表示されます。
次の値で,フォルダ階層のレベルのプロパティを判断します。
  • 1:最上位フォルダ
  • 2:下位フォルダ
×
ecmProp_DocCreateFlgフォルダ下の文書の作成可否を示すプロパティが表示されます。
次の値で作成の可否を判断します。
  • 0:文書作成不可
  • 1:文書作成可
×
ecmProp_AclType文書フォルダ,または公開フォルダに対して,アクセス権限の設定方式を示すプロパティが表示されます。
次の値で文書フォルダ,または公開フォルダのアクセス権限の設定方式を判断します。
文書フォルダの場合
  • 1:個別に設定
  • 2:同じ権限を共有
公開フォルダの場合
  • 1:全員に公開
  • 2:公開範囲を限定
×
ecmProp_OpenPubACLアクセス権限の設定方式で,文書フォルダに「同じ権限を共有」,公開フォルダに「公開範囲を限定」とした場合に設定しているパブリックACLのoiid値が表示されます。
フォルダオブジェクトで使用されます。
返却値は,OIID文字列の下位52バイトです。
×
ecmProp_OpenPubACL_FULLアクセス権限の設定方式で,文書フォルダに「同じ権限を共有」,公開フォルダに「公開範囲を限定」とした場合に設定しているパブリックACLのoiid値が表示されます。
フォルダオブジェクトで使用されます。
返却値は,OIID文字列の下位133バイトです。
×
ecmProp_AclSucceed上位フォルダからのアクセス権限の継承を示すプロパティが表示されます。
次の値で,アクセス権限の継承を判断します。
  • 0:上位フォルダからのアクセス権限継承する
  • 1:上位フォルダからのアクセス権限継承しない
×
ecmProp_DocTypeOIIDフォルダ,または文書に設定されている文書種別マスタのOIIDを示すプロパティが表示されます。
返却値は,OIID文字列の下位52バイトです。
×
ecmProp_DocTypeOIID_FULLフォルダ,または文書に設定されている文書種別マスタのOIIDを示すプロパティが表示されます。
返却値は,OIID文字列の下位133バイトです。
×
ecmProp_ExtInt1フォルダ下ファイル容量制限の使用有無を示すプロパティが表示されます。
次の値で,ファイル容量制限の使用有無を判断します。
  • 0:フォルダ下容量制限を使用しない
  • 1:フォルダ下容量制限を使用する
なお,このプロパティは最上位のフォルダにだけ設定されます。
×
ecmProp_MaxCapacityフォルダ下ファイル容量制限機能する場合の最大容量(数値部分)を1~9,999の範囲で示すプロパティが表示されます。
なお,このプロパティは最上位のフォルダにだけ設定されます。
×
ecmProp_CapacityUnitフォルダ下ファイル容量制限機能する場合の最大容量(単位部分)を示すプロパティが表示されます。
「ecmProp_MaxCapacity」が示す数値に対する単位が表示されます。
次の値で,フォルダ下ファイル容量制限機能する場合の最大容量(単位部分)を判断します。
  • 2:メガバイト
  • 3:ギガバイト
  • 4:テラバイト
なお,このプロパティは最上位のフォルダにだけ設定されます。
×
ecmProp_UseCapacityフォルダ下ファイル容量制限機能する場合の使用済み容量を示すプロパティが表示されます。
なお,このプロパティは最上位のフォルダにだけ設定されます。
×
ecmProp_CHOiid文書のバージョニングオブジェクトのOIIDを示すプロパティが表示されます。
返却値は,OIID文字列の下位52バイトです。なお,関連ファイルの場合は,主ファイルのバージョニングオブジェクトのOIIDが表示されます。
×
ecmProp_CHOiid_FULL文書のバージョニングオブジェクトのOIID値を示すプロパティが表示されます。
返却値は,OIID文字列の下位133バイトです。
×
ecmProp_DocType文書の種類(一般文書,公開文書)を示すプロパティが表示されます。
次の値で文書の種類を判断します。
  • 1:一般文書
  • 2:審査・承認機能による公開文書
×
ecmProp_FileName登録されている文書のファイル名称を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
ecmProp_FileSize登録されている文書のファイルサイズ(バイト数)を示すプロパティが表示されます。×
ecmProp_ParentContainer文書が所属しているフォルダのOIID値を示すプロパティが表示されます。
返却値は,OIID文字列の下位52バイトです。
×
ecmProp_ParentContainer_FULL文書が所属しているフォルダのOIID値を示すプロパティが表示されます。
返却値は,OIID文字列の下位133バイトです。
×
ecmProp_DeleteFlag文書削除フラグ(ごみ箱の文書)を示すプロパティが表示されます。
次の値で,ごみ箱への削除状態を判断します。
  • 0:通常
  • 1:ごみ箱へ削除した状態
×
ecmProp_DeleteUserId文書削除を実行したユーザのIDを示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
ecmProp_DeleteTimeごみ箱への削除を実行した日時を示すプロパティが表示されます。
time_t型の値で表示されます。
×
ecmProp_DocNumber採番した文書番号を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
ecmProp_UserInt1~ecmProp_UserInt5ユーザプロパティです。
数値型,または日付型に使用します。
次の値で数値型,または日付型を示します。
  • 数値型の場合:INT型の数値
  • 日付型の場合:「YYYYMMDD」形式の数値
    例えば,2008年1月18日の場合,20080118と指定します。
ecmProp_UserStr1~ecmProp_UserStr5ユーザプロパティです。
文字列型に使用します。
指定できるバイト数は255バイトまでです。
ecmProp_DocTypePropInt1~ecmProp_DocTypePropInt10文書種別マスタ用プロパティ(数値)です。
数値型,または日付型に使用します。
ecmProp_DocTypePropStr1~ecmProp_DocTypePropStr10文書種別マスタ用プロパティ(文字列)です。
文字列型,またはマスタ型に使用します。
指定できるバイト数は255バイトまでです。
ecmProp_DocTypePropLongStr1~ecmProp_DocTypePropLongStr5文書種別マスタ用プロパティ(文字列)です。
文字列型に使用します。
指定できるバイト数は4,096バイトまでです。
ecmProp_DocNumProp採番に使用するプロパティ名を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
ecmProp_DocNumDelimiter採番用の区切り文字を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
ecmProp_DocNumSuffix採番の接尾辞を示すプロパティが表示されます。
文書種別マスタオブジェクトで使用されます。
255バイトまでの値が設定されます。
×
ecmProp_Level属性値マスタの階層を示すプロパティが表示されます。
255バイトまでの値が設定されます。
次の値で属性値階層の階層を判断します。
  • 1:最上位
  • 2~10:下位
×
ecmProp_DocTypePropName属性値マスタを使用する文書種別マスタ用のプロパティ名を示すプロパティが表示されます。
255バイトまでの値が設定されます。
最上位のオブジェクトにだけ設定されます。
×
ecmProp_DocTypePropCode属性値マスタの階層を示すプロパティ表示名のコード値を示すプロパティが表示されます。
255バイトまでの値が設定されます。
×
ecmProp_DocTypeParentCode上位属性値階層の属性値コードを示すプロパティが表示されます。
255バイトまでの値が設定されます。
指定例を次に示します。
A(最上位)←B←C←Dの階層を持つ場合
Bの設定値:A
Cの設定値:A-B
Dの設定値:A-B-C
自分の最上位の属性値コードから,一つ上の親コードまでを「-」で区切った属性値コードで設定されます(階層情報を持たせます)。
最上位の属性値は空白が指定されます。
×
ecmProp_SortNumber同一階層の属性値コードをソートするためのソート用の番号を示すプロパティが表示されます。
属性値マスタオブジェクトで使用されます。
×
under取得したフォルダに対して,下位フォルダの存在有無を示すプロパティが表示されます。
次の値で,下位フォルダの存在有無を判断します。
  • 0:下位フォルダは存在しない
  • 1:下位フォルダが存在する
×
esysProp_FileType文書が,主ファイルか関連ファイルかを示すフラグが表示されます。
次の値で,主ファイル,関連ファイルの別を判断します。
  • 0:主ファイル
  • 1:関連ファイル
×
esysProp_TopDVOIID_FULL関連ファイルが対応する主ファイルのバージョンオブジェクトのOIIDが表示されます。
値を次に示します。
  • 主ファイルの場合:null,または「""」空文字
  • 関連ファイルの場合:関連ファイルと関連付けられた主ファイルのバージョンオブジェクトのOIID(133桁)
×
凡例
○:更新,または省略ができます。
×:更新,または省略ができません。
-:更新,または省略の対象外です。

注※
指定できるバイト数は,文字コード種別がUTF-8の場合のバイト数です。
バイト数を確認するときは,UTF-8形式で文字列長を調べてください。