|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Used to create an EnterpriseItems bean that is the source for a collection of BusinessObjects Enterprise objects such as reports, folders, or programs.
Method Summary | |
java.util.List |
copyTo()
Copies the elements of EnterpriseItems to an array, starting at a particular array index. |
int |
getCount()
Gets the total number of items in the collection. |
int |
getCurrentPage()
Gets the current page number. |
int |
getCurrentRangeFirstPage()
Gets the first page number of the current page range. |
int |
getCurrentRangeLastPage()
Gets the last page number of the current page range. |
int |
getEnableDefaultParent()
Gets the default parent item type used to query for BusinessObjects Enterprise objects. |
int |
getHierarchy()
Gets the active hierarchy used when querying for items. |
IInfoObjects |
getInfoobjects()
Gets an InfoObjects collection directly. |
int |
getInstances()
Gets a selection that determines whether instances are returned in a query result. |
IInfoObject |
getItem(int index)
Gets an interface to an InfoObject item using the specified index. |
java.lang.String[] |
getItemTypes()
Gets an array of plugin types to query for. |
PagingProps |
getPaging()
Gets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean. |
java.lang.String |
getParentItemID()
Gets the identifier (ID or CUID) of the parent item used to query for objects. |
java.lang.String |
getQuery()
Gets a string used to query objects directly without using properties. |
java.lang.String[] |
getSearchFields()
Gets a list of fields to search. |
java.lang.String |
getSearchText()
Gets the search string used to query for objects. |
SortProps |
getSortBy()
Gets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean. |
boolean |
isCustomQuery()
Gets a value indicating whether the query has been overwritten by a custom query. |
boolean |
isFilterByOwner()
Gets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user. |
boolean |
isFirstPage()
Gets a value indicating whether a previous page of InfoObjects is available. |
boolean |
isFirstRange()
Gets a value indicating whether a previous page range of InfoObjects is available. |
boolean |
isLastPage()
Gets a value indicating whether a next page of InfoObjects is available. |
boolean |
isLastRange()
Gets a value indicating whether a next page range of InfoObjects is available. |
void |
movePage(PagingAction action)
Moves the pager according to the movement specified by the action parameter. |
void |
setEnableDefaultParent(int enableDefaultParent)
Sets the default parent item type used to query for BusinessObjects Enterprise objects. |
void |
setFilterByOwner(boolean filterByOwner)
Sets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user. |
void |
setHierarchy(int value)
Sets the active hierarchy used when querying for items. |
void |
setInstances(int value)
Sets a selection that determines whether instances are returned in a query result. |
void |
setItemTypes(java.lang.String[] newItemTypes)
Sets an array of plugin types to query for. |
void |
setPaging(PagingProps newPaging)
Sets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean. |
void |
setParentItemID(java.lang.String newParentItemID)
Sets the identifier (ID or CUID) of the parent item used to query for objects. |
void |
setQuery(java.lang.String newCustomQuery)
Sets a custom query that is used to obtain objects directly without using properties. |
void |
setSearchFields(java.lang.String[] searchFields)
Sets a list of fields to search. |
void |
setSearchText(java.lang.String searchText)
Sets the search string used to query for objects. |
void |
setSortBy(SortProps sortBy)
Sets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean. |
Methods inherited from interface com.businessobjects.jsf.sdk.model.IItemSource |
clearPersistedState, commit, getContentChanged, getFields, getID, getIdentity, getPathToFolder, schedule, setFields, setID, setIdentity |
Method Detail |
public java.lang.String getParentItemID()
Gets the identifier (ID or CUID) of the parent item used to query for objects.
String
that specifies the identifier of the parent item used to query for objectspublic void setParentItemID(java.lang.String newParentItemID)
Sets the identifier (ID or CUID) of the parent item used to query for objects.
newParentItemID
- the identifier of the parent item used to query for objectspublic java.lang.String[] getItemTypes()
Gets an array of plugin types to query for. By default, this method returns {"All"} which specifies that all item types will be queried for.
String
that contains the plugin types to query forpublic void setItemTypes(java.lang.String[] newItemTypes)
Sets an array of plugin types to query for. If none are specified, all types are returned.
newItemTypes
- an array of type String
that contains the plugin types to query forpublic int getEnableDefaultParent()
Gets the default parent item type used to query for BusinessObjects Enterprise objects.
int
that specifies the default parent item type used to query for BusinessObjects Enterprise objectspublic void setEnableDefaultParent(int enableDefaultParent)
Sets the default parent item type used to query for BusinessObjects Enterprise objects. The int
passed to this
method must be from the DefaultParentType enumeration.
enableDefaultParent
- an int
that specifies the default parent item type used to query for BusinessObjects Enterprise objectspublic java.lang.String getSearchText()
Gets the search string used to query for objects.
String
that specifies the search string used to query for objectspublic void setSearchText(java.lang.String searchText)
Sets the search string used to query for objects.
searchText
- a String
that specifies the search string used to query for objectspublic java.lang.String[] getSearchFields()
Gets a list of fields to search.
String
that contains the list of fields to searchpublic void setSearchFields(java.lang.String[] searchFields)
Sets a list of fields to search.
searchFields
- an array of type String
that contains the list of fields to searchpublic boolean isFilterByOwner()
Gets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user.
The determination of whether the currently logged on user owns an object in the BusinessObjects Enterprise
system is based on the OwnerID field of the object represented by the EnterpriseItem bean. An owner is
generally the user who created an object in the system, or in the case of instances, the user who scheduled the job.
For example, a user who schedules a report job to be run would own the report instance created by that job. The concept
of ownership is mainly used for security purposes, whereby objects can be assigned rights that apply to the owner only.
For more information on object rights and security, see the BusinessObjects Enterprise Administrator's Guide.
boolean
that specifies whether to filter by ownerpublic void setFilterByOwner(boolean filterByOwner)
Sets a value indicating whether to query for BusinessObjects Enterprise objects owned by the user.
The determination of whether the currently logged on user owns an object in the BusinessObjects Enterprise
system is based on the OwnerID field of the object represented by the EnterpriseItem bean. An owner is
generally the user who created an object in the system, or in the case of instances, the user who scheduled the job.
For example, a user who schedules a report job to be run would own the report instance created by that job. The concept
of ownership is mainly used for security purposes, whereby objects can be assigned rights that apply to the owner only.
For more information on object rights and security, see the BusinessObjects Enterprise Administrator's Guide.
filterByOwner
- a boolean
that specifies whether to filter by ownerpublic boolean isCustomQuery()
Gets a value indicating whether the query has been overwritten by a custom query. False if the query is assembled internally.
boolean
that specifies whether the query has been overwritten by a custom querypublic SortProps getSortBy()
Gets an instance of the SortProps
class that determines how to sort through items in an EnterpriseItems bean.
SortProps
object that determines how to sort through items in an EnterpriseItems beanpublic void setSortBy(SortProps sortBy)
Sets an instance of the SortProps
class that determines how to sort through items in an EnterpriseItems bean.
sortBy
- a SortProps
object that determines how to sort through items in an EnterpriseItems beanpublic java.lang.String getQuery()
Gets a string used to query objects directly without using properties.
String
that is used to query objects directly without using propertiespublic void setQuery(java.lang.String newCustomQuery)
Sets a custom query that is used to obtain objects directly without using properties.
newCustomQuery
- a String
that is used to query objects directly without using propertiespublic int getInstances()
Gets a selection that determines whether instances are returned in a query result.
int
that specifies whether instances are returned in a query resultpublic void setInstances(int value)
Sets a selection that determines whether instances are returned in a query result. The int
passed to this
method must be from the InstanceFilter enumeration.
value
- an int
that specifies whether instances are returned in a query resultpublic int getHierarchy()
Gets the active hierarchy used when querying for items. The default value is None.
The hierarchy can be used to increase the efficiency of item queries. For example, assume you have an ItemsGrid component that is data bound to an EnterpriseItems bean representing folders, and users click on a folder to drill down into its subfolders. The internal query used to return the set of subfolders is quicker when it knows that the current hierarchy is folders and it can ignore the categories hierarchy.
int
that specifies the the Hierarchy
public void setHierarchy(int value)
Sets the active hierarchy used when querying for items. The default value is None.
The hierarchy can be used to increase the efficiency of item queries. For example, assume you have an ItemsGrid component that is data bound to an EnterpriseItems bean representing folders, and users click on a folder to drill down into its subfolders. The internal query used to return the set of subfolders is quicker when it knows that the current hierarchy is folders and it can ignore the categories hierarchy.
value
- an int
that specifies the Hierarchy
public int getCount()
Gets the total number of items in the collection.
int
that specifies the total number of items in the collectionpublic IInfoObject getItem(int index)
Gets an interface to an InfoObject item using the specified index.
index
- the index to the item to be retrieved
IInfoObject
object that represents the item indexed by the index
parameterpublic IInfoObjects getInfoobjects()
Gets an InfoObjects collection directly.
IInfoObjects
collectionpublic java.util.List copyTo()
Copies the elements of EnterpriseItems to an array, starting at a particular array index.
List
of the elements of EnterpriseItemspublic void movePage(PagingAction action)
Moves the pager according to the movement specified by the action
parameter.
The PagerButton
class provides all possible values for the movement of a pager within the ItemsGrid
component.
action
- a PagingAction
object that specifies the type of paging actionpublic void setPaging(PagingProps newPaging)
Sets an instance of the PagingProps
class that determines how to manage paging through items in an EnterpriseItems
bean.
newPaging
- a PagingProps
object that specifies how to manage pagingpublic PagingProps getPaging()
Gets an instance of the PagingProps
class that determines how to manage paging through items in an EnterpriseItems
bean.
PagingProps
object that specifies how to manage pagingpublic int getCurrentPage()
Gets the current page number. Paging must first be enabled.
int
that specifies the current page numberpublic int getCurrentRangeFirstPage()
Gets the first page number of the current page range.
int
that specifies the first page number of the current page range.public int getCurrentRangeLastPage()
Gets the last page number of the current page range.
int
that specifies the last page number of the current page range.public boolean isFirstPage()
Gets a value indicating whether a previous page of InfoObjects is available. Paging must first be enabled.
true
if there is a previous page containing InfoObjects, otherwise, false
public boolean isFirstRange()
Gets a value indicating whether a previous page range of InfoObjects is available. Paging must first be enabled.
true
if there is a previous page range containing InfoObjects, otherwise, false
public boolean isLastPage()
Gets a value indicating whether a next page of InfoObjects is available. Paging must first be enabled.
true
if there is a next page containing InfoObjects, otherwise, false
public boolean isLastRange()
Gets a value indicating whether a next page range of InfoObjects is available. Paging must first be enabled.
true
if there is a next page range containing InfoObjects, otherwise, false
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |