wt.epm.workspaces
Class EPMWorkspaceIdentity

java.lang.Object
  wt.fc.IdentificationObject
      wt.epm.workspaces.EPMWorkspaceIdentity

All Implemented Interfaces:

Externalizable, NetFactor, Serializable

public class EPMWorkspaceIdentity

extends IdentificationObject

implements Externalizable

The uniqueness constraint of name and owner on the master.

Use the newEPMWorkspaceIdentity static factory method(s), not the EPMWorkspaceIdentity constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	principal
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.IdentificationObject

Constructor Summary

EPMWorkspaceIdentity()

Method Summary

String	getConceptualClassname() Deprecated.
String	getIdentity() Constructs and returns a string representing the object's identity.
protected String	getKeyClassName() Supported API: false
String	getName() Gets the value of the attribute: name.
WTPrincipalReference	getPrincipal() Gets the value of the attribute: principal.
protected void	initialize(String name, WTPrincipalReference principal) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static EPMWorkspaceIdentity	newEPMWorkspaceIdentity(String name, WTPrincipalReference principal) Supported API: false
private void	principalValidate(WTPrincipalReference a_Principal)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EPMWorkspaceIdentity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setName(String a_Name) Sets the value of the attribute: name.
void	setPrincipal(WTPrincipalReference a_Principal) Sets the value of the attribute: principal.
protected void	setToObject(Identified obj) Updates the identity of the object passed as argument with the identity held in the object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.fc.IdentificationObject

changeIdentity, checkIdentity, createKey, getClassInfo, getSemanticKey, initialize, readVersion, setAdditionalKeyAttributes, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

principal

private WTPrincipalReference principal

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

Constructor Detail

EPMWorkspaceIdentity

public EPMWorkspaceIdentity()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class IdentificationObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class IdentificationObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMWorkspaceIdentity thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getName

public String getName()

Gets the value of the attribute: name.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getPrincipal

public WTPrincipalReference getPrincipal()

Gets the value of the attribute: principal.

Supported API: false

Returns:

WTPrincipalReference

setPrincipal

public void setPrincipal(WTPrincipalReference a_Principal)
                  throws WTPropertyVetoException

Sets the value of the attribute: principal.

Supported API: false

Parameters:

a_Principal -

Throws:

WTPropertyVetoException

principalValidate

private void principalValidate(WTPrincipalReference a_Principal)
                        throws WTPropertyVetoException

Parameters:

a_Principal -

Throws:

WTPropertyVetoException

getKeyClassName

protected String getKeyClassName()

Supported API: false

Overrides:

getKeyClassName in class IdentificationObject

Returns:

String

newEPMWorkspaceIdentity

public static EPMWorkspaceIdentity newEPMWorkspaceIdentity(String name,
                                                           WTPrincipalReference principal)
                                                    throws WTException

Supported API: false

Parameters:

name -

principal -

Returns:

EPMWorkspaceIdentity

Throws:

WTException

initialize

protected void initialize(String name,
                          WTPrincipalReference principal)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

name -

principal -

Throws:

WTException

getIdentity

public String getIdentity()

Constructs and returns a string representing the object's identity. This is an abstract method that must be implemented by classes extending the IdentifiactionObject class. A straightforward way of build a string representation of the identity is to concatenate the attributes that constitute the identity, using an appropriate separator.

Supported API: false

Specified by:

getIdentity in class IdentificationObject

Returns:

String

setToObject

protected void setToObject(Identified obj)
                    throws WTException

Updates the identity of the object passed as argument with the identity held in the object.

Supported API: false

Specified by:

setToObject in class IdentificationObject

Parameters:

obj -

Throws:

WTException