wt.intersvrcom
Class Site

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.intersvrcom.Site

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class Site

extends Simple

implements Externalizable

Use the newSite static factory method(s), not the Site 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
private String	description
static String	DESCRIPTION Label for the attribute; Description of the Site object Supported API: false
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
static String	LOCAL_MASTER Label for the attribute; A flag indicating whether this site is local master or not Supported API: false
private boolean	localMaster
private boolean	master
static String	MASTER Label for the attribute.
private String	name
static String	NAME Label for the attribute; Name of the Site object Supported API: false
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
static String	PRINCIPAL Label for the attribute.
static String	PRINCIPAL_REFERENCE Label for the attribute.
private ObjectReference	principalReference
static String	PROD_REPL_PEER Label for the attribute.
private boolean	prodReplPeer
private boolean	replica
static String	REPLICA Label for the attribute.
static String	REPOSITORY Label for the attribute.
static String	REPOSITORY_REFERENCE Label for the attribute.
private static String	RESOURCE
static String	SECURITY Label for the attribute.
static String	SECURITY_REFERENCE Label for the attribute.
private ObjectReference	securityReference
(package private) static long	serialVersionUID
private ObjectReference	theRepositoryReference
private String	url
static String	URL Label for the attribute; The URL of the Site.
private static int	URL_UPPER_LIMIT

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

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

Site()

Method Summary

