org.palo.api
Interface PaloObject

All Superinterfaces:
NamedEntity, Writable
All Known Subinterfaces:
Cube, Database, Dimension, Element, Hierarchy, Property2, Subset2
All Known Implementing Classes:
HierarchyImpl, Property2Impl

public interface PaloObject
extends NamedEntity, Writable

PaloObject

A palo object extends the NamedEntity interface by adding an identifier to it. This identifier could be used to reference the palo object within the scope of its parent.

NOTE: The id is only unique within the scope of the parent of this palo object, e.g. an Element id is only unique within its Dimension but not Database wide. Furthermore note that an id could be reused that means, in case of a deletion of a palo object its corresponding id could later be assigned to a newly created one!

Version:
$Id: PaloObject.html,v 1.17 2009/07/09 11:01:46 ArndHouben Exp $

Field Summary
static int TYPE_ATTRIBUTE
           
static int TYPE_NORMAL
           
static int TYPE_SYSTEM
           
static int TYPE_USER_INFO
           
 
Method Summary
 java.lang.String getId()
          Returns the unique identifier of this palo object.
 int getType()
          TODO please comment :)
 
Methods inherited from interface org.palo.api.NamedEntity
getName
 
Methods inherited from interface org.palo.api.Writable
canBeModified, canCreateChildren
 

Field Detail

TYPE_NORMAL

static final int TYPE_NORMAL
See Also:
Constant Field Values

TYPE_SYSTEM

static final int TYPE_SYSTEM
See Also:
Constant Field Values

TYPE_ATTRIBUTE

static final int TYPE_ATTRIBUTE
See Also:
Constant Field Values

TYPE_USER_INFO

static final int TYPE_USER_INFO
See Also:
Constant Field Values
Method Detail

getId

java.lang.String getId()
Returns the unique identifier of this palo object.

Important note: for a correct usage please note that the returned id is only unique within the parent scope of this palo object. Furthermore in case of deletion the id is reused, i.e. if a palo object is removed its id could be given to a newly created palo object afterwards!!

Returns:
id of the palo object.

getType

int getType()
TODO please comment :)

Returns:
the type of this palo object