com.crystaldecisions.sdk.occa.infostore
Interface IInfoObject

All Known Subinterfaces:

ICalendar, ICategory, IConnection, IContainer, IDiskUnmanaged, IEvent, IExcel, IFolder, IFTP, IFullClient, IHyperlink, IInbox, ILicenseKey, IManaged, IObjectPackage, IOverload, IPDF, IPowerPoint, IProfile, IProgram, IPublication, IReport, IRTF, IsecEnterprise, IsecLDAP, IsecWinAD, IsecWinNT, IServer, IServerGroup, IShortcut, ISMTP, ITxt, IUniverse, IUser, IUserGroup, IWebi, IWord

public interface IInfoObject

IInfoObject 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 interface

IInfoObject.PropertySet This interface defines the constants that represent properties of the IInfoObject interface.

Method Summary

void	deleteNow() Deletes the current object from the repository.
java.lang.String	getCUID() Returns the object's unique identifier within a cluster.
java.lang.String	getDescription() Returns the description of the InfoObject.
IFiles	getFiles() Returns the InfoObject's associated files.
java.lang.String	getGUID() Returns the object's globally unique identifier.
int	getID() Returns the unique ID of an InfoObject.
java.lang.String	getKeyword() Returns the keyword of the InfoObject.
java.lang.String	getKind() Returns the kind of the InfoObject.
IInfoObject	getParent() Gets the parent object for this object.
IInfoObject	getParent(int propertySet) Gets the parent object for this object.
java.lang.String	getParentCUID() Returns the parent object's cluster unique identifier.
int	getParentID() Returns the ID of the parent object.
IProcessingInfo	getProcessingInfo() Returns the processing information for the object.
java.lang.String	getProgID() Returns the prog id of this InfoObject.
java.lang.String	getRUID() Returns the object's unique identifier within an object package.
ISchedulingInfo	getSchedulingInfo() Returns the scheduling information for the object.
ISecurityInfo	getSecurityInfo() Returns the security information for the object.
java.lang.String	getTitle() Returns the title of the InfoObject.
boolean	isDirty() Returns true if any of the object's properties have been changed.
boolean	isInstance() Returns true if this object is an instance.
boolean	isMarkedAsRead() Return true if the object has been read, and false otherwise.
IProperties	properties() Returns a collection of properties.
java.lang.Integer[]	propertyIDs() Returns a collection of InfoObject property IDs.
void	retrievePropertySet(int propertySet) Retrieves the property set from the repository and adds the set of properties to the current IInfoObject object.
void	save() Saves the current object into the CMS repository.
void	setDescription(java.lang.String newDescription) Sets the description of the InfoObject.
void	setKeyword(java.lang.String keyword) Sets the keyword of the InfoObject.
void	setMarkedAsRead(boolean value) Sets a boolean that indicates whether the object has been read.
void	setParentID(int parentID) Sets the ID of the parent object.
void	setTitle(java.lang.String newTitle) Sets the title of the InfoObject.

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description of the InfoObject.

Returns:

A String containing the description of the object.

setDescription

public void setDescription(java.lang.String newDescription)

Sets the description of the InfoObject.

Parameters:

newDescription - A String containing the InfoObject's description.

getID

public int getID()

Returns the unique ID of an InfoObject.

Returns:

The unique ID of the InfoObject as an int.

isInstance

public boolean isInstance()

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.

getParentID

public int getParentID()

Returns the ID of the parent object. The ID of parent InfoObject is relative to the Enterprise hierarchy.

Returns:

The int value of the parent ID.

getProcessingInfo

public IProcessingInfo getProcessingInfo()

Returns the processing information for the object. It will be an empty reference if the object does not support processing (scheduling). In BusinessObjects Enterprise, reports, programs, and object packages can be processed.

Returns:

An IProcessingInfo object containing processing information for the object.

propertyIDs

public java.lang.Integer[] propertyIDs()

Returns a collection of InfoObject property IDs.

Returns:

An Integer array of property IDs.

properties

public IProperties properties()

Returns a collection of properties. This is an interface to the object's property bag.

Returns:

An IProperties object containing a collection of properties.

getSchedulingInfo

public ISchedulingInfo getSchedulingInfo()

Returns the scheduling information for the object. It will be an empty reference if the object does not support scheduling. In BusinessObjects Enterprise, reports, programs, and object packages can be scheduled.

