com.essbase.api.dataquery

Interface IEssLinkedObject

All Superinterfaces:

IEssBaseObject

All Known Subinterfaces:

IEssDrillThrough, IEssLinkedPartition

public interface IEssLinkedObject
extends IEssBaseObject

The IEssLinkedObject interface.

Version:

1.0, 04/04/2002

Author:

Srini Ranga

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IEssLinkedObject.EEssLinkedObjectType The EEssLinkedObjectType is an enumeration of linked object types.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreatedBy() Gets the name of the user who created the object.
java.lang.String	getDescription() Gets the object description.
int	getId() Gets the object id.
java.util.Date	getLastUpdateTime() Gets the date and time the object was last modified.
java.lang.String[]	getMemberCombination() Gets the member combination where this object is linked.
long	getNativeId() Retrieves the native Essbase id of the linked object.
byte[]	getObject() Retrieves the linked object from server to client, for file object types.
void	getObject(java.lang.String clientFileName) Retrieves the linked object from server to client, for file object types.
java.lang.String	getObjectName() Gets the linked object reference for url/file types.
IEssLinkedObject.EEssLinkedObjectType	getType() Gets the object type.
void	setDescription(java.lang.String description) Sets the object description.
void	setObjectName(java.lang.String reference) Sets the linked object reference for url/file types.
void	updatePropertyValues() Updates the property values.

Method Detail

getId

int getId()
   throws com.essbase.api.base.EssException

Gets the object id.

Returns:

The object id.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getType

IEssLinkedObject.EEssLinkedObjectType getType()
                                       throws com.essbase.api.base.EssException

Gets the object type.

Returns:

The object type.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getDescription

java.lang.String getDescription()
                         throws com.essbase.api.base.EssException

Gets the object description.

Returns:

The object description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String description)
             throws com.essbase.api.base.EssException

Sets the object description. The change will become effective after you invoke updatePropertyValues().

Parameters:

description - The object description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getObjectName

java.lang.String getObjectName()
                        throws com.essbase.api.base.EssException

Gets the linked object reference for url/file types.

Returns:

The object reference.

Throws:

com.essbase.api.base.EssException - if an error occurs.

setObjectName

void setObjectName(java.lang.String reference)
            throws com.essbase.api.base.EssException

Sets the linked object reference for url/file types. The change will become effective after you invoke updatePropertyValues().

Parameters:

reference - The object reference.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getCreatedBy

java.lang.String getCreatedBy()
                       throws com.essbase.api.base.EssException

Gets the name of the user who created the object.

Returns:

The creator name.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getLastUpdateTime

java.util.Date getLastUpdateTime()
                          throws com.essbase.api.base.EssException

Gets the date and time the object was last modified.

Returns:

The last modified time.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getMemberCombination

java.lang.String[] getMemberCombination()
                                 throws com.essbase.api.base.EssException

Gets the member combination where this object is linked.

Returns:

The member combination.

Throws:

com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                   throws com.essbase.api.base.EssException

Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues(). If you need to invoke this method multiple times, make sure to list the linked objects (using IEssDataCell.getLinkedObjects()) before every invokation of this method.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getObject

void getObject(java.lang.String clientFileName)
        throws com.essbase.api.base.EssException

Retrieves the linked object from server to client, for file object types.

Parameters:

clientFileName - The file name in the client machine where to retrieve.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getObject

byte[] getObject()
          throws com.essbase.api.base.EssException

Retrieves the linked object from server to client, for file object types.

Returns:

The object as bytes.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getNativeId

long getNativeId()
          throws com.essbase.api.base.EssException

Retrieves the native Essbase id of the linked object. Value 0 should be considered as id not applicable to this LRO.

Returns:

- the native id of the LRO.

Throws:

com.essbase.api.base.EssException - if an error occurs.