com.businessobjects.jsf.sdk.model
Interface IItemSource

All Known Subinterfaces:
IEnterpriseItem, IEnterpriseItems

public interface IItemSource

The source for a BusinessObjects Enterprise object or collection of objects.


Method Summary
 void clearPersistedState()
          Clears the existing InfoObjects collection and query settings such as itemID and parentID.
 void commit()
          Commit any changes made to the InfoObjects collection.
 boolean getContentChanged()
          Returns whether the content of the ItemSource object has changed.
 java.lang.String[] getFields()
          Gets the list of fields (InfoObject property names) to query for.
 java.lang.String getID()
          Gets the unique identifier for an instance of an ItemSource bean.
 IIdentity getIdentity()
          Gets the Identity bean associated with this ItemSource bean.
 java.util.List getPathToFolder()
          Gets the path to the first parent folder of the item.
 void schedule()
          Schedules the object(s) to run with updated properties.
 void setFields(java.lang.String[] newFields)
          Sets the list of fields(InfoObject property names) to query for.
 void setID(java.lang.String newId)
          Sets the unique identifier for an instance of an ItemSource bean.
 void setIdentity(IIdentity newIdentity)
          Sets the Identity bean to use with this ItemSource bean.
 

Method Detail

setID

public void setID(java.lang.String newId)

Sets the unique identifier for an instance of an ItemSource bean.

Parameters:
newId - a String that specifies the identifier for the ItemSource bean

getID

public java.lang.String getID()

Gets the unique identifier for an instance of an ItemSource bean.

Returns:
a String that specifies the unique identifier for the ItemSource bean

getIdentity

public IIdentity getIdentity()

Gets the Identity bean associated with this ItemSource bean. The Identity bean supplies an Enterprise session.

Returns:
an IIdentity object that provides an interface to an Identity bean

setIdentity

public void setIdentity(IIdentity newIdentity)

Sets the Identity bean to use with this ItemSource bean.

Parameters:
newIdentity - the Identity bean to use with this ItemSource bean

getFields

public java.lang.String[] getFields()

Gets the list of fields (InfoObject property names) to query for. If none are specified, all fields are returned.

Returns:
the fields to query for

setFields

public void setFields(java.lang.String[] newFields)

Sets the list of fields(InfoObject property names) to query for. If none are specified, all fields are returned during a query. Generally, setting the fields improves performance since only the set fields are returned during a query.


getPathToFolder

public java.util.List getPathToFolder()

Gets the path to the first parent folder of the item.

Returns:
a List that specifies the path to the first parent folder of the item

schedule

public void schedule()
              throws SDKException

Schedules the object(s) to run with updated properties.

Note: The scheduling components are required to use this method.

SDKException

commit

public void commit()
            throws SDKException

Commit any changes made to the InfoObjects collection.

SDKException

clearPersistedState

public void clearPersistedState()

Clears the existing InfoObjects collection and query settings such as itemID and parentID.


getContentChanged

public boolean getContentChanged()

Returns whether the content of the ItemSource object has changed. A query is performed when the most updated values are required. For example, a subsequent call to getInfoObject() will result in a query being performed.

Returns:
true if the content has changed, otherwise false