InfoObject (Business Objects web services Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.businessobjects.enterprise.infoobject
Interface InfoObject

All Known Subinterfaces:: Agnostic, AppFoundation, BusobjReporter, Calendar, Category, CMC, Connection, CrystalReport, CustomRole, Designer, DiskUnmanaged, Encyclopedia, EncyclopediaAssociationDefinition, EncyclopediaAssociationEnd, EncyclopediaAssociationEndDefinition, EncyclopediaAssociationInstance, EncyclopediaAttributeDefinition, EncyclopediaAttributeValue, EncyclopediaTopic, EncyclopediaTopicDefinition, EPortfolio, Event, Excel, FavoritesFolder, Flash, Folder, Ftp, FullClient, Hyperlink, Inbox, InfoView, LicenseKey, Managed, Note, ObjectPackage, Overload, Pdf, PersonalCategory, Powerpoint, Profile, Program, Publication, ReportConvTool, Rtf, SecEnterprise, SecLDAP, SecWinAD, SecWindowsNT, Server, ServerGroup, Shortcut, Smtp, StrategyBuilder, Txt, Universe, User, UserGroup, Webi, WebIntelligence, Word, Xcelsius

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

Nested Class Summary
`static class`	`InfoObject.Factory` A class with methods for creating instances of the InfoObject type.

Field Summary
`static org.apache.xmlbeans.SchemaType`	`type` Internal Use Only.

Method Summary
`Alerts`	`addNewAlerts()` Appends and returns a new empty Alerts object as the last element of the array.
`PluginInfo`	`addNewPluginInfo()` Appends and returns a new empty PluginInfo object as the last element of the array.
`RolesOnObject`	`addNewRolesOnObject()` Appends and returns a new empty RolesOnObject object as the last element of the array.
`SecurityInfo`	`addNewSecurityInfo()` Appends and returns a new empty SecurityInfo object as the last element of the array.
`SecurityInfo2`	`addNewSecurityInfo2()` Appends and returns a new empty SecurityInfo2 object as the last element of the array.
`com.businessobjects.enterprise.infoobject.SharedDoc`	`addNewSharedDoc()` Internal Use Only.
`StatusInfo`	`addNewStatusInfo()` Appends and returns a new empty Alert object as the last element of the array.
`Alerts`	`getAlerts()` Returns a collection of `Alert` objects.
`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.
`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.
`int`	`getID()` Returns the unique ID of an InfoObject.
`boolean`	`getInstance()` Returns true if this object is an instance.
`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.
`boolean`	`getIsApplicationObject()` Indicates whether or not the BusinessObjects Enterprise object is an application object.
`boolean`	`getIsComponent()` The flag indicating whether the object is a package component.
`boolean`	`getIsHiddenObject()` This property indicates whether or not an object is hidden.
`boolean`	`getIsPluginObject()` Returns `true` if the InfoObject is a plugin, and `false` otherwise.
`boolean`	`getIsRecurring()` Returns True if the InfoObject is a recurring instance, and False otherwise.
`boolean`	`getIsRunnableObject()` Returns `true` if the report object is runnable, and `false` otherwise.
`boolean`	`getIsSendable()` Indicates if the object can be sent to a destination.
`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.
`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.
`RolesOnObject`	`getRolesOnObject()` Returns the custom access levels (custom roles) that are assigned to an object.
`java.lang.String`	`getRUID()` Returns the object's unique identifier within an object package.
`boolean`	`getSchedulable()` Indicates whether or not the object can be scheduled.
`SecurityInfo`	`getSecurityInfo()` Returns the security information for the object.
`SecurityInfo2`	`getSecurityInfo2()` Gets security roles, rights, and limits on an object for a specific user or group.
`com.businessobjects.enterprise.infoobject.SharedDoc`	`getSharedDoc()` 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.
`int`	`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.
`boolean`	`isSetAlerts()` Checks if the Alerts element has been set.
`boolean`	`isSetChildrenObjects()` Checks if the ChildrenObjects has been set.
`boolean`	`isSetCreationTime()` Checks if the CreationTime has been set.
`boolean`	`isSetCUID()` Checks if the CUID has been set.
`boolean`	`isSetDescription()` Checks if the `Description` has been set.
`boolean`	`isSetEndTime()` Checks if the EndTime has been set.
`boolean`	`isSetErrorMessage()` Checks if the ErrorMessage has been set.
`boolean`	`isSetID()` Checks if the `ID` has been set.
`boolean`	`isSetInstance()` Checks if the Instance has been set.
`boolean`	`isSetInstanceObject()` Checks if the `InstanceObject` has been set.
`boolean`	`isSetIsApplicationObject()` Checks if the IsApplicationObject has been set.
`boolean`	`isSetIsComponent()` Checks if the IsComponent has been set.
`boolean`	`isSetIsHiddenObject()` Checks if the IsHiddenObject has been set.
`boolean`	`isSetIsPluginObject()` Checks if the IsPluginObject has been set.
`boolean`	`isSetIsRecurring()` Checks if the IsRecurring has been set.
`boolean`	`isSetIsRunnableObject()` Checks if the IsRunnableObject has been set.
`boolean`	`isSetIsSendable()` Checks if the IsSendable has been set.
`boolean`	`isSetIsSystemObject()` Checks if the IsSystemObject has been set.
`boolean`	`isSetKey()` Checks if the Key has been set.
`boolean`	`isSetKeywords()` Checks if the Keywords has been set.
`boolean`	`isSetKind()` Checks if the Kind has been set.
`boolean`	`isSetLastRunTime()` Checks if the LastRunTime has been set.
`boolean`	`isSetLastSuccessfulInstanceCUID()` Checks if the LastSuccessfulInstanceCUID has been set.
`boolean`	`isSetNewJobID()` Checks if the NewJobID has been set.
`boolean`	`isSetNextRunTime()` Checks if the NextRunTime has been set.
`boolean`	`isSetObjectIsContainer()` Checks if the ObjectIsContainer has been set.
`boolean`	`isSetOwner()` Checks if the Owner has been set.
`boolean`	`isSetOwnerCUID()` Checks if the OwnerCUID has been set.
`boolean`	`isSetParentCUID()` Checks if the ParentCUID has been set.
`boolean`	`isSetPluginInfo()` Checks if the PluginInfo has been set.
`boolean`	`isSetRolesOnObject()` Checks if the RolesOnObject has been set.
`boolean`	`isSetRUID()` Checks if the RUID has been set.
`boolean`	`isSetSchedulable()` Checks if the Schedulable element has been set.
`boolean`	`isSetSecurityInfo()` Checks if the SecurityInfo has been set.
`boolean`	`isSetSecurityInfo2()` Checks if the SecurityInfo2 has been set.
`boolean`	`isSetSharedDoc()` Internal Use Only.
`boolean`	`isSetStartTime()` Checks if the StartTime has been set.
`boolean`	`isSetStatusInfo()` Checks if the StatusInfo has been set.
`boolean`	`isSetUiStatus()` Checks if the UiStatus has been set.
`boolean`	`isSetUpdateTime()` Checks if the UpdateTime has been set.
`void`	`setAlerts(Alerts alerts)` Sets a collection of `Alert` objects.
`void`	`setChildrenObjects(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(int id)` Internal Use Only.
`void`	`setInstance(boolean instance)` `true` if this object is an instance, `false` otherwise.
`void`	`setInstanceObject(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(boolean isApplicationObject)` Indicates whether or not the BusinessObjects Enterprise object is an application object.
`void`	`setIsComponent(boolean isComponent)` The flag indicating whether the object is a package component.
`void`	`setIsHiddenObject(boolean isHiddenObject)` This property indicates whether or not an object is hidden.
`void`	`setIsPluginObject(boolean isPluginObject)` Sets whether the InfoObject is a plugin.
`void`	`setIsRecurring(boolean isRecurring)` Returns True if the InfoObject is a recurring instance, and False otherwise.
`void`	`setIsRunnableObject(boolean isRunnableObject)` Sets whether the report object is runnable.
`void`	`setIsSendable(boolean isSendable)` Indicates if the object can be sent to a destination.
`void`	`setIsSystemObject(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(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`	`setRolesOnObject(RolesOnObject rolesOnObject)` Sets the custom access levels (custom roles) that are assigned to an object.
`void`	`setRUID(java.lang.String ruid)` Sets the object's unique identifier within an object package.
`void`	`setSchedulable(boolean schedulable)` Internal Use Only.
`void`	`setSecurityInfo(SecurityInfo securityInfo)` Sets the security information for the object.
`void`	`setSecurityInfo2(SecurityInfo2 securityInfo2)` Sets security roles, rights, and limits on an object for a specific user or group.
`void`	`setSharedDoc(com.businessobjects.enterprise.infoobject.SharedDoc sharedDoc)` Internal Use Only.
`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(int 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.
`void`	`unsetAlerts()` Deletes or unsets the Alerts element.
`void`	`unsetChildrenObjects()` Deletes or unsets the ChildrenObjects element.
`void`	`unsetCreationTime()` Deletes or unsets the CreationTime element.
`void`	`unsetCUID()` Deletes or unsets the CUID element.
`void`	`unsetDescription()` Deletes or unsets the Description element.
`void`	`unsetEndTime()` Deletes or unsets the EndTime element.
`void`	`unsetErrorMessage()` Deletes or unsets the ErrorMessage element.
`void`	`unsetID()` Internal Use Only.
`void`	`unsetInstance()` Deletes or unsets the Instance element.
`void`	`unsetInstanceObject()` Deletes or unsets the InstanceObject element.
`void`	`unsetIsApplicationObject()` Deletes or unsets the IsApplicationObject element.
`void`	`unsetIsComponent()` Deletes or unsets the IsComponent element.
`void`	`unsetIsHiddenObject()` Deletes or unsets the IsHiddenObject element.
`void`	`unsetIsPluginObject()` Deletes or unsets the IsPluginObject element.
`void`	`unsetIsRecurring()` Deletes or unsets the IsRecurring element.
`void`	`unsetIsRunnableObject()` Deletes or unsets the IsRunnableObject element.
`void`	`unsetIsSendable()` Deletes or unsets the IsSendable element.
`void`	`unsetIsSystemObject()` Deletes or unsets the IsSystemObject element.
`void`	`unsetKey()` Deletes or unsets the Key element.
`void`	`unsetKeywords()` Deletes or unsets the Keywords element.
`void`	`unsetKind()` Deletes or unsets the Kind element.
`void`	`unsetLastRunTime()` Deletes or unsets the LastRunTime element.
`void`	`unsetLastSuccessfulInstanceCUID()` Deletes or unsets the LastSuccessfulInstanceCUID element.
`void`	`unsetNewJobID()` Deletes or unsets the NewJobID element.
`void`	`unsetNextRunTime()` Deletes or unsets the NextRunTime element.
`void`	`unsetObjectIsContainer()` Deletes or unsets the ObjectIsContainer element.
`void`	`unsetOwner()` Deletes or unsets the Owner element.
`void`	`unsetOwnerCUID()` Deletes or unsets the OwnerCUID element.
`void`	`unsetParentCUID()` Checks if the ParentCUID has been set.
`void`	`unsetPluginInfo()` Deletes or unsets the PluginInfo element.
`void`	`unsetRolesOnObject()` Deletes or unsets the RolesOnObject element.
`void`	`unsetRUID()` Deletes or unsets the RUID element.
`void`	`unsetSchedulable()` Deletes or unsets the Schedulable element.
`void`	`unsetSecurityInfo()` Deletes or unsets the SecurityInfo element.
`void`	`unsetSecurityInfo2()` Deletes or unsets the SecurityInfo2 element.
`void`	`unsetSharedDoc()` Internal Use Only.
`void`	`unsetStartTime()` Deletes or unsets the StartTime element.
`void`	`unsetStatusInfo()` Deletes or unsets the StatusInfo element.
`void`	`unsetUiStatus()` Deletes or unsets the UiStatus element.
`void`	`unsetUpdateTime()` Deletes or unsets the UpdateTime element.
`org.apache.xmlbeans.XmlLong`	`xgetChildrenObjects()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetCreationTime()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetCUID()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetDescription()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetEndTime()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetErrorMessage()` Internal Use Only.
`org.apache.xmlbeans.XmlInt`	`xgetID()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetInstance()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetInstanceObject()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsApplicationObject()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsComponent()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsHiddenObject()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsPluginObject()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsRecurring()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsRunnableObject()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsSendable()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetIsSystemObject()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetKey()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetKeywords()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetKind()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetLastRunTime()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetLastSuccessfulInstanceCUID()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetName()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetNewJobID()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetNextRunTime()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetObjectIsContainer()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetOwner()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetOwnerCUID()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetParentCUID()` Internal Use Only.
`org.apache.xmlbeans.XmlString`	`xgetRUID()` Internal Use Only.
`org.apache.xmlbeans.XmlBoolean`	`xgetSchedulable()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetStartTime()` Internal Use Only.
`org.apache.xmlbeans.XmlInt`	`xgetUiStatus()` Internal Use Only.
`org.apache.xmlbeans.XmlDateTime`	`xgetUpdateTime()` Internal Use Only.
`void`	`xsetChildrenObjects(org.apache.xmlbeans.XmlLong childrenObjects)` Internal Use Only.
`void`	`xsetCreationTime(org.apache.xmlbeans.XmlDateTime creationTime)` Internal Use Only.
`void`	`xsetCUID(org.apache.xmlbeans.XmlString cuid)` Internal Use Only.
`void`	`xsetDescription(org.apache.xmlbeans.XmlString description)` Internal Use Only.
`void`	`xsetEndTime(org.apache.xmlbeans.XmlDateTime endTime)` Internal Use Only.
`void`	`xsetErrorMessage(org.apache.xmlbeans.XmlString errorMessage)` Internal Use Only.
`void`	`xsetID(org.apache.xmlbeans.XmlInt id)` Internal Use Only.
`void`	`xsetInstance(org.apache.xmlbeans.XmlBoolean instance)` Internal Use Only.
`void`	`xsetInstanceObject(org.apache.xmlbeans.XmlBoolean instanceObject)` Internal Use Only.
`void`	`xsetIsApplicationObject(org.apache.xmlbeans.XmlBoolean isApplicationObject)` Internal Use Only.
`void`	`xsetIsComponent(org.apache.xmlbeans.XmlBoolean isComponent)` Internal Use Only.
`void`	`xsetIsHiddenObject(org.apache.xmlbeans.XmlBoolean isHiddenObject)` Internal Use Only.
`void`	`xsetIsPluginObject(org.apache.xmlbeans.XmlBoolean isPluginObject)` Internal Use Only.
`void`	`xsetIsRecurring(org.apache.xmlbeans.XmlBoolean isRecurring)` Internal Use Only.
`void`	`xsetIsRunnableObject(org.apache.xmlbeans.XmlBoolean isRunnableObject)` Internal Use Only.
`void`	`xsetIsSendable(org.apache.xmlbeans.XmlBoolean isSendable)` Internal Use Only.
`void`	`xsetIsSystemObject(org.apache.xmlbeans.XmlBoolean isSystemObject)` Internal Use Only.
`void`	`xsetKey(org.apache.xmlbeans.XmlString key)` Internal Use Only.
`void`	`xsetKeywords(org.apache.xmlbeans.XmlString keywords)` Internal Use Only.
`void`	`xsetKind(org.apache.xmlbeans.XmlString kind)` Internal Use Only.
`void`	`xsetLastRunTime(org.apache.xmlbeans.XmlDateTime lastRunTime)` Internal Use Only.
`void`	`xsetLastSuccessfulInstanceCUID(org.apache.xmlbeans.XmlString lastSuccessfulInstanceCUID)` Internal Use Only.
`void`	`xsetName(org.apache.xmlbeans.XmlString name)` Internal Use Only.
`void`	`xsetNewJobID(org.apache.xmlbeans.XmlString newJobID)` Internal Use Only.
`void`	`xsetNextRunTime(org.apache.xmlbeans.XmlDateTime nextRunTime)` Internal Use Only.
`void`	`xsetObjectIsContainer(org.apache.xmlbeans.XmlBoolean objectIsContainer)` Internal Use Only.
`void`	`xsetOwner(org.apache.xmlbeans.XmlString owner)` Internal Use Only.
`void`	`xsetOwnerCUID(org.apache.xmlbeans.XmlString ownerCUID)` Internal Use Only.
`void`	`xsetParentCUID(org.apache.xmlbeans.XmlString parentCUID)` Internal Use Only.
`void`	`xsetRUID(org.apache.xmlbeans.XmlString ruid)` Internal Use Only.
`void`	`xsetSchedulable(org.apache.xmlbeans.XmlBoolean schedulable)` Internal Use Only.
`void`	`xsetStartTime(org.apache.xmlbeans.XmlDateTime startTime)` Internal Use Only.
`void`	`xsetUiStatus(org.apache.xmlbeans.XmlInt uiStatus)` Internal Use Only.
`void`	`xsetUpdateTime(org.apache.xmlbeans.XmlDateTime updateTime)` Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getID

int getID()

Returns the unique ID of an InfoObject.

Use the CUID of an InfoObject as the primary identifier, not this property.

Returns:: The unique ID of an InfoObject.

xgetID

org.apache.xmlbeans.XmlInt xgetID()

Internal Use Only.

isSetID

boolean isSetID()

Checks if the ID has been set.

Returns:: true if the ID element has been set, false otherwise.

setID

void setID(int id)

Internal Use Only.

xsetID

void xsetID(org.apache.xmlbeans.XmlInt id)

Internal Use Only.

unsetID

void unsetID()

Internal Use Only.

getName

java.lang.String getName()

Returns the title of the InfoObject.

Returns:: A String containing the title of the InfoObject.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Sets the title of the InfoObject.

Parameters:: name - A String containing the title of the InfoObject.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getDescription

java.lang.String getDescription()

Returns the description of the InfoObject.

Returns:: A String containing the description of the object.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isSetDescription

boolean isSetDescription()

Checks if the Description has been set.

Returns:: true if the Description element has been set, otherwise false.

setDescription

void setDescription(java.lang.String description)

Sets the description of the InfoObject.

Parameters:: description - A String containing the description of the object.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

unsetDescription

void unsetDescription()

Deletes or unsets the Description element.

getCUID

java.lang.String getCUID()

Returns the object's unique identifier within a cluster.

Returns:: A string representing the object's cluster unique identifier.

xgetCUID

org.apache.xmlbeans.XmlString xgetCUID()

Internal Use Only.

isSetCUID

boolean isSetCUID()

Checks if the CUID has been set.

Returns:: true if the CUID element has been set, otherwise false.

setCUID

void setCUID(java.lang.String cuid)

Sets the object's unique identifier within a cluster.

Parameters:: cuid - A string representing the object's cluster unique identifier.

xsetCUID

void xsetCUID(org.apache.xmlbeans.XmlString cuid)

Internal Use Only.

unsetCUID

void unsetCUID()

Deletes or unsets the CUID element.

getRUID

java.lang.String getRUID()

Returns the object's unique identifier within an object package.

Returns:: A string representing the object's package unique identifier.

xgetRUID

org.apache.xmlbeans.XmlString xgetRUID()

Internal Use Only.

isSetRUID

boolean isSetRUID()

Checks if the RUID has been set.

Returns:: true if the RUID element has been set, false otherwise.

setRUID

void setRUID(java.lang.String ruid)

Sets the object's unique identifier within an object package.

Parameters:: ruid - A string representing the object's package unique identifier.

xsetRUID

void xsetRUID(org.apache.xmlbeans.XmlString ruid)

Internal Use Only.

unsetRUID

void unsetRUID()

Deletes or unsets the RUID element.

getKind

java.lang.String getKind()

Returns the kind of the InfoObject.

The following values are valid:

Calendar
Category
Connection
CrystalReport
Event
Excel
FavoritesFolder
Flash
Folder
FullClient
Hyperlink
Inbox
LicenseKey
ObjectPackage
Overload
Pdf
PersonalCategory
Powerpoint
Profile
Program
Publication
Rtf
Server
ServerGroup
Shortcut
Txt
Universe
User
UserGroup
Webi
Word
Xcelsius

Returns:: The kind of the InfoObject.

xgetKind

org.apache.xmlbeans.XmlString xgetKind()

Internal Use Only.

isSetKind

boolean isSetKind()

Checks if the Kind has been set.

Returns:: true if the Kind element has been set, otherwise false.

setKind

void setKind(java.lang.String kind)

Sets the kind of the InfoObject.

The following values are valid:

Calendar
Category
Connection
CrystalReport
Event
Excel
FavoritesFolder
Flash
Folder
FullClient
Hyperlink
Inbox
LicenseKey
ObjectPackage
Overload
Pdf
PersonalCategory
Powerpoint
Profile
Program
Publication
Rtf
Server
ServerGroup
Shortcut
Txt
Universe
User
UserGroup
Webi
Word
Xcelsius

Parameters:: kind - The kind of the InfoObject.

xsetKind

void xsetKind(org.apache.xmlbeans.XmlString kind)

Internal Use Only.

unsetKind

void unsetKind()

Deletes or unsets the Kind element.

getOwner

java.lang.String getOwner()

Returns the name of the user who owns a particular object.

Returns:: The name of the user who owns a particular object.

xgetOwner

org.apache.xmlbeans.XmlString xgetOwner()

Internal Use Only.

isSetOwner

boolean isSetOwner()

Checks if the Owner has been set.

Returns:: true if the Owner element has been set, otherwise false.

setOwner

void setOwner(java.lang.String owner)

Internal Use Only.

xsetOwner

void xsetOwner(org.apache.xmlbeans.XmlString owner)

Internal Use Only.

unsetOwner

void unsetOwner()

Deletes or unsets the Owner element.

getOwnerCUID

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.

Returns:: The owner ID.

xgetOwnerCUID

org.apache.xmlbeans.XmlString xgetOwnerCUID()

Internal Use Only.

isSetOwnerCUID

boolean isSetOwnerCUID()

Checks if the OwnerCUID has been set.

Returns:: true if the OwnerCUID element has been set, otherwise false.

setOwnerCUID

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.

Parameters:: ownerCUID - The owner ID.

xsetOwnerCUID

void xsetOwnerCUID(org.apache.xmlbeans.XmlString ownerCUID)

Internal Use Only.

unsetOwnerCUID

void unsetOwnerCUID()

Deletes or unsets the OwnerCUID element.

getParentCUID

java.lang.String getParentCUID()

Returns the parent object's cluster unique identifier.

Returns:: String representing the parent object's cluster unique identifier.

xgetParentCUID

org.apache.xmlbeans.XmlString xgetParentCUID()

Internal Use Only.

isSetParentCUID

boolean isSetParentCUID()

Checks if the ParentCUID has been set.

Returns:: true if the ParentCUID element has been set, otherwise false.

setParentCUID

void setParentCUID(java.lang.String parentCUID)

Sets the parent object's cluster unique identifier.

Parameters:: parentCUID - String representing the parent object's cluster unique identifier.

xsetParentCUID

void xsetParentCUID(org.apache.xmlbeans.XmlString parentCUID)

Internal Use Only.

unsetParentCUID

void unsetParentCUID()

Checks if the ParentCUID has been set.

getCreationTime

java.util.Calendar getCreationTime()

Stores the date and time of the object's creation.

Returns:: Stores the date and time of the object's creation.

xgetCreationTime

org.apache.xmlbeans.XmlDateTime xgetCreationTime()

Internal Use Only.

isSetCreationTime

boolean isSetCreationTime()

Checks if the CreationTime has been set.

Returns:: true if the CreationTime element has been set, otherwise false.

setCreationTime

void setCreationTime(java.util.Calendar creationTime)

Stores the date and time of the object's creation.

Parameters:: creationTime - Stores the date and time of the object's creation.

xsetCreationTime

void xsetCreationTime(org.apache.xmlbeans.XmlDateTime creationTime)

Internal Use Only.

unsetCreationTime

void unsetCreationTime()

Deletes or unsets the CreationTime element.

getUpdateTime

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.

Returns:: This is a time stamp property which stores the date and time the object was last modified.

xgetUpdateTime

org.apache.xmlbeans.XmlDateTime xgetUpdateTime()

Internal Use Only.

isSetUpdateTime

boolean isSetUpdateTime()

Checks if the UpdateTime has been set.

Returns:: true if the UpdateTime element has been set, otherwise false.

setUpdateTime

void setUpdateTime(java.util.Calendar updateTime)

This is a time stamp property which stores the date and time the object was last modified.

Parameters:: updateTime - This is a time stamp property which stores the date and time the object was last modified.

xsetUpdateTime

void xsetUpdateTime(org.apache.xmlbeans.XmlDateTime updateTime)

Internal Use Only.

unsetUpdateTime

void unsetUpdateTime()

Deletes or unsets the UpdateTime element.

getKeywords

java.lang.String getKeywords()

Returns the keyword of the InfoObject.

Returns:: A String containing the keyword of the object.

xgetKeywords

org.apache.xmlbeans.XmlString xgetKeywords()

Internal Use Only.

isSetKeywords

boolean isSetKeywords()

Checks if the Keywords has been set.

Returns:: true if the Keywords element has been set, otherwise false.

setKeywords

void setKeywords(java.lang.String keywords)

Sets the keyword of the InfoObject.

Parameters:: keywords - A String containing the keyword of the object.

xsetKeywords

void xsetKeywords(org.apache.xmlbeans.XmlString keywords)

Internal Use Only.

unsetKeywords

void unsetKeywords()

Deletes or unsets the Keywords element.

getChildrenObjects

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.

Returns:: Specifies the number of children an object has.

xgetChildrenObjects

org.apache.xmlbeans.XmlLong xgetChildrenObjects()

Internal Use Only.

isSetChildrenObjects

boolean isSetChildrenObjects()

Checks if the ChildrenObjects has been set.

Returns:: true if the ChildrenObjects element has been set, otherwise false.

setChildrenObjects

void setChildrenObjects(long childrenObjects)

Internal Use Only.

xsetChildrenObjects

void xsetChildrenObjects(org.apache.xmlbeans.XmlLong childrenObjects)

Internal Use Only.

unsetChildrenObjects

void unsetChildrenObjects()

Deletes or unsets the ChildrenObjects element.

getInstance

boolean getInstance()

Returns true if this object is an instance. This method is used to check whether or not the InfoObject is an instance.

Returns:: true if this object is an instance, false otherwise.

xgetInstance

org.apache.xmlbeans.XmlBoolean xgetInstance()

Internal Use Only.

isSetInstance

boolean isSetInstance()

Checks if the Instance has been set.

Returns:: true if the Instance element has been set, otherwise false.

setInstance

void setInstance(boolean instance)

true if this object is an instance, false otherwise.

Parameters:: instance - true if this object is an instance, false otherwise.

xsetInstance

void xsetInstance(org.apache.xmlbeans.XmlBoolean instance)

Internal Use Only.

unsetInstance

void unsetInstance()

Deletes or unsets the Instance element.

getObjectIsContainer

boolean getObjectIsContainer()

Returns whether the object is a folder, inbox, or category.

Returns:: true if the object is a folder, inbox, or category, false otherwise.

xgetObjectIsContainer

org.apache.xmlbeans.XmlBoolean xgetObjectIsContainer()

Internal Use Only.

isSetObjectIsContainer

boolean isSetObjectIsContainer()

Checks if the ObjectIsContainer has been set.

Returns:: true if the ObjectIsContainer element has been set, otherwise false.

setObjectIsContainer

void setObjectIsContainer(boolean objectIsContainer)

Internal Use Only.

xsetObjectIsContainer

void xsetObjectIsContainer(org.apache.xmlbeans.XmlBoolean objectIsContainer)

Internal Use Only.

unsetObjectIsContainer

void unsetObjectIsContainer()

Deletes or unsets the ObjectIsContainer element.

getIsHiddenObject

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.

Returns:: This property indicates whether or not an object is hidden.

xgetIsHiddenObject

org.apache.xmlbeans.XmlBoolean xgetIsHiddenObject()

Internal Use Only.

isSetIsHiddenObject

boolean isSetIsHiddenObject()

Checks if the IsHiddenObject has been set.

Returns:: true if the HiddenObject element has been set, otherwise false.

setIsHiddenObject

void setIsHiddenObject(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.

Parameters:: isHiddenObject - This property indicates whether or not an object is hidden.

xsetIsHiddenObject

void xsetIsHiddenObject(org.apache.xmlbeans.XmlBoolean isHiddenObject)

Internal Use Only.

unsetIsHiddenObject

void unsetIsHiddenObject()

Deletes or unsets the IsHiddenObject element.

getIsSystemObject

boolean getIsSystemObject()

Indicates whether or not the BusinessObjects Enterprise object is a system object.

Returns:: Indicates whether or not the BusinessObjects Enterprise object is a system object.

xgetIsSystemObject

org.apache.xmlbeans.XmlBoolean xgetIsSystemObject()

Internal Use Only.

isSetIsSystemObject

boolean isSetIsSystemObject()

Checks if the IsSystemObject has been set.

Returns:: true if the SystemObject element has been set, otherwise false.

setIsSystemObject

void setIsSystemObject(boolean isSystemObject)

Indicates whether or not the BusinessObjects Enterprise object is a system object.

Parameters:: isSystemObject - Indicates whether or not the BusinessObjects Enterprise object is a system object.

xsetIsSystemObject

void xsetIsSystemObject(org.apache.xmlbeans.XmlBoolean isSystemObject)

Internal Use Only.

unsetIsSystemObject

void unsetIsSystemObject()

Deletes or unsets the IsSystemObject element.

getIsRunnableObject

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

Returns:: Returns true if the report object is runnable, and false otherwise.

xgetIsRunnableObject

org.apache.xmlbeans.XmlBoolean xgetIsRunnableObject()

Internal Use Only.

isSetIsRunnableObject

boolean isSetIsRunnableObject()

Checks if the IsRunnableObject has been set.

Returns:: true if the RunnableObject element has been set, otherwise false.

setIsRunnableObject

void setIsRunnableObject(boolean isRunnableObject)

Sets whether the report object is runnable.

Parameters:: isRunnableObject - Sets whether the report object is runnable.

xsetIsRunnableObject

void xsetIsRunnableObject(org.apache.xmlbeans.XmlBoolean isRunnableObject)

Internal Use Only.

unsetIsRunnableObject

void unsetIsRunnableObject()

Deletes or unsets the IsRunnableObject element.

getIsPluginObject

boolean getIsPluginObject()

Returns true if the InfoObject is a plugin, and false otherwise.

Returns:: Returns true if the InfoObject is a plugin, and false otherwise.

xgetIsPluginObject

org.apache.xmlbeans.XmlBoolean xgetIsPluginObject()

Internal Use Only.

isSetIsPluginObject

boolean isSetIsPluginObject()

Checks if the IsPluginObject has been set.

Returns:: true if the PluginObject element has been set, otherwise false.

setIsPluginObject

void setIsPluginObject(boolean isPluginObject)

Sets whether the InfoObject is a plugin.

Parameters:: isPluginObject - Sets whether the InfoObject is a plugin.

xsetIsPluginObject

void xsetIsPluginObject(org.apache.xmlbeans.XmlBoolean isPluginObject)

Internal Use Only.

unsetIsPluginObject

void unsetIsPluginObject()

Deletes or unsets the IsPluginObject element.

getInstanceObject

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

Returns:: 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.

xgetInstanceObject

org.apache.xmlbeans.XmlBoolean xgetInstanceObject()

Internal Use Only.

isSetInstanceObject

boolean isSetInstanceObject()

Checks if the InstanceObject has been set.

Returns:: true if the InstanceObject has been set, false otherwise.

setInstanceObject

void setInstanceObject(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).

Parameters:: 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.

xsetInstanceObject

void xsetInstanceObject(org.apache.xmlbeans.XmlBoolean instanceObject)

Internal Use Only.

unsetInstanceObject

void unsetInstanceObject()

Deletes or unsets the InstanceObject element.

getIsApplicationObject

boolean getIsApplicationObject()

Indicates whether or not the BusinessObjects Enterprise object is an application object.

Returns:: Indicates whether or not the BusinessObjects Enterprise object is an application object.

xgetIsApplicationObject

org.apache.xmlbeans.XmlBoolean xgetIsApplicationObject()

Internal Use Only.

isSetIsApplicationObject

boolean isSetIsApplicationObject()

Checks if the IsApplicationObject has been set.

Returns:: true if the ApplicationObject element has been set, otherwise false.

setIsApplicationObject

void setIsApplicationObject(boolean isApplicationObject)

Indicates whether or not the BusinessObjects Enterprise object is an application object.

Parameters:: isApplicationObject - Indicates whether or not the BusinessObjects Enterprise object is an application object.

xsetIsApplicationObject

void xsetIsApplicationObject(org.apache.xmlbeans.XmlBoolean isApplicationObject)

Internal Use Only.

unsetIsApplicationObject

void unsetIsApplicationObject()

Deletes or unsets the IsApplicationObject element.

getIsComponent

boolean getIsComponent()

The flag indicating whether the object is a package component.

Returns:: The flag indicating whether the object is a package component.

xgetIsComponent

org.apache.xmlbeans.XmlBoolean xgetIsComponent()

Internal Use Only.

isSetIsComponent

boolean isSetIsComponent()

Checks if the IsComponent has been set.

Returns:: true if the Component element has been set, otherwise false.

setIsComponent

void setIsComponent(boolean isComponent)

The flag indicating whether the object is a package component.

Parameters:: isComponent - The flag indicating whether the object is a package component.

xsetIsComponent

void xsetIsComponent(org.apache.xmlbeans.XmlBoolean isComponent)

Internal Use Only.

unsetIsComponent

void unsetIsComponent()

Deletes or unsets the IsComponent element.

getSchedulable

boolean getSchedulable()

Indicates whether or not the object can be scheduled.

Returns:: true if the object can be scheduled, false otherwise.

xgetSchedulable

org.apache.xmlbeans.XmlBoolean xgetSchedulable()

Internal Use Only.

isSetSchedulable

boolean isSetSchedulable()

Checks if the Schedulable element has been set.

Returns:: true if the Schedulable element has been set, otherwise false.

setSchedulable

void setSchedulable(boolean schedulable)

Internal Use Only.

xsetSchedulable

void xsetSchedulable(org.apache.xmlbeans.XmlBoolean schedulable)

Internal Use Only.

unsetSchedulable

void unsetSchedulable()

Deletes or unsets the Schedulable element.

getUiStatus

int getUiStatus()

The SI_UISTATUS property.

Returns:: The SI_UISTATUS property.

xgetUiStatus

org.apache.xmlbeans.XmlInt xgetUiStatus()

Internal Use Only.

isSetUiStatus

boolean isSetUiStatus()

Checks if the UiStatus has been set.

Returns:: true if the UiStatus element has been set, otherwise false.

setUiStatus

void setUiStatus(int uiStatus)

The SI_UISTATUS property.

Parameters:: uiStatus - The SI_UISTATUS property.

xsetUiStatus

void xsetUiStatus(org.apache.xmlbeans.XmlInt uiStatus)

Internal Use Only.

unsetUiStatus

void unsetUiStatus()

Deletes or unsets the UiStatus element.

getIsRecurring

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.

Returns:: Returns True if the InfoObject is a recurring instance, and False otherwise.

xgetIsRecurring

org.apache.xmlbeans.XmlBoolean xgetIsRecurring()

Internal Use Only.

isSetIsRecurring

boolean isSetIsRecurring()

Checks if the IsRecurring has been set.

Returns:: true if the Recurring element has been set, otherwise false.

setIsRecurring

void setIsRecurring(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.

Parameters:: isRecurring - Returns True if the InfoObject is a recurring instance, and False otherwise.

xsetIsRecurring

void xsetIsRecurring(org.apache.xmlbeans.XmlBoolean isRecurring)

Internal Use Only.

unsetIsRecurring

void unsetIsRecurring()

Deletes or unsets the IsRecurring element.

getLastSuccessfulInstanceCUID

java.lang.String getLastSuccessfulInstanceCUID()

This property stores the ID of the last successful instance ID for the given report.

Returns:: This property stores the ID of the last successful instance ID for the given report.

xgetLastSuccessfulInstanceCUID

org.apache.xmlbeans.XmlString xgetLastSuccessfulInstanceCUID()

Internal Use Only.

isSetLastSuccessfulInstanceCUID

boolean isSetLastSuccessfulInstanceCUID()

Checks if the LastSuccessfulInstanceCUID has been set.

Returns:: true if the LastSuccessfulInstanceCUID element has been set, otherwise false.

setLastSuccessfulInstanceCUID

void setLastSuccessfulInstanceCUID(java.lang.String lastSuccessfulInstanceCUID)

Internal Use Only.

xsetLastSuccessfulInstanceCUID

void xsetLastSuccessfulInstanceCUID(org.apache.xmlbeans.XmlString lastSuccessfulInstanceCUID)

Internal Use Only.

unsetLastSuccessfulInstanceCUID

void unsetLastSuccessfulInstanceCUID()

Deletes or unsets the LastSuccessfulInstanceCUID element.

getLastRunTime

java.util.Calendar getLastRunTime()

This property stores the date and time when the report was last run.

Returns:: This property stores the date and time when the report was last run.

xgetLastRunTime

org.apache.xmlbeans.XmlDateTime xgetLastRunTime()

Internal Use Only.

isSetLastRunTime

boolean isSetLastRunTime()

Checks if the LastRunTime has been set.

Returns:: true if the LastRunTime element has been set, otherwise false.

setLastRunTime

void setLastRunTime(java.util.Calendar lastRunTime)

This property stores the date and time when the report was last run.

Parameters:: lastRunTime - This property stores the date and time when the report was last run.

xsetLastRunTime

void xsetLastRunTime(org.apache.xmlbeans.XmlDateTime lastRunTime)

Internal Use Only.

unsetLastRunTime

void unsetLastRunTime()

Deletes or unsets the LastRunTime element.

getIsSendable

boolean getIsSendable()

Indicates if the object can be sent to a destination.

Returns:: Indicates if the object can be sent to a destination.

xgetIsSendable

org.apache.xmlbeans.XmlBoolean xgetIsSendable()

Internal Use Only.

isSetIsSendable

boolean isSetIsSendable()

Checks if the IsSendable has been set.

Returns:: true if the Sendable element has been set, otherwise false.

setIsSendable

void setIsSendable(boolean isSendable)

Indicates if the object can be sent to a destination.

Parameters:: isSendable - Indicates if the object can be sent to a destination.

xsetIsSendable

void xsetIsSendable(org.apache.xmlbeans.XmlBoolean isSendable)

Internal Use Only.

unsetIsSendable

void unsetIsSendable()

Deletes or unsets the IsSendable element.

getNextRunTime

java.util.Calendar getNextRunTime()

This property stores the date and time when the report will next be run.

Returns:: This property stores the date and time when the report will next be run.

xgetNextRunTime

org.apache.xmlbeans.XmlDateTime xgetNextRunTime()

Internal Use Only.

isSetNextRunTime

boolean isSetNextRunTime()

Checks if the NextRunTime has been set.

Returns:: true if the NextRunTime element has been set, otherwise false.

setNextRunTime

void setNextRunTime(java.util.Calendar nextRunTime)

This property stores the date and time when the report will next be run.

Parameters:: nextRunTime - This property stores the date and time when the report will next be run.

xsetNextRunTime

void xsetNextRunTime(org.apache.xmlbeans.XmlDateTime nextRunTime)

Internal Use Only.

unsetNextRunTime

void unsetNextRunTime()

Deletes or unsets the NextRunTime element.

getNewJobID

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

For a non-recurring scheduled InfoObject, the value of the SI_NEW_JOB_ID property is the SI_ID of the new instance object that is created.
For a recurring scheduled InfoObject, the value of the 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.

For a web application, if the status of an instance is 'Complete', then send out an email with the link to the instance.
Alternatively, filter the instance for alerts. That is, if the status of an instance is 'Complete', then check the instance for alerts. If there are alerts, then send out an email with the link to the instance and the alert messages.
If the status of an instance is 'Failed', then automatically re-schedule the InfoObject.

Returns:: The ID of the new instance that has just been scheduled.

xgetNewJobID

org.apache.xmlbeans.XmlString xgetNewJobID()

Internal Use Only.

isSetNewJobID

boolean isSetNewJobID()

Checks if the NewJobID has been set.

Returns:: true if the NewJobID element has been set, otherwise false.

setNewJobID

void setNewJobID(java.lang.String newJobID)

The ID of the new instance that has just been scheduled.

Parameters:: newJobID - The ID of the new instance that has just been scheduled.

xsetNewJobID

void xsetNewJobID(org.apache.xmlbeans.XmlString newJobID)

Internal Use Only.

unsetNewJobID

void unsetNewJobID()

Deletes or unsets the NewJobID element.

getStartTime

java.util.Calendar getStartTime()

The date and time that the instance actually began being processed.

Returns:: The date and time that the instance actually began being processed.

xgetStartTime

org.apache.xmlbeans.XmlDateTime xgetStartTime()

Internal Use Only.

isSetStartTime

boolean isSetStartTime()

Checks if the StartTime has been set.

Returns:: true if the StartTime element has been set, otherwise false.

setStartTime

void setStartTime(java.util.Calendar startTime)

The date and time that the instance actually began being processed.

Parameters:: startTime - The date and time that the instance actually began being processed.

xsetStartTime

void xsetStartTime(org.apache.xmlbeans.XmlDateTime startTime)

Internal Use Only.

unsetStartTime

void unsetStartTime()

Deletes or unsets the StartTime element.

getEndTime

java.util.Calendar getEndTime()

The date and time that the instance actually finished being processed.

Returns:: The date and time that the instance actually finished being processed.

xgetEndTime

org.apache.xmlbeans.XmlDateTime xgetEndTime()

Internal Use Only.

isSetEndTime

boolean isSetEndTime()

Checks if the EndTime has been set.

Returns:: true if the EndTime element has been set, otherwise false.

setEndTime

void setEndTime(java.util.Calendar endTime)

The date and time that the instance actually finished being processed.

Parameters:: endTime - The date and time that the instance actually finished being processed.

xsetEndTime

void xsetEndTime(org.apache.xmlbeans.XmlDateTime endTime)

Internal Use Only.

unsetEndTime

void unsetEndTime()

Deletes or unsets the EndTime element.

getErrorMessage

java.lang.String getErrorMessage()

Returns a localized error message for a failed job. It may include plugin-specific information.

Returns:: A String containing the error message for the failed job.

xgetErrorMessage

org.apache.xmlbeans.XmlString xgetErrorMessage()

Internal Use Only.

isSetErrorMessage

boolean isSetErrorMessage()

Checks if the ErrorMessage has been set.

Returns:: true if the ErrorMessage element has been set, otherwise false.

setErrorMessage

void setErrorMessage(java.lang.String errorMessage)

Sets a localized error message for a failed job. It may include plugin-specific information.

Parameters:: errorMessage - A String containing the error message for the failed job.

xsetErrorMessage

void xsetErrorMessage(org.apache.xmlbeans.XmlString errorMessage)

Internal Use Only.

unsetErrorMessage

void unsetErrorMessage()

Deletes or unsets the ErrorMessage element.

getStatusInfo

StatusInfo getStatusInfo()

Returns the current status of the scheduled job.

Returns:: The current status of the scheduled job.

isSetStatusInfo

boolean isSetStatusInfo()

Checks if the StatusInfo has been set.

Returns:: true if the StatusInfo element has been set, otherwise false.

setStatusInfo

void setStatusInfo(StatusInfo statusInfo)

Sets the current status of the scheduled job.

Parameters:: statusInfo - The current status of the scheduled job.

addNewStatusInfo

StatusInfo addNewStatusInfo()

Appends and returns a new empty Alert object as the last element of the array.

Returns:: The new Alert object.

unsetStatusInfo

void unsetStatusInfo()

Deletes or unsets the StatusInfo element.

getAlerts

Alerts getAlerts()

Returns a collection of Alert objects.

Returns:: A collection of Alert objects.

isSetAlerts

boolean isSetAlerts()

Checks if the Alerts element has been set.

Returns:: true if the Alerts element has been set, otherwise false.

setAlerts

void setAlerts(Alerts alerts)

Sets a collection of Alert objects.

Parameters:: alerts - A collection of Alert objects.

addNewAlerts

Alerts addNewAlerts()

Appends and returns a new empty Alerts object as the last element of the array.

Returns:: The new Alerts object.

unsetAlerts

void unsetAlerts()

Deletes or unsets the Alerts element.

getPluginInfo

PluginInfo getPluginInfo()

Returns the plugin info.

Returns:: The plugin info.

isSetPluginInfo

boolean isSetPluginInfo()

Checks if the PluginInfo has been set.

Returns:: true if the PluginInfo element has been set, otherwise false.

setPluginInfo

void setPluginInfo(PluginInfo pluginInfo)

Sets the plugin info.

Parameters:: pluginInfo - The plugin info.

addNewPluginInfo

PluginInfo addNewPluginInfo()

Appends and returns a new empty PluginInfo object as the last element of the array.

Returns:: The new PluginInfo object.

unsetPluginInfo

void unsetPluginInfo()

Deletes or unsets the PluginInfo element.

getSecurityInfo

SecurityInfo getSecurityInfo()

Returns the security information for the object.

Returns:: The security information for the object.

isSetSecurityInfo

boolean isSetSecurityInfo()

Checks if the SecurityInfo has been set.

Returns:: true if the SecurityInfo element has been set, otherwise false.

setSecurityInfo

void setSecurityInfo(SecurityInfo securityInfo)

Sets the security information for the object.

Parameters:: securityInfo - The security information for the object.

addNewSecurityInfo

SecurityInfo addNewSecurityInfo()

Appends and returns a new empty SecurityInfo object as the last element of the array.

Returns:: The new SecurityInfo object.

unsetSecurityInfo

void unsetSecurityInfo()

Deletes or unsets the SecurityInfo element.

getSecurityInfo2

SecurityInfo2 getSecurityInfo2()

Gets security roles, rights, and limits on an object for a specific user or group.

Returns:: The SecurityInfo2 object for this object.

isSetSecurityInfo2

boolean isSetSecurityInfo2()

Checks if the SecurityInfo2 has been set.

Returns:: true if the SecurityInfo element has been set, otherwise false.

setSecurityInfo2

void setSecurityInfo2(SecurityInfo2 securityInfo2)

Sets security roles, rights, and limits on an object for a specific user or group.

Parameters:: securityInfo2 - The SecurityInfo2 object for this object.

addNewSecurityInfo2

SecurityInfo2 addNewSecurityInfo2()

Appends and returns a new empty SecurityInfo2 object as the last element of the array.

Returns:: The new SecurityInfo2 object.

unsetSecurityInfo2

void unsetSecurityInfo2()

Deletes or unsets the SecurityInfo2 element.

getRolesOnObject

RolesOnObject getRolesOnObject()

Returns the custom access levels (custom roles) that are assigned to an object.

Returns:: The RolesOnObject collection containing the custom roles that are assigned to an object.

isSetRolesOnObject

boolean isSetRolesOnObject()

Checks if the RolesOnObject has been set.

Returns:: true if the RolesOnObject element has been set, otherwise false.

setRolesOnObject

void setRolesOnObject(RolesOnObject rolesOnObject)

Sets the custom access levels (custom roles) that are assigned to an object.

Parameters:: rolesOnObject - The RolesOnObject collection containing the custom roles that are assigned to an object.

addNewRolesOnObject

RolesOnObject addNewRolesOnObject()

Appends and returns a new empty RolesOnObject object as the last element of the array.

Returns:: The new RolesOnObject object.

unsetRolesOnObject

void unsetRolesOnObject()

Deletes or unsets the RolesOnObject element.

getSharedDoc

com.businessobjects.enterprise.infoobject.SharedDoc getSharedDoc()

Internal Use Only.

isSetSharedDoc

boolean isSetSharedDoc()

Internal Use Only.

setSharedDoc

void setSharedDoc(com.businessobjects.enterprise.infoobject.SharedDoc sharedDoc)

Internal Use Only.

addNewSharedDoc

com.businessobjects.enterprise.infoobject.SharedDoc addNewSharedDoc()

Internal Use Only.

unsetSharedDoc

void unsetSharedDoc()

Internal Use Only.

getKey

java.lang.String getKey()

Returns the unique hash code value of the InfoObject.

This property is only used in import and export scenarios.

Returns:: The unique hash code value of the InfoObject.

xgetKey

org.apache.xmlbeans.XmlString xgetKey()

Internal Use Only.

isSetKey

boolean isSetKey()

Checks if the Key has been set.

Returns:: true if the Key element is set, false otherwise.

setKey

void setKey(java.lang.String key)

Internal Use Only.

xsetKey

void xsetKey(org.apache.xmlbeans.XmlString key)

Internal Use Only.

unsetKey

void unsetKey()

Deletes or unsets the Key element.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.businessobjects.enterprise.infoobject Interface InfoObject

type

getID

xgetID

isSetID

setID

xsetID

unsetID

getName

xgetName

setName

xsetName

getDescription

xgetDescription

isSetDescription

setDescription

xsetDescription

unsetDescription

getCUID

xgetCUID

isSetCUID

setCUID

xsetCUID

unsetCUID

getRUID

xgetRUID

isSetRUID

setRUID

xsetRUID

unsetRUID

getKind

xgetKind

isSetKind

setKind

xsetKind

unsetKind

getOwner

xgetOwner

isSetOwner

setOwner

xsetOwner

unsetOwner

getOwnerCUID

xgetOwnerCUID

isSetOwnerCUID

setOwnerCUID

xsetOwnerCUID

unsetOwnerCUID

getParentCUID

xgetParentCUID

isSetParentCUID

setParentCUID

xsetParentCUID

unsetParentCUID

getCreationTime

xgetCreationTime

isSetCreationTime

setCreationTime

xsetCreationTime

unsetCreationTime

getUpdateTime

xgetUpdateTime

isSetUpdateTime

setUpdateTime

xsetUpdateTime

unsetUpdateTime

getKeywords

xgetKeywords

isSetKeywords

setKeywords

xsetKeywords

unsetKeywords

getChildrenObjects

xgetChildrenObjects

isSetChildrenObjects

setChildrenObjects

xsetChildrenObjects

unsetChildrenObjects

getInstance

xgetInstance

com.businessobjects.enterprise.infoobject
Interface InfoObject