Returns:

An ISchedulingInfo object containing this object's scheduling information.

getSecurityInfo

public ISecurityInfo getSecurityInfo()

Returns the security information for the object.

Returns:

The security information for the object.

getTitle

public java.lang.String getTitle()

Returns the title of the InfoObject.

Returns:

A String containing the title of the InfoObject.

setTitle

public void setTitle(java.lang.String newTitle)

Sets the title of the InfoObject.

Parameters:

newTitle - The title of the InfoObject.

getFiles

public IFiles getFiles()
                throws SDKException

Returns the InfoObject's associated files.

Returns:

An IFiles object that contains the InfoObject's associated files.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getGUID

public java.lang.String getGUID()
                         throws SDKException

Returns the object's globally unique identifier.

Note: When creating a new IInfoObject you must retrieve the SI_GUID property. Otherwise, when this method is called an exception will be thrown.

Returns:

A string representing the object's globally unique identifier

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCUID

public java.lang.String getCUID()
                         throws SDKException

Returns the object's unique identifier within a cluster.

Note: When creating a new IInfoObject you must retrieve the SI_CUID property. Otherwise, when this method is called an exception will be thrown.

Returns:

A string representing the object's cluster unique identifier.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRUID

public java.lang.String getRUID()
                         throws SDKException

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

Note: When creating a new IInfoObject you must retrieve the SI_RUID property. Otherwise, when this method is called an exception will be thrown.

Returns:

A string representing the object's package unique identifier.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setParentID

public void setParentID(int parentID)

Sets the ID of the parent object. The ID of parent InfoObject is relative to the Enterprise hierarchy.

Parameters:

parentID - A int specifying the ID of the parent object.

getParentCUID

public java.lang.String getParentCUID()
                               throws SDKException

Returns the parent object's cluster unique identifier.

Note: When creating a new IInfoObject you must retrieve the SI_PARENT_CUID property. Otherwise, when this method is called an exception will be thrown.

Returns:

String representing the parent object's cluster unique identifier.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getProgID

public java.lang.String getProgID()
                           throws SDKException

Returns the prog id of this InfoObject.

Returns:

String representing the InfoObject's ProgID.

Throws:

SDKException - This is thrown if the process is unsuccessful.

retrievePropertySet

public void retrievePropertySet(int propertySet)
                         throws SDKException

Retrieves the property set from the repository and adds the set of properties to the current IInfoObject object. Use the values in the IInfoObject.PropertySet interface as parameters.

Parameters:

propertySet - The int that specifies the PropertySet that defines the set of objects that are returned from the repository.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getParent

public IInfoObject getParent()
                      throws SDKException

Gets the parent object for this object.

Returns:

The IInfoObject that is the parent of this object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getParent

public IInfoObject getParent(int propertySet)
                      throws SDKException

Gets the parent object for this object. Use the values in the PropertySet interface.

Parameters:

propertySet - The int that specifies the PropertySet that defines the set of objects that are returned from the repository.

Returns:

The IInfoObject that is the parent of this object. Will contain the requested properties.

Throws:

SDKException - This is thrown if the process is unsuccessful.

save

public void save()
          throws SDKException

Saves the current object into the CMS repository.

Throws:

SDKException - This is thrown if the process is unsuccessful.

deleteNow

public void deleteNow()
               throws SDKException

Deletes the current object from the repository.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isDirty

public boolean isDirty()

Returns true if any of the object's properties have been changed.

Returns:

A boolean specifying whether any of the object's properties have been changed. true if any properties have changed, false otherwise.

getKeyword

public java.lang.String getKeyword()

Returns the keyword of the InfoObject.

Returns:

A String containing the keyword of the object.

setKeyword

public void setKeyword(java.lang.String keyword)
                throws SDKException

Sets the keyword of the InfoObject.

Parameters:

keyword - A String containing the InfoObject's keyword.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getKind

public java.lang.String getKind()
                         throws SDKException

Returns the kind of the InfoObject. The kind represents the InfoObject type.

Returns:

A String containing the kind of the object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isMarkedAsRead

public boolean isMarkedAsRead()
                       throws SDKException

Return true if the object has been read, and false otherwise.

Returns:

A boolean that indicates whether the object has been read.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMarkedAsRead

public void setMarkedAsRead(boolean value)

Sets a boolean that indicates whether the object has been read.