Skip navigation links


com.essbase.eas.essbase.defs
Interface NamedObject

All Known Implementing Classes:
DefaultAliasTableFileObject, DefaultCalcScript, DefaultCSVFileObject, DefaultExcelFileObject, DefaultFilter, DefaultLotusFileObject, DefaultNamedObject, DefaultOutlineFileObject, DefaultPartitionDefinition, DefaultReportScript, DefaultRulesObject, DefaultTextFileObject

public interface NamedObject

Defines an interface for Essbase named objects. Types include, but are not limited to,calculation scripts, report scripts, lros, rules files, partition definitions.

Version:
1.00, 01/04/2001
Author:
Hank Cox

Method Summary
 void addListener(NamedObjectListener l)
          adds a listener to this object's list of listeners.
 java.lang.String getAsText()
          returns a text representation of this object.
 long getFileSize()
          returns the physical size of this object; typically, this represents the size of the object within the file system on the specific Essbase server.
 java.util.Calendar getLastUpdate()
          returns the date/time that the object was last updated.
 boolean getLocked()
          returns a flag indicating the locked status of this object.
 java.lang.String getLockedBy()
          returns the user name that has this object locked; valid only if the locked field is true.
 java.lang.String getName()
          returns the name associated with this Essbase object.
 java.lang.String getNamedType()
          returns the "named type" of this object.
 java.lang.Object getOwner()
          retrieves the owner of this object; will usually be an Application or Database object.
 Application getOwnerAsApplication()
          retrieves the owner of this object as an application object.
 Database getOwnerAsDatabase()
          retrieves the owner of this object as a database object.
 Server getOwnerServer()
          retrieves the server this object is contained.
 boolean getRequiresDatabase()
          returns a flag indicating whether this object can be saved at the application level.
 NamedObjectType getType()
          returns the "type" of this object as a NamedObjectType.
 java.util.Calendar getWhenLocked()
          returns the date/time that the object was locked; valid only if the locked field is true.
 void removeListener(NamedObjectListener l)
          removes a listener from this object's list of listeners.
 void setFileSize(long value)
          sets the physical size of this object.
 void setLastUpdate(java.util.Calendar value)
          sets the date/time that the object was last updated.
 void setLocked(boolean value)
          sets the flag indicating the locked status of this object.
 void setLockedBy(java.lang.String value)
          sets the user name that has this object locked.
 void setName(java.lang.String value)
          sets the name associated with this Essbase object.
 void setOwner(java.lang.Object value)
          sets the owner of this object; this should be an Application or Database object.
 void setText(java.lang.String value)
          sets the text representation of this object.
 void setWhenLocked(java.util.Calendar value)
          sets the date/time that the object was locked.

 

Method Detail

getOwner

java.lang.Object getOwner()
retrieves the owner of this object; will usually be an Application or Database object.

setOwner

void setOwner(java.lang.Object value)
sets the owner of this object; this should be an Application or Database object. However, we aren't currently enforcing this rule.

getOwnerServer

Server getOwnerServer()
retrieves the server this object is contained. Question: Should this throw an exception of some type?

getOwnerAsApplication

Application getOwnerAsApplication()
retrieves the owner of this object as an application object. If the owner is a database, then returns null. Question: Should this throw an exception of some type?

getOwnerAsDatabase

Database getOwnerAsDatabase()
retrieves the owner of this object as a database object. If the owner is an application, then returns null. Question: Should this throw an exception.

getName

java.lang.String getName()
returns the name associated with this Essbase object.

setName

void setName(java.lang.String value)
sets the name associated with this Essbase object.

getRequiresDatabase

boolean getRequiresDatabase()
returns a flag indicating whether this object can be saved at the application level. false means application level is Ok; true means that the object can only exist at the database level.

getFileSize

long getFileSize()
returns the physical size of this object; typically, this represents the size of the object within the file system on the specific Essbase server.

setFileSize

void setFileSize(long value)
sets the physical size of this object.

getLocked

boolean getLocked()
returns a flag indicating the locked status of this object.

setLocked

void setLocked(boolean value)
sets the flag indicating the locked status of this object.

getLockedBy

java.lang.String getLockedBy()
returns the user name that has this object locked; valid only if the locked field is true.

setLockedBy

void setLockedBy(java.lang.String value)
sets the user name that has this object locked.

getWhenLocked

java.util.Calendar getWhenLocked()
returns the date/time that the object was locked; valid only if the locked field is true.

setWhenLocked

void setWhenLocked(java.util.Calendar value)
sets the date/time that the object was locked.

getLastUpdate

java.util.Calendar getLastUpdate()
returns the date/time that the object was last updated. Valid only if the object has ever been saved.

setLastUpdate

void setLastUpdate(java.util.Calendar value)
sets the date/time that the object was last updated.

getAsText

java.lang.String getAsText()
returns a text representation of this object. Note: this is not necessarilly the same as toString();

setText

void setText(java.lang.String value)
sets the text representation of this object.

getNamedType

java.lang.String getNamedType()
returns the "named type" of this object. Normally, this is something along the lines of "Calculation Script", "Report Script", etc.

getType

NamedObjectType getType()
returns the "type" of this object as a NamedObjectType. The object type definitions can be found in FileObjectTypes.

addListener

void addListener(NamedObjectListener l)
adds a listener to this object's list of listeners.

removeListener

void removeListener(NamedObjectListener l)
removes a listener from this object's list of listeners.

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.