wt.inf.container
Class PublicDomainLink

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fc.ObjectToObjectLink
          extended bywt.fc.ForeignKeyLink
              extended bywt.inf.container.PublicDomainLink
All Implemented Interfaces:
BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public final class PublicDomainLink
extends ForeignKeyLink
implements Externalizable

Use the newPublicDomainLink static factory method(s), not the PublicDomainLink 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
           
static String PUBLIC_PARENT_DOMAIN_ROLE
          Label for the attribute; The domain that should serve as the parent of the container's defaultDomain.
private static String RESOURCE
           
(package private) static long serialVersionUID
           
static String WTCONTAINER_ROLE
          Label for the attribute.
 
Fields inherited from class wt.fc.ObjectToObjectLink
ROLE_AOBJECT_REF, ROLE_BOBJECT_REF
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.fc.BinaryLink
ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
PublicDomainLink()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
 AdministrativeDomain getPublicParentDomain()
          Gets the object for the association that plays role: PUBLIC_PARENT_DOMAIN_ROLE.
 WTContainer getWTContainer()
          Gets the object for the association that plays role: WTCONTAINER_ROLE.
static PublicDomainLink newPublicDomainLink(AdministrativeDomain publicParentDomain, WTContainer theWTContainer)
          Default factory for the class.
 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(PublicDomainLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setPublicParentDomain(AdministrativeDomain publicParentDomain)
          Sets the object for the association that plays role: PUBLIC_PARENT_DOMAIN_ROLE.
 void setWTContainer(WTContainer theWTContainer)
          Sets the object for the association that plays role: WTCONTAINER_ROLE.
 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 wt.fc.ForeignKeyLink
equals, hashCode, readVersion
 
Methods inherited from class wt.fc.ObjectToObjectLink
appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject
 
Methods inherited from class wt.fc.WTObject
checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface wt.fc.Persistable
checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo
 
Methods inherited from interface wt.fc.NetFactor
getClassInfo
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

PUBLIC_PARENT_DOMAIN_ROLE

public static final String PUBLIC_PARENT_DOMAIN_ROLE
Label for the attribute; The domain that should serve as the parent of the container's defaultDomain. Storing this reference allows the container to remember its parent public domain when the privateAccess property is true.

If a container has already been run through the create process, then WTContainerService.changePublicParentDomain should be used to change this property.

Supported API: false

See Also:
Constant Field Values

WTCONTAINER_ROLE

public static final String WTCONTAINER_ROLE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

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

PublicDomainLink

public PublicDomainLink()
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 ForeignKeyLink
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 ForeignKeyLink
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(PublicDomainLink 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
Overrides:
writeExternal in class ForeignKeyLink
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
Overrides:
readExternal in class ForeignKeyLink
Parameters:
input -
Throws:
SQLException
DatastoreException

getPublicParentDomain

public AdministrativeDomain getPublicParentDomain()
Gets the object for the association that plays role: PUBLIC_PARENT_DOMAIN_ROLE. The domain that should serve as the parent of the container's defaultDomain. Storing this reference allows the container to remember its parent public domain when the privateAccess property is true.

If a container has already been run through the create process, then WTContainerService.changePublicParentDomain should be used to change this property.

Supported API: false

Returns:
AdministrativeDomain

setPublicParentDomain

public void setPublicParentDomain(AdministrativeDomain publicParentDomain)
                           throws WTPropertyVetoException
Sets the object for the association that plays role: PUBLIC_PARENT_DOMAIN_ROLE. The domain that should serve as the parent of the container's defaultDomain. Storing this reference allows the container to remember its parent public domain when the privateAccess property is true.

If a container has already been run through the create process, then WTContainerService.changePublicParentDomain should be used to change this property.

Supported API: false

Parameters:
publicParentDomain -
Throws:
WTPropertyVetoException

getWTContainer

public WTContainer getWTContainer()
Gets the object for the association that plays role: WTCONTAINER_ROLE.

Supported API: false

Returns:
WTContainer

setWTContainer

public void setWTContainer(WTContainer theWTContainer)
                    throws WTPropertyVetoException
Sets the object for the association that plays role: WTCONTAINER_ROLE.

Supported API: false

Parameters:
theWTContainer -
Throws:
WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

newPublicDomainLink

public static PublicDomainLink newPublicDomainLink(AdministrativeDomain publicParentDomain,
                                                   WTContainer theWTContainer)
                                            throws WTException
Default factory for the class.

Supported API: false

Parameters:
publicParentDomain -
theWTContainer -
Returns:
PublicDomainLink
Throws:
WTException