Skip navigation links

com.essbase.eas.essbase.api.core
Class Handle

java.lang.Object
com.essbase.eas.essbase.api.core.Handle

Direct Known Subclasses:

ContextHandle, InstanceHandle, MemberHandle, OutlineHandle, SmartListHandle

public abstract class Handle

extends java.lang.Object

This class defines a generic Handle class.

Notes:

• 06/17/2000, hcox: Do we need to define a value for "Invalid Handle"?

Version:

1.00, 06/17/2000

Author:

Hank Cox

See Also:

InstanceHandle, ContextHandle

Constructor Summary

protected	Handle() Protected no argument constructor.
protected	Handle(long handle) Protected constructor with an initializer.

Method Summary

long	getValue() Retrieves the current value of the handle.
void	invalidate() forces the handle to be invalid.
boolean	isValid() determines if the handle has "valid" value.
void	setValue(long newValue) Modifies the value of the handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Handle

protected Handle()

Protected no argument constructor. Since this is an abstract class, we only want the derived classes to be able to call the constructor.

Handle

protected Handle(long handle)

Protected constructor with an initializer.

Method Detail

invalidate

public void invalidate()

forces the handle to be invalid.

isValid

public boolean isValid()

determines if the handle has "valid" value. This method must be implemented by any derived classes.

getValue

public long getValue()

Retrieves the current value of the handle.

setValue

public void setValue(long newValue)

Modifies the value of the handle.

Skip navigation links