com.businessobjects.jsf.sdk.model
Interface IEnterpriseItems

All Superinterfaces:

IItemSource

public interface IEnterpriseItems

extends IItemSource

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

getParentItemID

public java.lang.String getParentItemID()

Gets the identifier (ID or CUID) of the parent item used to query for objects.

Returns:

a String that specifies the identifier of the parent item used to query for objects.

setParentItemID

public void setParentItemID(java.lang.String newParentItemID)

Sets the identifier (ID or CUID) of the parent item used to query for objects.

Parameters:

newParentItemID - the identifier of the parent item used to query for objects.

getItemTypes

public 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.

Returns:

an array of type String that contains the plugin types to query for.

setItemTypes

public void setItemTypes(java.lang.String[] newItemTypes)

Sets an array of plugin types to query for. If none are specified, all types are returned.

Parameters:

newItemTypes - an array of type String that contains the plugin types to query for.

getEnableDefaultParent

public int getEnableDefaultParent()

Gets the default parent item type used to query for BusinessObjects Enterprise objects.

Returns:

an int that specifies the default parent item type used to query for BusinessObjects Enterprise objects.

setEnableDefaultParent

public 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.

Parameters:

enableDefaultParent - an int that specifies the default parent item type used to query for BusinessObjects Enterprise objects.

getSearchText

public java.lang.String getSearchText()

Gets the search string used to query for objects.

Returns:

a String that specifies the search string used to query for objects.

setSearchText

public void setSearchText(java.lang.String searchText)

Sets the search string used to query for objects.

Parameters:

searchText - a String that specifies the search string used to query for objects.

getSearchFields

public java.lang.String[] getSearchFields()

Gets a list of fields to search.

Returns:

an array of type String that contains the list of fields to search.

setSearchFields

public void setSearchFields(java.lang.String[] searchFields)

Sets a list of fields to search.

Parameters:

searchFields - an array of type String that contains the list of fields to search.

isFilterByOwner

public 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.

Returns:

a boolean that specifies whether to filter by owner.

setFilterByOwner

public 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.

Parameters:

filterByOwner - a boolean that specifies whether to filter by owner.

isCustomQuery

public boolean isCustomQuery()

Gets a value indicating whether the query has been overwritten by a custom query. False if the query is assembled internally.

Returns:

a boolean that specifies whether the query has been overwritten by a custom query.

getSortBy

public SortProps getSortBy()

Gets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean.

Returns:

a SortProps object that determines how to sort through items in an EnterpriseItems bean.

setSortBy

public void setSortBy(SortProps sortBy)

Sets an instance of the SortProps class that determines how to sort through items in an EnterpriseItems bean.

Parameters:

sortBy - a SortProps object that determines how to sort through items in an EnterpriseItems bean.

getQuery

public java.lang.String getQuery()

Gets a string used to query objects directly without using properties.

Returns:

a String that is used to query objects directly without using properties.

setQuery

public void setQuery(java.lang.String newCustomQuery)

Sets a custom query that is used to obtain objects directly without using properties.

Parameters:

newCustomQuery - a String that is used to query objects directly without using properties.

getInstances

public int getInstances()

Gets a selection that determines whether instances are returned in a query result.

Returns:

an int that specifies whether instances are returned in a query result.

setInstances

public 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.

Parameters:

value - an int that specifies whether instances are returned in a query result.

getHierarchy

public 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.

Returns:

an int that specifies the the Hierarchy

setHierarchy

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.

Parameters:

value - an int that specifies the Hierarchy

getCount

public int getCount()

Gets the total number of items in the collection.

Returns:

an int that specifies the total number of items in the collection.

getItem

public IInfoObject getItem(int index)

Gets an interface to an InfoObject item using the specified index.

Parameters:

index - the index to the item to be retrieved.

Returns:

an IInfoObject object that represents the item indexed by the index parameter.

getInfoobjects

public IInfoObjects getInfoobjects()

Gets an InfoObjects collection directly.

Returns:

an IInfoObjects collection.

copyTo

public java.util.List copyTo()

Copies the elements of EnterpriseItems to an array, starting at a particular array index.

Returns:

a List of the elements of EnterpriseItems.

movePage

public 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.

Parameters:

action - a PagingAction object that specifies the type of paging action

setPaging

public void setPaging(PagingProps newPaging)

Sets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean.

Parameters:

newPaging - a PagingProps object that specifies how to manage paging.

getPaging

public PagingProps getPaging()

Gets an instance of the PagingProps class that determines how to manage paging through items in an EnterpriseItems bean.

Returns:

a PagingProps object that specifies how to manage paging.

getCurrentPage

public int getCurrentPage()

Gets the current page number. Paging must first be enabled.

Returns:

an int that specifies the current page number.

getCurrentRangeFirstPage

public int getCurrentRangeFirstPage()

Gets the first page number of the current page range.

Returns:

an int that specifies the first page number of the current page range.

getCurrentRangeLastPage

public int getCurrentRangeLastPage()

Gets the last page number of the current page range.

Returns:

an int that specifies the last page number of the current page range.

isFirstPage

public boolean isFirstPage()

Gets a value indicating whether a previous page of InfoObjects is available. Paging must first be enabled.

Returns:

true if there is a previous page containing InfoObjects, otherwise, false.

isFirstRange

public boolean isFirstRange()

Gets a value indicating whether a previous page range of InfoObjects is available. Paging must first be enabled.

Returns:

true if there is a previous page range containing InfoObjects, otherwise, false.

isLastPage

public boolean isLastPage()

Gets a value indicating whether a next page of InfoObjects is available. Paging must first be enabled.

Returns:

true if there is a next page containing InfoObjects, otherwise, false.

isLastRange

public boolean isLastRange()

Gets a value indicating whether a next page range of InfoObjects is available. Paging must first be enabled.

Returns:

true if there is a next page range containing InfoObjects, otherwise, false.