Skip navigation links

com.essbase.eas.essbase.defs.outline
Class Identifier

java.lang.Object
com.essbase.eas.essbase.defs.outline.Identifier

All Implemented Interfaces:

java.io.Serializable

public class Identifier

extends java.lang.Object

implements java.io.Serializable

provides a mechanism for identifying an outline across remote implementation sites. In particular, for the server side it provides a mechanism that can be used to store the information required by the API to access an outline that has been opened and needs to stay open between http requests. For the client side, it provides a mechanism to easily transmit information about the open outline in one http parameter.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

See Also:

Serialized Form

Constructor Summary

Identifier()

Identifier(Database db)
creates an identifier using a Database object as the source.

Identifier(java.lang.String serverID, java.lang.String applicationID, java.lang.String databaseID)
creates an identifier object with the defined field values.

Identifier(java.lang.String serverID, java.lang.String applicationID, java.lang.String databaseID, java.lang.Object userObject)
creates an identifier object with the defined field values and a specific user object.

Method Summary

java.lang.String	getApplicationID()
java.lang.String	getClientName()
java.lang.String	getDatabaseID()
boolean	getDeleteLocalFile()
java.lang.String	getDLN()
boolean	getEditMode()
java.lang.String	getLocalName()
java.lang.String	getServerID()
java.lang.Object	getUserObject()
boolean	isServerBased()
boolean	isValidIdentifier()
void	setApplicationID(java.lang.String value)
void	setClientName(java.lang.String value)
void	setDatabaseID(java.lang.String value)
void	setDeleteLocalFile(boolean delete)
void	setEditMode(boolean b)
void	setLocalName(java.lang.String value)
void	setServerID(java.lang.String value)
void	setUserObject(java.lang.Object value)
java.lang.String	toMemberTransferString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Identifier

public Identifier()

Identifier

public Identifier(java.lang.String serverID,
                  java.lang.String applicationID,
                  java.lang.String databaseID)

creates an identifier object with the defined field values.

Identifier

public Identifier(java.lang.String serverID,
                  java.lang.String applicationID,
                  java.lang.String databaseID,
                  java.lang.Object userObject)

creates an identifier object with the defined field values and a specific user object.

Identifier

public Identifier(Database db)

creates an identifier using a Database object as the source.

Method Detail

getUserObject

public java.lang.Object getUserObject()

setUserObject

public void setUserObject(java.lang.Object value)

getServerID

public java.lang.String getServerID()

setServerID

public void setServerID(java.lang.String value)

getApplicationID

public java.lang.String getApplicationID()

setApplicationID

public void setApplicationID(java.lang.String value)

getDatabaseID

public java.lang.String getDatabaseID()

setDatabaseID

public void setDatabaseID(java.lang.String value)

getEditMode

public boolean getEditMode()

setEditMode

public void setEditMode(boolean b)

setLocalName

public void setLocalName(java.lang.String value)

getLocalName

public java.lang.String getLocalName()

getDLN

public java.lang.String getDLN()

setClientName

public void setClientName(java.lang.String value)

getClientName

public java.lang.String getClientName()

setDeleteLocalFile

public void setDeleteLocalFile(boolean delete)

getDeleteLocalFile

public boolean getDeleteLocalFile()

isServerBased

public boolean isServerBased()

isValidIdentifier

public boolean isValidIdentifier()

toMemberTransferString

public java.lang.String toMemberTransferString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Skip navigation links