EnterpriseItems Bean

この Managed Bean は、複数のレポートやフォルダ、プログラムなどの BusinessObjects Enterprise オブジェクトのコレクションのソースです。この Bean は、UI コンポーネントへの情報の提供と機能の追加を行います。

核となる BusinessObjects Enterprise の機能とアプリケーション開発に関する詳細は、BusinessObjects Enterprise Java SDK ガイドを参照してください。

次のリンクをクリックして、目的の節に移動してください。

• 概要
• faces-config.xml 宣言の例

概要

EnterpriseItem Bean は、BusinessObjects Enterprise オブジェクト コレクションのソースであり、ページ上のオブジェクトのコレクションを表すのに使用します。コレクションを BusinessObjects Enterprise システムに対して照会するには、分離コード ファイルにクエリー文字列を記述します。これらのクエリー文字列を作成する方法は、EnterpriseItem Bean の場合と同様で、Bean プロパティを設定することです。BusinessObjects Enterprise クエリー言語の詳細については、『BusinessObjects Enterprise Java SDK ガイド』を参照してください。

enableDefaultParent と parentItemID は、オブジェクトの照会時に親項目を指定する重要な 2 つのプロパティです。enableDefaultParent プロパティに使用できる値は、com.businessobjects.jsf.sdk.properties.DefaultParentType クラスのフィールドです。

• None

BusinessObjects Enterprise システムのデフォルト ルート オブジェクトがオブジェクトの照会で親項目として使用されます。

• CorporateCategory

メインの BusinessObjects Enterprise 会社用カテゴリがオブジェクトの照会で親項目として使用されます。

• Custom

parentItemID プロパティで指定するカスタム親項目が親項目として使用されます。parentItemID プロパティを、オブジェクトの照会時の親項目となる項目の識別子に設定します。

• PersonalCategory

メインの BusinessObjects Enterprise 個人用カテゴリがオブジェクトの照会で親項目として使用されます。

• RootFolder

BusinessObjects Enterprise システム内のルート フォルダがオブジェクトの照会で親項目として使用されます。

• UserRootCategory

エンド ユーザー独自のルート カテゴリが親項目として使用されます。

• UserRootFolder

エンド ユーザー独自のルート フォルダが親項目として使用されます。

parentItemID では、クエリー対象となるコレクションに含まれるすべてのオブジェクトの親の ID または CUID を指定します。このプロパティの設定方法は、さまざまです。たとえば、ユーザーが一覧からあるフォルダをクリックしたとき、parentItemID プロパティを、そのフォルダの itemID プロパティ値にプログラムで設定することができます。次に、この ID を使用して、親フォルダ内にあるレポートのコレクションを照会することができます。

fields プロパティでは、照会するデータベース フィールドを定義します。このプロパティとその値の詳細については、EnterpriseItem Beanを参照してください。

itemType プロパティには、照会を行ってコレクション内に返す BusinessObjects Enterprise オブジェクトの種類（1 つまたは複数）を設定します。次に、有効な文字列（ProgIDs）の例を示します。

• All
• CrystalEnterprise.Category
• CrystalEnterprise.Analytic
• CrystalEnterprise.Excel
• CrystalEnterprise.FavoritesFolder
• CrystalEnterprise.Folder
• CrystalEnterprise.Hyperlink
• CrystalEnterprise.MyInfoView
• CrystalEnterprise.ObjectPackage
• CrystalEnterprise.PersonalCategory
• CrystalEnterprise.Pdf
• CrystalEnterprise.Program
• CrystalEnterprise.Report
• CrystalEnterprise.Rtf
• CrystalEnterprise.Shortcut
• CrystalEnterprise.Txt
• CrystalEnterprise.Webi
• CrystalEnterprise.Word

そのため、たとえば、“All”はすべてのフィールドを返すのに対して、｛"CrystalEnterprise.Report", "CrystalEnterprise.Pdf", "CrystalEnterprise.Txt"｝ は Crystal レポート、PDF、またはテキスト ファイルである項目のみを返します。

注    BusinessObjects Enterprise ProgID の詳細については、『BusinessObjects Enterprise Java SDK ガイド』を参照してください。

