wt.project
Class WTRoleHolder

java.lang.Object
  wt.fc.WTObject
      wt.project.WTRoleHolder

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, RoleHolder, Serializable

Direct Known Subclasses:

WTActorRoleHolder

Deprecated. in R6.0

public abstract class WTRoleHolder

extends WTObject

implements RoleHolder, Externalizable

WTRoleHolder is an abstract class which holds role to principal assignments. WTRoleHolder is a reference implementation of the RoleHolder interface

Supported API: false

Extendable: false

See Also:

RoleHolder, Serialized Form

Field Summary

private static String	CLASSNAME Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private static String	PROXY_GROUP Deprecated.
private static String	PROXY_USER Deprecated.
private static String	RESOURCE Deprecated.
private RolePrincipalTable	rolePrincipalMap Deprecated.
private Vector	roleSourceId Deprecated.
(package private) static long	serialVersionUID Deprecated.

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.project.RoleHolder

ROLE_PRINCIPAL_MAP

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

WTRoleHolder()
Deprecated.

Method Summary

void	addPrincipal(Role role, WTPrincipal principal) Deprecated. Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.
private boolean	checkProxyReferences(Vector princVector, String key) Deprecated.
void	deletePrincipal(Role role, WTPrincipal principal) Deprecated. Remove a role to principal assignment pair Supported API: false
void	deleteRole(Role role) Deprecated. Remove a role object from the RoleHolder Supported API: false
boolean	equals(Object obj) Deprecated. Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
Vector	getMembers() Deprecated. Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder Supported API: false
Enumeration	getPrincipals(Role role) Deprecated. Answer an enumeration of the enabled principal references assigned a role.
RolePrincipalTable	getRolePrincipalMap() Deprecated. Gets the value of the attribute: ROLE_PRINCIPAL_MAP.
Enumeration	getRoles() Deprecated. Answer an enumeration of roles in the rolePrincipalMap Supported API: false
int	hashCode() Deprecated. Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Deprecated. Initializes objects created by new-factory methods.
String	mapAsString(RolePrincipalTable aMap) Deprecated.
void	readExternal(ObjectInput input) Deprecated. Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Deprecated. 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) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WTRoleHolder thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source.
private WTPrincipalReference	replaceNeeded(String pRef) Deprecated.
private void	replaceProxyReferences() Deprecated.
String	rolePrincipalMapAsString() Deprecated. Answer a string of role to principal mappings Supported API: false
void	setRolePrincipalMap(RolePrincipalTable a_RolePrincipalMap) Deprecated. Sets the value of the attribute: ROLE_PRINCIPAL_MAP.
void	writeExternal(ObjectOutput output) Deprecated. Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Deprecated. 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.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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

getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

rolePrincipalMap

private RolePrincipalTable rolePrincipalMap

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

roleSourceId

private Vector roleSourceId

Deprecated.

PROXY_USER

private static final String PROXY_USER

Deprecated.

See Also:

Constant Field Values

PROXY_GROUP

private static final String PROXY_GROUP

Deprecated.

See Also:

Constant Field Values

Constructor Detail

WTRoleHolder

public WTRoleHolder()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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 WTObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

Deprecated.

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

Deprecated.

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

Deprecated.

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 WTObject

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Deprecated.

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 WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

addPrincipal

public void addPrincipal(Role role,
                         WTPrincipal principal)
                  throws WTException

Deprecated.

Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.

Supported API: false

Specified by:

addPrincipal in interface RoleHolder

Parameters:

role - the Role object to add WTPrincipals to

principal - the WTPrincipal object to be added to the Role

Throws:

WTException

getPrincipals

public Enumeration getPrincipals(Role role)
                          throws WTException

Deprecated.

Answer an enumeration of the enabled principal references assigned a role. The enumeration is a copy of the real enumeration to prevent accidental modification.

Supported API: false

Specified by:

getPrincipals in interface RoleHolder

Parameters:

role - the Role object used as search criteria in the retrieval of PrincipalReferences

Returns:

Enumeration

Throws:

WTException

deletePrincipal

public void deletePrincipal(Role role,
                            WTPrincipal principal)
                     throws WTException

Deprecated.

Remove a role to principal assignment pair

Supported API: false

Specified by:

deletePrincipal in interface RoleHolder

Parameters:

role - the Role object used as search criteria in the removal of the WTPrincipa

principal - the WTPrincipal object to be removed

Throws:

WTException

getRoles

public Enumeration getRoles()
                     throws WTException

Deprecated.

Answer an enumeration of roles in the rolePrincipalMap

Supported API: false

Specified by:

getRoles in interface RoleHolder

Returns:

Enumeration

Throws:

WTException

deleteRole

public void deleteRole(Role role)
                throws WTException

Deprecated.

Remove a role object from the RoleHolder

Supported API: false

Specified by:

deleteRole in interface RoleHolder

Parameters:

role - the Role object to be removed

Throws:

WTException

rolePrincipalMapAsString

public String rolePrincipalMapAsString()

Deprecated.

Answer a string of role to principal mappings

Supported API: false

Specified by:

rolePrincipalMapAsString in interface RoleHolder

Returns:

String

getMembers

public Vector getMembers()
                  throws WTException

Deprecated.

Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder

Supported API: false

Returns:

Vector

Throws:

WTException

getRolePrincipalMap

public RolePrincipalTable getRolePrincipalMap()

Deprecated.

Gets the value of the attribute: ROLE_PRINCIPAL_MAP. Map of role to principal assignments

Supported API: false

Specified by:

getRolePrincipalMap in interface RoleHolder

Returns:

RolePrincipalTable

See Also:

wt.project.rolePrincipalTable

setRolePrincipalMap

public void setRolePrincipalMap(RolePrincipalTable a_RolePrincipalMap)
                         throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: ROLE_PRINCIPAL_MAP. Map of role to principal assignments

Supported API: false

Specified by:

setRolePrincipalMap in interface RoleHolder

Parameters:

a_RolePrincipalMap -

Throws:

WTPropertyVetoException

See Also:

wt.project.rolePrincipalTable

equals

public boolean equals(Object obj)

Deprecated.

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 WTObject

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Deprecated.

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 WTObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

Deprecated.

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

Throws:

WTException

mapAsString

public String mapAsString(RolePrincipalTable aMap)

Deprecated.

replaceProxyReferences

private void replaceProxyReferences()

Deprecated.

checkProxyReferences

private boolean checkProxyReferences(Vector princVector,
                                     String key)

Deprecated.

replaceNeeded

private WTPrincipalReference replaceNeeded(String pRef)

Deprecated.