Skip navigation links

oracle.odi.domain.shortcuts
Interface IOdiShortcutable<T>

All Known Implementing Classes:

OdiDataStore, OdiInterface, OdiPackage, OdiUserProcedure

public interface IOdiShortcutable<T>

Interface for objects that can be shortcuts.

Since:

11.1.1.6.0

See Also:

OdiDataStore, OdiPackage, OdiUserProcedure, OdiInterface

Method Summary

T	getRealObject() Return the real object associated with this object.
IReleaseTag	getReleaseTag() Return the release tag for this object.
T	getShortcutBaseObject() Return the base object of this shortcutable.
T	getShortcutOrigObject() If this is a shortcut, return the original base object
T	getShortcutReferenceObject() If this is a shortcut, return the reference object.
boolean	isShortcut() Returns true if this object is a shortcut.
boolean	setShortcutBaseObject(T pBaseObject) Internal Use Only.
boolean	setShortcutReferenceObject(T pShortcutable) Internal Use Only.

Method Detail

getShortcutBaseObject

T getShortcutBaseObject()

Return the base object of this shortcutable.

This will return null if the object never has been a shortcut. If this object is a materialized shortcut, the base object will be the base object at the time that this was shortcuted.

Returns:

T base object of this shortcut.

setShortcutBaseObject

boolean setShortcutBaseObject(T pBaseObject)

Internal Use Only. Set the base object of this shortcutable.

If the base object is changed, we should correct all consumers of this object.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.

Parameters:

pBaseObject - new base object.

Returns:

true if this object was actually modified, else return false.

getShortcutReferenceObject

T getShortcutReferenceObject()

If this is a shortcut, return the reference object.

The reference object may also be a shortcut.

Returns:

T reference object of this shortcut.

Throws:

java.lang.IllegalStateException - if this object is not a shortcut.

setShortcutReferenceObject

boolean setShortcutReferenceObject(T pShortcutable)

Internal Use Only. Set reference of this shortcut.

If pShortcutable is null, set pReference to null. This is no longer a shortcut.
If pShortcutable is not null, set the reference object to pShortcutable, set the base object to pShortcutable.getBaseObject.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.

Parameters:

pShortcutable - new shortcutable object. Can be be null

Returns:

true if this object was actually modified. Else return false;

getShortcutOrigObject

T getShortcutOrigObject()

If this is a shortcut, return the original base object

The reference object may also be a shortcut.

Returns:

T reference object of this shortcut.

Throws:

java.lang.IllegalStateException - if this object is not a shortcut.

isShortcut

boolean isShortcut()

Returns true if this object is a shortcut.

Returns:

true if this object is a shortcut. Else return false.

getReleaseTag

IReleaseTag getReleaseTag()

Return the release tag for this object.

release tag is actually maintained on the container object. This provides consistent access to the tag.

Returns:

Release tag of container object.

getRealObject

T getRealObject()

Return the real object associated with this object.

This is a convenience function to obtain the real object of a shortcutable object. If this object is a shortcut, return the base obejct. If this object is not a shortcut, return this object.

Returns:

Real object. The real object could be either this object or the base object.

Skip navigation links