BusinessObjects Enterprise システムに対しワイルドカード検索を行う場合は、searchFields と searchText の両方のプロパティを併用する必要があります。searchFields プロパティには検索を行うフィールドを、searchText プロパティには検索対象となるテキストをそれぞれ設定します。たとえば、searchFields プロパティには Name を、searchText プロパティには World Sales Report をそれぞれ設定して、“World Sales Report”という名前のレポートを検索します。最適化されていて検索をお勧めできるフィールドは、次のフィールドのみです。

• SI_NAME
• SI_DESCRIPTION
• SI_PROGID
• SI_OWNER

この他に、オブジェクト コレクション照会の特定の属性を制御するプロパティがいくつかあります。ユーザーが所有している項目だけを照会する場合は、filterByOwner プロパティを True に設定します。このプロパティは、デフォルトで false に設定されています。instances プロパティでは、返されるオブジェクトのコレクションにインスタンスが含まれ、かつ、それらのインスタンスが EnterpriseItems Bean に設定されるかどうかを指定します。このプロパティは、com.businessobjects.jsf.sdk.properties.InstanceFilter クラスのフィールドに設定する必要があります。照会結果にインスタンスを含める場合は、IncludeInstances に設定し、逆に、クエリー結果からインスタンスを除外する場合は、ExcludeInstances に設定します。オブジェクトのインスタンスだけが含まれるコレクションを返す場合は、InstancesOnly に設定します。

Bean の一般属性のほかに、次の 2 つのプロパティは他のプロパティを含むクラスにアクセスします。

• sortBy プロパティ

sortBy プロパティは、EnterpriseItems Bean 内でコレクションの項目を並べ替える方法を指定するプロパティを含む、SortProps クラスのインスタンスを取得または設定します。SortProps クラスの sortField プロパティは、コレクション内の項目の並べ替えに使用するフィールドを指定し、SortProps クラスの sortDirection プロパティは、項目を英数字の昇順または降順のどちらで並べ替えるかを指定します。

注    ItemsGrid コンポーネントによって、このコンポーネントに連結されている EnterpriseItems Bean の並び替えプロパティの値が決まります。ItemsGrid コンポーネントにアタッチされている場合、手作業でデザイン時にこれらの値を EnterpriseItems Bean で変更することはできません。

• paging プロパティ

paging プロパティは、EnterpriseItems Bean によって表示される項目の一覧のページを移動する方法を指定するプロパティを含む PagingProps クラスのインスタンスを取得または設定します。ページングは、デフォルトで無効になっています。ページングを有効にし、ユーザーが複数ページにわたる項目間を移動できるようにするには、PagingProps クラスの setEnabled のメソッドを引数 True とともに使用します。各ページに表示する項目数を指定するには、pageSize プロパティを使用します。各ページに 1 度に表示される項目の数は、デフォルトで 10 です。rangeSize プロパティは、ページ範囲を定義するページ数を指定します。たとえば、setRangeSize メソッドが引数 10 とともに使用され、EnterpriseItems Bean が ItemsGrid コンポーネントに連結されていると、ユーザーは、1 ～ 10 ページの範囲のページを個々に選択し、グリッドの下部にあるページ番号ボタンを使用して移動することができます。次のページ範囲ボタンをクリックすると、範囲が 11 ～ 20 ページの番号ボタンが利用できるようになります。

注    EnterpriseItems Bean のすべてのメンバを参照するには、『BusinessObjects Enterprise の JavaServer Faces コンポーネント Java API リファレンス』の「IEnterpriseItems インターフェイス」を参照してください。

faces-config.xml 宣言の例

<managed-bean>

    <description>Source for a collection of folders.</description>

    <managed-bean-name>folders</managed-bean-name>

    <managed-bean-class>

        com.businessobjects.jsf.appcontrols.model.EnterpriseItems

    </managed-bean-class>

    <managed-bean-scope>session</managed-bean-scope>

    <managed-property>

        <property-name>parentItemID</property-name>

        <value>0</value>

    </managed-property>

</managed-bean>