|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.businessobjects.enterprise.infoobject.InfoObject
InfoObject is the core interface for writing a BusinessObjects Enterprise object that interacts and works within the BusinessObjects Enterprise system. For the client library, this object allows for the persistence of information sent to the CMS. For the client desktop, this object defines the appearance of an object type.
| Constructor Summary | |
InfoObject()
|
|
| Method Summary | |
boolean |
equals(java.lang.Object obj)
Internal Use Only. |
Alerts |
getAlerts()
Returns a collection of Alert objects. |
java.lang.Long |
getChildrenObjects()
Specifies the number of children an object has. |
java.util.Calendar |
getCreationTime()
Stores the date and time of the object's creation. |
java.lang.String |
getCUID()
Returns the object's unique identifier within a cluster. |
java.lang.String |
getDescription()
Returns the description of the InfoObject. |
static org.apache.axis.encoding.Deserializer |
getDeserializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Internal Use Only. |
java.util.Calendar |
getEndTime()
The date and time that the instance actually finished being processed. |
java.lang.String |
getErrorMessage()
Returns a localized error message for a failed job. |
java.lang.Integer |
getID()
Returns the unique ID of an InfoObject. |
java.lang.Boolean |
getInstance()
Returns true if this object is an instance. |
java.lang.Boolean |
getInstanceObject()
A boolean value specifying whether or not the BusinessObjects Enterprise object is a
report instance that is the result of a job that has already run. |
java.lang.Boolean |
getIsApplicationObject()
Indicates whether or not the BusinessObjects Enterprise object is an application object. |
java.lang.Boolean |
getIsComponent()
The flag indicating whether the object is a package component. |
java.lang.Boolean |
getIsHiddenObject()
This property indicates whether or not an object is hidden. |
java.lang.Boolean |
getIsPluginObject()
Returns true if the InfoObject is a plugin, and false otherwise. |
java.lang.Boolean |
getIsRecurring()
Returns True if the InfoObject is a recurring instance, and False otherwise. |
java.lang.Boolean |
getIsRunnableObject()
Returns true if the report object is runnable, and false otherwise. |
java.lang.Boolean |
getIsSendable()
Indicates if the object can be sent to a destination. |
java.lang.Boolean |
getIsSystemObject()
Indicates whether or not the BusinessObjects Enterprise object is a system object. |
java.lang.String |
getKey()
Returns the unique hash code value of the InfoObject. |
java.lang.String |
getKeywords()
Returns the keyword of the InfoObject. |
java.lang.String |
getKind()
Returns the kind of the InfoObject. |
java.util.Calendar |
getLastRunTime()
This property stores the date and time when the report was last run. |
java.lang.String |
getLastSuccessfulInstanceCUID()
This property stores the ID of the last successful instance ID for the given report. |
java.lang.String |
getName()
Returns the title of the InfoObject. |
java.lang.String |
getNewJobID()
The ID of the new instance that has just been scheduled. |
java.util.Calendar |
getNextRunTime()
This property stores the date and time when the report will next be run. |
java.lang.Boolean |
getObjectIsContainer()
Returns whether the object is a folder, inbox, or category. |
java.lang.String |
getOwner()
Returns the name of the user who owns a particular object. |
java.lang.String |
getOwnerCUID()
This is a number that uniquely identifies the user who owns a particular object. |
java.lang.String |
getParentCUID()
Returns the parent object's cluster unique identifier. |
PluginInfo |
getPluginInfo()
Returns the plugin info. |
java.lang.String |
getRUID()
Returns the object's unique identifier within an object package. |
java.lang.Boolean |
getSchedulable()
Indicates whether or not the object can be scheduled. |
SecurityInfo |
getSecurityInfo()
Returns the security information for the object. |
static org.apache.axis.encoding.Serializer |
getSerializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Internal Use Only. |
java.util.Calendar |
getStartTime()
The date and time that the instance actually began being processed. |
StatusInfo |
getStatusInfo()
Returns the current status of the scheduled job. |
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Internal Use Only. |
java.lang.Integer |
getUiStatus()
The SI_UISTATUS property. |
java.util.Calendar |
getUpdateTime()
This is a time stamp property which stores the date and time the object was last modified. |
int |
hashCode()
Internal Use Only. |
void |
setAlerts(Alerts alerts)
Sets a collection of Alert objects. |
void |
setChildrenObjects(java.lang.Long childrenObjects)
Internal Use Only. |
void |
setCreationTime(java.util.Calendar creationTime)
Stores the date and time of the object's creation. |
void |
setCUID(java.lang.String CUID)
Sets the object's unique identifier within a cluster. |
void |
setDescription(java.lang.String description)
Sets the description of the InfoObject. |
void |
setEndTime(java.util.Calendar endTime)
The date and time that the instance actually finished being processed. |
void |
setErrorMessage(java.lang.String errorMessage)
Sets a localized error message for a failed job. |
void |
setID(java.lang.Integer ID)
Internal Use Only. |
void |
setInstance(java.lang.Boolean instance)
true if this object is an instance, false otherwise. |
void |
setInstanceObject(java.lang.Boolean instanceObject)
A boolean value specifying whether or not the BusinessObjects Enterprise object is a
report instance that is the result of a job that has already run. |
void |
setIsApplicationObject(java.lang.Boolean isApplicationObject)
Indicates whether or not the BusinessObjects Enterprise object is an application object. |
void |
setIsComponent(java.lang.Boolean isComponent)
The flag indicating whether the object is a package component. |
void |
setIsHiddenObject(java.lang.Boolean isHiddenObject)
This property indicates whether or not an object is hidden. |
void |
setIsPluginObject(java.lang.Boolean isPluginObject)
Sets whether the InfoObject is a plugin. |
void |
setIsRecurring(java.lang.Boolean isRecurring)
Returns True if the InfoObject is a recurring instance, and False otherwise. |
void |
setIsRunnableObject(java.lang.Boolean isRunnableObject)
Sets whether the report object is runnable. |
void |
setIsSendable(java.lang.Boolean isSendable)
Indicates if the object can be sent to a destination. |
void |
setIsSystemObject(java.lang.Boolean isSystemObject)
Indicates whether or not the BusinessObjects Enterprise object is a system object. |
void |
setKey(java.lang.String key)
Internal Use Only. |
void |
setKeywords(java.lang.String keywords)
Sets the keyword of the InfoObject. |
void |
setKind(java.lang.String kind)
Sets the kind of the InfoObject. |
void |
setLastRunTime(java.util.Calendar lastRunTime)
This property stores the date and time when the report was last run. |
void |
setLastSuccessfulInstanceCUID(java.lang.String lastSuccessfulInstanceCUID)
Internal Use Only. |
void |
setName(java.lang.String name)
Sets the title of the InfoObject. |
void |
setNewJobID(java.lang.String newJobID)
The ID of the new instance that has just been scheduled. |
void |
setNextRunTime(java.util.Calendar nextRunTime)
This property stores the date and time when the report will next be run. |
void |
setObjectIsContainer(java.lang.Boolean objectIsContainer)
Internal Use Only. |
void |
setOwner(java.lang.String owner)
Internal Use Only. |
void |
setOwnerCUID(java.lang.String ownerCUID)
This is a number that uniquely identifies the user who owns a particular object. |
void |
setParentCUID(java.lang.String parentCUID)
Sets the parent object's cluster unique identifier. |
void |
setPluginInfo(PluginInfo pluginInfo)
Sets the plugin info. |
void |
setRUID(java.lang.String RUID)
Sets the object's unique identifier within an object package. |
void |
setSchedulable(java.lang.Boolean schedulable)
Internal Use Only. |
void |
setSecurityInfo(SecurityInfo securityInfo)
Sets the security information for the object. |
void |
setStartTime(java.util.Calendar startTime)
The date and time that the instance actually began being processed. |
void |
setStatusInfo(StatusInfo statusInfo)
Sets the current status of the scheduled job. |
void |
setUiStatus(java.lang.Integer uiStatus)
The SI_UISTATUS property. |
void |
setUpdateTime(java.util.Calendar updateTime)
This is a time stamp property which stores the date and time the object was last modified. |
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public InfoObject()
| Method Detail |
public java.lang.Integer getID()
Returns the unique ID of an InfoObject.
Use the CUID of an InfoObject as the primary identifier, not this property.
public void setID(java.lang.Integer ID)
public java.lang.String getName()
Returns the title of the InfoObject.
String containing the title of the InfoObject.public void setName(java.lang.String name)
Sets the title of the InfoObject.
name - A String containing the title of the InfoObject.public java.lang.String getDescription()
Returns the description of the InfoObject.
String containing the description of the object.public void setDescription(java.lang.String description)
Sets the description of the InfoObject.
description - A String containing the description of the object.public java.lang.String getCUID()
Returns the object's unique identifier within a cluster.
public void setCUID(java.lang.String CUID)
Sets the object's unique identifier within a cluster.
CUID - A string representing the object's cluster unique identifier.public java.lang.String getRUID()
Returns the object's unique identifier within an object package.
public void setRUID(java.lang.String RUID)
Sets the object's unique identifier within an object package.
RUID - A string representing the object's package unique identifier.public java.lang.String getKind()
Returns the kind of the InfoObject.
The following values are valid:
CalendarCategoryConnectionCrystalReportEventExcelFavoritesFolderFlashFolderFullClientHyperlinkInboxLicenseKeyObjectPackageOverloadPdfPersonalCategoryPowerpointProfileProgramPublicationRtfServerServerGroupShortcutTxtUniverseUserUserGroupWebiWordXcelsius
public void setKind(java.lang.String kind)
Sets the kind of the InfoObject.
The following values are valid:
CalendarCategoryConnectionCrystalReportEventExcelFavoritesFolderFlashFolderFullClientHyperlinkInboxLicenseKeyObjectPackageOverloadPdfPersonalCategoryPowerpointProfileProgramPublicationRtfServerServerGroupShortcutTxtUniverseUserUserGroupWebiWordXcelsius
kind - The kind of the InfoObject.public java.lang.String getOwner()
Returns the name of the user who owns a particular object.
public void setOwner(java.lang.String owner)
public java.lang.String getOwnerCUID()
This is a number that uniquely identifies the user who owns a particular object. This property can be used, for example, to list all the reports and folders for a particular user.
public void setOwnerCUID(java.lang.String ownerCUID)
This is a number that uniquely identifies the user who owns a particular object. This property can be used, for example, to list all the reports and folders for a particular user.
ownerCUID - The owner ID.public java.lang.String getParentCUID()
Returns the parent object's cluster unique identifier.
public void setParentCUID(java.lang.String parentCUID)
Sets the parent object's cluster unique identifier.
parentCUID - String representing the parent object's cluster unique identifier.public java.util.Calendar getCreationTime()
Stores the date and time of the object's creation.
public void setCreationTime(java.util.Calendar creationTime)
Stores the date and time of the object's creation.
creationTime - Stores the date and time of the object's creation.public java.util.Calendar getUpdateTime()
This is a time stamp property which stores the date and time the object was last modified.
An object is considered modified when any one of its properties are changed. Note that modifications to an object's properties are not propagated to the instances of the object. For example, if a report object is modified, its SI_UPDATE_TS Property contains the time value of the most recent change. However, the SI_UPDATE_TS Property does not change for the instances of the report object.
public void setUpdateTime(java.util.Calendar updateTime)
This is a time stamp property which stores the date and time the object was last modified.
An object is considered modified when any one of its properties are changed. Note that modifications to an object's properties are not propagated to the instances of the object. For example, if a report object is modified, its SI_UPDATE_TS Property contains the time value of the most recent change. However, the SI_UPDATE_TS Property does not change for the instances of the report object.
updateTime - This is a time stamp property which stores the date and time the object was last modified.public java.lang.String getKeywords()
Returns the keyword of the InfoObject.
String containing the keyword of the object.public void setKeywords(java.lang.String keywords)
Sets the keyword of the InfoObject.
keywords - A String containing the keyword of the object.public java.lang.Long getChildrenObjects()
Specifies the number of children an object has.
The SI_CHILDREN property is a numeric value specifying how many children a particular object has. In the case of a folder, this may be subfolders, reports, or other objects. If the object is a report, this number will represent the number of instances the report owns. Note that this value only represents the number of direct children: it does not, for instance, indicate how many grandchildren an object may have.
public void setChildrenObjects(java.lang.Long childrenObjects)
public java.lang.Boolean getInstance()
Returns true if this object is an instance. This method is used to check whether or not the InfoObject is an instance.
true if this object is an instance, false otherwise.public void setInstance(java.lang.Boolean instance)
true if this object is an instance, false otherwise.
instance - true if this object is an instance, false otherwise.public java.lang.Boolean getObjectIsContainer()
Returns whether the object is a folder, inbox, or category.
true if the object is a folder, inbox, or category, false otherwise.public void setObjectIsContainer(java.lang.Boolean objectIsContainer)
public java.lang.Boolean getIsHiddenObject()
This property indicates whether or not an object is hidden.
Note: It is recommended that you do not directly change the settings for this property.
public void setIsHiddenObject(java.lang.Boolean isHiddenObject)
This property indicates whether or not an object is hidden.
Note: It is recommended that you do not directly change the settings for this property.
isHiddenObject - This property indicates whether or not an object is hidden.public java.lang.Boolean getIsSystemObject()
Indicates whether or not the BusinessObjects Enterprise object is a system object.
public void setIsSystemObject(java.lang.Boolean isSystemObject)
Indicates whether or not the BusinessObjects Enterprise object is a system object.
isSystemObject - Indicates whether or not the BusinessObjects Enterprise object is a system object.public java.lang.Boolean getIsRunnableObject()
Returns true if the report object is runnable, and false otherwise.
An instance may be runnable (it is scheduled to run and create another instance), or it may not be runnable (it is the result of a job that has already run).
true if the report object is runnable, and false otherwise.public void setIsRunnableObject(java.lang.Boolean isRunnableObject)
Sets whether the report object is runnable.
isRunnableObject - Sets whether the report object is runnable.public java.lang.Boolean getIsPluginObject()
Returns true if the InfoObject is a plugin, and false otherwise.
true if the InfoObject is a plugin, and false otherwise.public void setIsPluginObject(java.lang.Boolean isPluginObject)
Sets whether the InfoObject is a plugin.
isPluginObject - Sets whether the InfoObject is a plugin.public java.lang.Boolean getInstanceObject()
A boolean value specifying whether or not the BusinessObjects Enterprise object is a
report instance that is the result of a job that has already run.
An instance may be runnable (it is scheduled to run and create another instance), or it may not be runnable (it is the result of a job that has already run).
boolean value specifying whether or not the BusinessObjects Enterprise object is a report instance that is the result of a job that has already run.public void setInstanceObject(java.lang.Boolean instanceObject)
A boolean value specifying whether or not the BusinessObjects Enterprise object is a
report instance that is the result of a job that has already run.
An instance may be runnable (it is scheduled to run and create another instance), or it may not be runnable (it is the result of a job that has already run).
instanceObject - A boolean value specifying whether or not the BusinessObjects Enterprise object is a report instance that is the result of a job that has already run.public java.lang.Boolean getIsApplicationObject()
Indicates whether or not the BusinessObjects Enterprise object is an application object.
public void setIsApplicationObject(java.lang.Boolean isApplicationObject)
Indicates whether or not the BusinessObjects Enterprise object is an application object.
isApplicationObject - Indicates whether or not the BusinessObjects Enterprise object is an application object.public java.lang.Boolean getIsComponent()
The flag indicating whether the object is a package component.
public void setIsComponent(java.lang.Boolean isComponent)
The flag indicating whether the object is a package component.
isComponent - The flag indicating whether the object is a package component.public java.lang.Boolean getSchedulable()
Indicates whether or not the object can be scheduled.
true if the object can be scheduled, false otherwise.public void setSchedulable(java.lang.Boolean schedulable)
public java.lang.Integer getUiStatus()
public void setUiStatus(java.lang.Integer uiStatus)
uiStatus - The SI_UISTATUS property.public java.lang.Boolean getIsRecurring()
Returns True if the InfoObject is a recurring instance, and False otherwise. An instance that is recurring is also runnable. However, a runnable instance may not be recurring.
public void setIsRecurring(java.lang.Boolean isRecurring)
Returns True if the InfoObject is a recurring instance, and False otherwise. An instance that is recurring is also runnable. However, a runnable instance may not be recurring.
isRecurring - Returns True if the InfoObject is a recurring instance, and False otherwise.public java.lang.String getLastSuccessfulInstanceCUID()
This property stores the ID of the last successful instance ID for the given report.
public void setLastSuccessfulInstanceCUID(java.lang.String lastSuccessfulInstanceCUID)
public java.util.Calendar getLastRunTime()
This property stores the date and time when the report was last run.
public void setLastRunTime(java.util.Calendar lastRunTime)
This property stores the date and time when the report was last run.
lastRunTime - This property stores the date and time when the report was last run.public java.lang.Boolean getIsSendable()
Indicates if the object can be sent to a destination.
public void setIsSendable(java.lang.Boolean isSendable)
Indicates if the object can be sent to a destination.
isSendable - Indicates if the object can be sent to a destination.public java.util.Calendar getNextRunTime()
This property stores the date and time when the report will next be run.
public void setNextRunTime(java.util.Calendar nextRunTime)
This property stores the date and time when the report will next be run.
nextRunTime - This property stores the date and time when the report will next be run.public java.lang.String getNewJobID()
The ID of the new instance that has just been scheduled.
The SI_NEW_JOB_ID property is available immediately after an InfoObjects collection is
scheduled, and it remains available as long as reference to the collection or the InfoObject
is retained. This property is not accessible by querying the InfoStore object.
This property is only applicable to InfoObjects that can be scheduled (for example, report objects).
SI_NEW_JOB_ID property is
the SI_ID of the new instance object that is created.
SI_NEW_JOB_ID property is the
SI_ID of the new recurrence parent object that is created. (The 'recurrence parent object'
is a copy of the original InfoObject and is the object from which the recurring instances
are created.)
It is possible to access the SI_NEW_JOB_ID property after the scheduling of an InfoObjects
collection. However, when processing of the JSP file is completed, the reference to InfoObjs
is lost (falls out of scope) and the SI_NEW_JOB_ID property will no longer be accessible.
Further, it will not be possible to access the property on a subsequent JSP page by querying
the InfoStore object again, even if the query returns the same InfoObjects collection.
After an InfoObject is scheduled, get the SI_NEW_JOB_ID of the new instance and query for
the new instance's SI_UISTATUS property.
public void setNewJobID(java.lang.String newJobID)
The ID of the new instance that has just been scheduled.
newJobID - The ID of the new instance that has just been scheduled.public java.util.Calendar getStartTime()
The date and time that the instance actually began being processed.
public void setStartTime(java.util.Calendar startTime)
The date and time that the instance actually began being processed.
startTime - The date and time that the instance actually began being processed.public java.util.Calendar getEndTime()
The date and time that the instance actually finished being processed.
public void setEndTime(java.util.Calendar endTime)
The date and time that the instance actually finished being processed.
endTime - The date and time that the instance actually finished being processed.public java.lang.String getErrorMessage()
Returns a localized error message for a failed job. It may include plugin-specific information.
String containing the error message for the failed job.public void setErrorMessage(java.lang.String errorMessage)
Sets a localized error message for a failed job. It may include plugin-specific information.
errorMessage - A String containing the error message for the failed job.public StatusInfo getStatusInfo()
Returns the current status of the scheduled job.
public void setStatusInfo(StatusInfo statusInfo)
Sets the current status of the scheduled job.
statusInfo - The current status of the scheduled job.public Alerts getAlerts()
Returns a collection of Alert objects.
Alert objects.public void setAlerts(Alerts alerts)
Sets a collection of Alert objects.
alerts - A collection of Alert objects.public PluginInfo getPluginInfo()
Returns the plugin info.
public void setPluginInfo(PluginInfo pluginInfo)
Sets the plugin info.
pluginInfo - The plugin info.public SecurityInfo getSecurityInfo()
Returns the security information for the object.
public void setSecurityInfo(SecurityInfo securityInfo)
Sets the security information for the object.
securityInfo - The security information for the object.public java.lang.String getKey()
Returns the unique hash code value of the InfoObject.
This property is only used in import and export scenarios.
public void setKey(java.lang.String key)
public boolean equals(java.lang.Object obj)
public int hashCode()
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||