wt.inf.container
Class CreatorsLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.inf.container.CreatorsLink

All Implemented Interfaces:

BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public final class CreatorsLink

extends ObjectToObjectLink

implements Externalizable

Maps an OrgContainer to a WTGroup that contains the users that should be allowed to create a certain container type within the org container.

Use the newCreatorsLink static factory method(s), not the CreatorsLink 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

static String	AUTO_POPULATE Label for the attribute; Specifies whether or not members of the org should be automatically added to the creators group when they are created.
private boolean	autoPopulate
private static String	CLASSNAME
static String	CONTAINER_CLASS Label for the attribute; The class of container that the creators group is configured for.
protected static String	CONTAINER_CLASS_NAME Label for the attribute.
private static int	CONTAINER_CLASS_NAME_UPPER_LIMIT
static String	CONTAINER_ROLE Label for the attribute.
private Class	containerClass
private String	containerClassName
static String	CREATORS_ROLE Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

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

CreatorsLink()

Method Summary

private void	containerClassNameValidate(String a_ContainerClassName)
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.
OrgContainer	getContainer() Gets the object for the association that plays role: CONTAINER_ROLE.
Class	getContainerClass() Gets the value of the attribute: CONTAINER_CLASS.
protected String	getContainerClassName() Gets the value of the attribute: CONTAINER_CLASS_NAME.
WTContainerRef	getContainerRef() Supported API: false
WTGroup	getCreators() Gets the object for the association that plays role: CREATORS_ROLE.
WTPrincipalReference	getCreatorsRef() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isAutoPopulate() Gets the value of the attribute: AUTO_POPULATE.
static CreatorsLink	newCreatorsLink() Supported API: false
static CreatorsLink	newCreatorsLink(WTGroup creators, OrgContainer org) Supported API: false
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(CreatorsLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAutoPopulate(boolean a_AutoPopulate) Sets the value of the attribute: AUTO_POPULATE.
void	setContainer(OrgContainer container) Sets the object for the association that plays role: CONTAINER_ROLE.
void	setContainerClass(Class a_ContainerClass) Sets the value of the attribute: CONTAINER_CLASS.
protected void	setContainerClassName(String a_ContainerClassName) Sets the value of the attribute: CONTAINER_CLASS_NAME.
void	setCreators(WTGroup creators) Sets the object for the association that plays role: CREATORS_ROLE.
String	toString() If the object has been persisted, return it's ObjectIdentifier.
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.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

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

CREATORS_ROLE

public static final String CREATORS_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_ROLE

public static final String CONTAINER_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

AUTO_POPULATE

public static final String AUTO_POPULATE

Label for the attribute; Specifies whether or not members of the org should be automatically added to the creators group when they are created.

Supported API: false

See Also:

Constant Field Values

autoPopulate

private boolean autoPopulate

CONTAINER_CLASS

public static final String CONTAINER_CLASS

Label for the attribute; The class of container that the creators group is configured for.

Supported API: false

See Also:

Constant Field Values

containerClass

private Class containerClass

CONTAINER_CLASS_NAME

protected static final String CONTAINER_CLASS_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_CLASS_NAME_UPPER_LIMIT

private static int CONTAINER_CLASS_NAME_UPPER_LIMIT

containerClassName

private String containerClassName

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

CreatorsLink

public CreatorsLink()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getCreators

public WTGroup getCreators()

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

Supported API: false

Returns:

WTGroup

setCreators

public void setCreators(WTGroup creators)
                 throws WTPropertyVetoException

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

Supported API: false

Parameters:

creators -

Throws:

WTPropertyVetoException

getContainer

public OrgContainer getContainer()

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

Supported API: false

Returns:

OrgContainer

setContainer

public void setContainer(OrgContainer container)
                  throws WTPropertyVetoException

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

Supported API: false

Parameters:

container -

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

isAutoPopulate

public boolean isAutoPopulate()

Gets the value of the attribute: AUTO_POPULATE. Specifies whether or not members of the org should be automatically added to the creators group when they are created.

Supported API: false

Returns:

boolean

setAutoPopulate

public void setAutoPopulate(boolean a_AutoPopulate)
                     throws WTPropertyVetoException

Sets the value of the attribute: AUTO_POPULATE. Specifies whether or not members of the org should be automatically added to the creators group when they are created.

Supported API: false

Parameters:

a_AutoPopulate -

Throws:

WTPropertyVetoException

getContainerClass

public Class getContainerClass()

Gets the value of the attribute: CONTAINER_CLASS. The class of container that the creators group is configured for.

Supported API: false

Returns:

Class

setContainerClass

public void setContainerClass(Class a_ContainerClass)
                       throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_CLASS. The class of container that the creators group is configured for.

Supported API: false

Parameters:

a_ContainerClass -

Throws:

WTPropertyVetoException

getContainerClassName

protected String getContainerClassName()

Gets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Returns:

String

setContainerClassName

protected void setContainerClassName(String a_ContainerClassName)
                              throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

containerClassNameValidate

private void containerClassNameValidate(String a_ContainerClassName)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

newCreatorsLink

public static CreatorsLink newCreatorsLink(WTGroup creators,
                                           OrgContainer org)
                                    throws WTException

Supported API: false

Parameters:

creators -

org -

Returns:

CreatorsLink

Throws:

WTException

newCreatorsLink

public static CreatorsLink newCreatorsLink()
                                    throws WTException

Supported API: false

Returns:

CreatorsLink

Throws:

WTException

getContainerRef

public WTContainerRef getContainerRef()
                               throws WTException

Supported API: false

Returns:

WTContainerRef

Throws:

WTException

getCreatorsRef

public WTPrincipalReference getCreatorsRef()
                                    throws WTException

Supported API: false

Returns:

WTPrincipalReference

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

toString

public String toString()

Description copied from class: WTObject

If the object has been persisted, return it's ObjectIdentifier. If it has not yet been persisted, simply return it's conceptual (modeled) name.

Overrides:

toString in class WTObject

Returns:

String