wt.ownership
Class Ownership

java.lang.Object
  wt.ownership.Ownership

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class Ownership

extends Object

implements ObjectMappable, Externalizable

This cookie maintains the persistent state of an Ownable object.

Use the newOwnership static factory method(s), not the Ownership 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
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	owner
static String	OWNER Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

Ownership()

Method Summary

protected void	assign(WTPrincipal p) Assign ownership to the supplied WTPrincipal.
protected boolean	equals(Ownership ownership) Supported API: false
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
WTPrincipalReference	getOwner() Gets the object for the association that plays role: OWNER.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(Ownership ownership) Supports initialization, following construction of an instance.
protected void	initialize(WTPrincipal p) Supports initialization, following construction of an instance.
static Ownership	newOwnership() Construct an Ownership object with no current owner.
static Ownership	newOwnership(Ownership ownership) Construct an Ownership object with the same ownership characteristics as the supplied Ownership object.
static Ownership	newOwnership(WTPrincipal p) Construct an Ownership object with the supplied WTPrincipal as the owner.
protected boolean	notOwned() Supported API: false
protected boolean	owned() Determine if Ownership has been set to any WTPrincipal.
protected boolean	owned(WTPrincipal p) Determine if Ownership belongs to the specified WTPrincipal.
private void	ownerValidate(WTPrincipalReference a_Owner)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
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(Ownership thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	release() Release ownership.
void	setOwner(WTPrincipalReference a_Owner) Sets the object for the association that plays role: OWNER.
String	toString() Return the ObjectIdentifier of the Owner
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

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

OWNER

public static final String OWNER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

owner

private WTPrincipalReference owner

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

Constructor Detail

Ownership

public Ownership()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Ownership 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

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Return the ObjectIdentifier of the Owner

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getOwner

public WTPrincipalReference getOwner()

Gets the object for the association that plays role: OWNER.

Supported API: false

Returns:

WTPrincipalReference

setOwner

public void setOwner(WTPrincipalReference a_Owner)
              throws WTPropertyVetoException

Sets the object for the association that plays role: OWNER.

Supported API: false

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

ownerValidate

private void ownerValidate(WTPrincipalReference a_Owner)
                    throws WTPropertyVetoException

Parameters:

a_Owner -

Throws:

WTPropertyVetoException

owned

protected boolean owned()

Determine if Ownership has been set to any WTPrincipal.

Supported API: false

Returns:

boolean

owned

protected boolean owned(WTPrincipal p)
                 throws WTException

Determine if Ownership belongs to the specified WTPrincipal. If Ownership is a group and the specified WTPrincipal is a member of the group, then return true.

Supported API: false

Parameters:

p -

Returns:

boolean

Throws:

WTException

notOwned

protected boolean notOwned()

Supported API: false

Returns:

boolean

assign

protected void assign(WTPrincipal p)
               throws WTException

Assign ownership to the supplied WTPrincipal.

Supported API: false

Parameters:

p -

Throws:

WTException

release

protected void release()
                throws WTException

Release ownership.

Supported API: false

Throws:

WTException

equals

protected boolean equals(Ownership ownership)

Supported API: false

Parameters:

ownership -

Returns:

boolean

newOwnership

public static Ownership newOwnership()
                              throws WTException

Construct an Ownership object with no current owner.

Supported API: false

Returns:

Ownership

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: false

Throws:

WTException

newOwnership

public static Ownership newOwnership(Ownership ownership)
                              throws WTException

Construct an Ownership object with the same ownership characteristics as the supplied Ownership object.

Supported API: false

Parameters:

ownership -

Returns:

Ownership

Throws:

WTException

initialize

protected void initialize(Ownership ownership)
                   throws WTException

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

Supported API: false

Parameters:

ownership -

Throws:

WTException

newOwnership

public static Ownership newOwnership(WTPrincipal p)
                              throws WTException

Construct an Ownership object with the supplied WTPrincipal as the owner.

Supported API: false

Parameters:

p -

Returns:

Ownership

Throws:

WTException

initialize

protected void initialize(WTPrincipal p)
                   throws WTException

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

Supported API: false

Parameters:

p -

Throws:

WTException