private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
WTPrincipal	getPrincipal() Gets the object for the association that plays role: PRINCIPAL.
ObjectReference	getPrincipalReference() Gets the value of the attribute: PRINCIPAL_REFERENCE.
Repository	getRepository() Gets the object for the association that plays role: REPOSITORY.
ObjectReference	getRepositoryReference() Gets the value of the attribute: REPOSITORY_REFERENCE.
SiteSecurity	getSecurity() Gets the object for the association that plays role: SECURITY.
ObjectReference	getSecurityReference() Gets the value of the attribute: SECURITY_REFERENCE.
String	getUrl() Gets the value of the attribute: URL.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isLocalMaster() Gets the value of the attribute: LOCAL_MASTER.
boolean	isMaster() Gets the value of the attribute: MASTER.
boolean	isProdReplPeer() Gets the value of the attribute: PROD_REPL_PEER.
boolean	isReplica() Gets the value of the attribute: REPLICA.
private void	nameValidate(String a_Name)
static Site	newSite() Default factory for the class.
private void	principalReferenceValidate(ObjectReference a_PrincipalReference)
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(Site thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	securityReferenceValidate(ObjectReference a_SecurityReference)
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setLocalMaster(boolean a_LocalMaster) Sets the value of the attribute: LOCAL_MASTER.
void	setMaster(boolean a_Master) Sets the value of the attribute: MASTER.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setPrincipal(WTPrincipal a_Principal) Sets the object for the association that plays role: PRINCIPAL.
void	setPrincipalReference(ObjectReference a_PrincipalReference) Sets the value of the attribute: PRINCIPAL_REFERENCE.
void	setProdReplPeer(boolean a_ProdReplPeer) Sets the value of the attribute: PROD_REPL_PEER.
void	setReplica(boolean a_Replica) Sets the value of the attribute: REPLICA.
void	setRepository(Repository a_Repository) Sets the object for the association that plays role: REPOSITORY.
void	setRepositoryReference(ObjectReference a_RepositoryReference) Sets the value of the attribute: REPOSITORY_REFERENCE.
void	setSecurity(SiteSecurity a_Security) Sets the object for the association that plays role: SECURITY.
void	setSecurityReference(ObjectReference a_SecurityReference) Sets the value of the attribute: SECURITY_REFERENCE.
void	setUrl(String a_Url) Sets the value of the attribute: URL.
private void	theRepositoryReferenceValidate(ObjectReference a_RepositoryReference)
private void	urlValidate(String a_Url)
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.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

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

NAME

public static final String NAME

Label for the attribute; Name of the Site object

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

URL

public static final String URL

Label for the attribute; The URL of the Site. Example: http://

/wtcgi-bin/wtcgi.exe. It should correspond to the site's anonimous url, as defined in its wt.properties.

Supported API: false

See Also:

Constant Field Values

URL_UPPER_LIMIT

private static int URL_UPPER_LIMIT

url

private String url

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Description of the Site object

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

MASTER

public static final String MASTER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

master

private boolean master

REPLICA

public static final String REPLICA

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

replica

private boolean replica

PROD_REPL_PEER

public static final String PROD_REPL_PEER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

prodReplPeer

private boolean prodReplPeer

LOCAL_MASTER

public static final String LOCAL_MASTER

Label for the attribute; A flag indicating whether this site is local master or not

Supported API: false

See Also:

Constant Field Values

localMaster

private boolean localMaster

SECURITY

public static final String SECURITY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SECURITY_REFERENCE

public static final String SECURITY_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

securityReference

private ObjectReference securityReference

PRINCIPAL

public static final String PRINCIPAL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PRINCIPAL_REFERENCE

public static final String PRINCIPAL_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

principalReference

private ObjectReference principalReference

REPOSITORY

public static final String REPOSITORY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

REPOSITORY_REFERENCE

public static final String REPOSITORY_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theRepositoryReference

private ObjectReference theRepositoryReference

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

Site

public Site()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Simple

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

getName

public String getName()

Gets the value of the attribute: NAME. Name of the Site object

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Name of the Site object

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getUrl

public String getUrl()

Gets the value of the attribute: URL. The URL of the Site. Example: http://

/wtcgi-bin/wtcgi.exe. It should correspond to the site's anonimous url, as defined in its wt.properties.

Supported API: false

Returns:

String

setUrl

public void setUrl(String a_Url)
            throws WTPropertyVetoException

Sets the value of the attribute: URL. The URL of the Site. Example: http://

/wtcgi-bin/wtcgi.exe. It should correspond to the site's anonimous url, as defined in its wt.properties.

Supported API: false

Parameters:

a_Url -

Throws:

WTPropertyVetoException

urlValidate

private void urlValidate(String a_Url)
                  throws WTPropertyVetoException

Parameters:

a_Url -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Description of the Site object

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Description of the Site object

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isMaster

public boolean isMaster()

Gets the value of the attribute: MASTER.

Supported API: false

Returns:

boolean

setMaster

public void setMaster(boolean a_Master)
               throws WTPropertyVetoException

Sets the value of the attribute: MASTER.

Supported API: false

Parameters:

a_Master -

Throws:

WTPropertyVetoException

isReplica

public boolean isReplica()

Gets the value of the attribute: REPLICA.

Supported API: false

Returns:

boolean

setReplica

public void setReplica(boolean a_Replica)
                throws WTPropertyVetoException

Sets the value of the attribute: REPLICA.

Supported API: false

Parameters:

a_Replica -

Throws:

WTPropertyVetoException

isProdReplPeer

public boolean isProdReplPeer()

Gets the value of the attribute: PROD_REPL_PEER.

Supported API: false

Returns:

boolean

setProdReplPeer

public void setProdReplPeer(boolean a_ProdReplPeer)
                     throws WTPropertyVetoException

Sets the value of the attribute: PROD_REPL_PEER.

Supported API: false

Parameters:

a_ProdReplPeer -

Throws:

WTPropertyVetoException

isLocalMaster

public boolean isLocalMaster()

Gets the value of the attribute: LOCAL_MASTER. A flag indicating whether this site is local master or not

Supported API: false

Returns:

boolean

setLocalMaster

public void setLocalMaster(boolean a_LocalMaster)
                    throws WTPropertyVetoException

Sets the value of the attribute: LOCAL_MASTER. A flag indicating whether this site is local master or not

Supported API: false

Parameters:

a_LocalMaster -

Throws:

WTPropertyVetoException

getSecurity

public SiteSecurity getSecurity()

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

Supported API: false

Returns:

SiteSecurity

setSecurity

public void setSecurity(SiteSecurity a_Security)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Security -

Throws:

WTPropertyVetoException

WTException

getSecurityReference

public ObjectReference getSecurityReference()

Gets the value of the attribute: SECURITY_REFERENCE.

Supported API: false

Returns:

ObjectReference

setSecurityReference

public void setSecurityReference(ObjectReference a_SecurityReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: SECURITY_REFERENCE.

Supported API: false

Parameters:

a_SecurityReference -

Throws:

WTPropertyVetoException

securityReferenceValidate

private void securityReferenceValidate(ObjectReference a_SecurityReference)
                                throws WTPropertyVetoException

Parameters:

a_SecurityReference -

Throws:

WTPropertyVetoException

getPrincipal

public WTPrincipal getPrincipal()

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

Supported API: false

Returns:

WTPrincipal

setPrincipal

public void setPrincipal(WTPrincipal a_Principal)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Parameters:

a_Principal -

Throws:

WTPropertyVetoException

WTException

getPrincipalReference

public ObjectReference getPrincipalReference()

Gets the value of the attribute: PRINCIPAL_REFERENCE.

Supported API: false

Returns:

ObjectReference

setPrincipalReference

public void setPrincipalReference(ObjectReference a_PrincipalReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: PRINCIPAL_REFERENCE.

Supported API: false

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

principalReferenceValidate

private void principalReferenceValidate(ObjectReference a_PrincipalReference)
                                 throws WTPropertyVetoException

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

getRepository

public Repository getRepository()

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

Supported API: false

Returns:

Repository

setRepository

public void setRepository(Repository a_Repository)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: false

Parameters:

a_Repository -

Throws:

WTPropertyVetoException

WTException

getRepositoryReference

public ObjectReference getRepositoryReference()

Gets the value of the attribute: REPOSITORY_REFERENCE.

Supported API: false

Returns:

ObjectReference

setRepositoryReference

public void setRepositoryReference(ObjectReference a_RepositoryReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: REPOSITORY_REFERENCE.

Supported API: false

Parameters:

a_RepositoryReference -

Throws:

WTPropertyVetoException

theRepositoryReferenceValidate

private void theRepositoryReferenceValidate(ObjectReference a_RepositoryReference)
                                     throws WTPropertyVetoException

Parameters:

a_RepositoryReference -

Throws:

WTPropertyVetoException

newSite

public static Site newSite()
                    throws WTException

Default factory for the class.

Supported API: false

Returns:

Site

Throws:

WTException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Simple

Returns:

int