|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void setID(java.lang.String newId)
Sets the unique identifier for an instance of an ItemSource bean.
newId
- a String
that specifies the identifier for the ItemSource beanpublic java.lang.String getID()
Gets the unique identifier for an instance of an ItemSource bean.
String
that specifies the unique identifier for the ItemSource beanpublic IIdentity getIdentity()
Gets the Identity bean associated with this ItemSource bean. The Identity bean supplies an Enterprise session.
IIdentity
object that provides an interface to an Identity beanpublic void setIdentity(IIdentity newIdentity)
Sets the Identity bean to use with this ItemSource bean.
newIdentity
- the Identity bean to use with this ItemSource beanpublic java.lang.String[] getFields()
Gets the list of fields (InfoObject property names) to query for. If none are specified, all fields are returned.
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.
public java.util.List getPathToFolder()
Gets the path to the first parent folder of the item.
List
that specifies the path to the first parent folder of the itempublic void schedule() throws SDKException
Schedules the object(s) to run with updated properties.
Note: The scheduling components are required to use this method.
SDKException
public void commit() throws SDKException
Commit any changes made to the InfoObjects collection.
SDKException
public void clearPersistedState()
Clears the existing InfoObjects collection and query settings such as itemID and parentID.
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.
true
if the content has changed, otherwise false
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |