com.businessobjects.jsf.sdk.model
Interface IEnterpriseItem

All Superinterfaces:
IItemSource

public interface IEnterpriseItem
extends IItemSource

A bean that is the source for a single Crystal Enterprise object such as a report, folder, or program.


Method Summary
 IInfoObject getInfoObject()
          Gets or sets the InfoObject resulting from a CMS query, or an object directly set on the component.
 java.lang.String getItemID()
          Gets the InfoStore ID of the object to be retrieved.
 int getReportServerType()
          Gets the type of report server used to obtain the Crystal Enterprise object.
 java.lang.Object getReportSource()
          Gets the ReportSource object that represents the contents of a report.
 java.lang.Object getReportSource(int serverType)
          Gets the ReportSource object that represents the contents of a report.
 void setInfoObject(IInfoObject object)
          Sets the InfoObject resulting from a CMS query, or an object directly set on the component.
 void setItemID(java.lang.String itemID)
          Sets the InfoStore ID of the object to be retrieved.
 void setReportServerType(int serverType)
          Sets the default server type that determines which server to use (Page Server or RAS) to obtain a ReportSource object.
 
Methods inherited from interface com.businessobjects.jsf.sdk.model.IItemSource
clearPersistedState, commit, getContentChanged, getFields, getID, getIdentity, getPathToFolder, schedule, setFields, setID, setIdentity
 

Method Detail

getItemID

public java.lang.String getItemID()

Gets the InfoStore ID of the object to be retrieved.

Returns:
a String that specifies the InfoStore ID of the object to be retrieved

setItemID

public void setItemID(java.lang.String itemID)

Sets the InfoStore ID of the object to be retrieved. This value cannot be null. Either the InfoStore ID or the CUID can be used.

Parameters:
itemID - a String that specifies the InfoStore ID or CUID of the object to be retrieved

getInfoObject

public IInfoObject getInfoObject()

Gets or sets the InfoObject resulting from a CMS query, or an object directly set on the component.

Returns:
an IInfoObject object

setInfoObject

public void setInfoObject(IInfoObject object)

Sets the InfoObject resulting from a CMS query, or an object directly set on the component. This method sets the InfoObject of this EnterpriseItem bean to the passed in object. The ItemID property is also updated.


getReportSource

public java.lang.Object getReportSource(int serverType)
                                 throws SDKException

Gets the ReportSource object that represents the contents of a report. The ReportSource object is used with the viewer.

Parameters:
serverType - an int that represents the type of report server used to obtain the ReportSource
Returns:
a ReportSource object as an Object
Throws:
SDKException

getReportSource

public java.lang.Object getReportSource()
                                 throws SDKException

Gets the ReportSource object that represents the contents of a report. By default, this method gets a ReportSource object using report server type specified by using the setReportServerType method. The ReportSource object is used with the viewer.

Returns:
a ReportSource object as an Object
Throws:
SDKException

getReportServerType

public int getReportServerType()

Gets the type of report server used to obtain the Crystal Enterprise object.

Returns:
an int that represents the type of report server used

setReportServerType

public void setReportServerType(int serverType)

Sets the default server type that determines which server to use (Page Server or RAS) to obtain a ReportSource object. The default server type is Page Server.

Parameters:
serverType - an int that represents the type of report server used