wt.team
Class WTRoleHolder2

java.lang.Object
  wt.fc.WTObject
      wt.team.WTRoleHolder2

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, RoleHolder2, Serializable

Direct Known Subclasses:

ContainerTeam, Team, WTActorRoleHolder2

public abstract class WTRoleHolder2

extends WTObject

implements RoleHolder2, Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private TeamCategory	category
static String	CATEGORY Label for the attribute.
private static int	CATEGORY_UPPER_LIMIT
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private Map	rolePrincipalMap
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

WTRoleHolder2()

Method Summary

void	addPool(Role role, ObjectReference poolMember) Add a role to principal (pool) mapping to the rolePoolMap.
void	addPrincipal(Role role, WTPrincipal principal) Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.
void	deletePoolTarget(Role role, ObjectReference poolMember) Remove role to principal (pool) assignment pair from the RolePoolMap Supported API: true
void	deletePrincipalTarget(Role role, WTPrincipal principal) Remove a role to principal assignment pair Supported API: true
void	deleteRole(Role role) Remove a role object from the RoleHolder Supported API: true
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
TeamCategory	getCategory() Gets the value of the attribute: CATEGORY.
Vector	getMembers() Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder Supported API: true
Enumeration	getPoolTarget(Role role) Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap Supported API: true
Enumeration	getPrincipalTarget(Role role) Answer an enumeration of the enabled principal references assigned a role.
protected Map	getReadOnlyRolePrincipalMap()
Map	getRolePrincipalMap()
Vector	getRoles() Answer an enumeration of roles in the rolePrincipalMap Supported API: true
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
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(WTRoleHolder2 thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCategory(TeamCategory a_Category) Sets the value of the attribute: CATEGORY.
void	setRolePrincipalMap(Map map)
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.WTObject

checkAttributes, duplicate, 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.NetFactor

getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CATEGORY

public static final String CATEGORY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CATEGORY_UPPER_LIMIT

private static int CATEGORY_UPPER_LIMIT

category

private TeamCategory category

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

rolePrincipalMap

private Map rolePrincipalMap

Constructor Detail

WTRoleHolder2

public WTRoleHolder2()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 WTObject

Parameters:

input -

Throws:

SQLException

DatastoreException

getCategory

public TeamCategory getCategory()

Gets the value of the attribute: CATEGORY.

Supported API: false

Returns:

TeamCategory

setCategory

public void setCategory(TeamCategory a_Category)
                 throws WTPropertyVetoException

Sets the value of the attribute: CATEGORY.

Supported API: false

Parameters:

a_Category -

Throws:

WTPropertyVetoException

addPrincipal

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

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

Supported API: true

Specified by:

addPrincipal in interface RoleHolder2

Parameters:

role - the Role object to add WTPrincipals to

principal - the WTPrincipal object to be added to the Role

Throws:

WTException

getPrincipalTarget

public Enumeration getPrincipalTarget(Role role)
                               throws WTException

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: true

Specified by:

getPrincipalTarget in interface RoleHolder2

Parameters:

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

Returns:

Enumeration

Throws:

WTException

deletePrincipalTarget

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

Remove a role to principal assignment pair

Supported API: true

Specified by:

deletePrincipalTarget in interface RoleHolder2

Parameters:

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

principal - the WTPrincipal object to be removed

Throws:

WTException

getRoles

public Vector getRoles()
                throws WTException

Answer an enumeration of roles in the rolePrincipalMap

Supported API: true

Specified by:

getRoles in interface RoleHolder2

Returns:

Vector

Throws:

WTException

deleteRole

public void deleteRole(Role role)
                throws WTException

Remove a role object from the RoleHolder

Supported API: true

Specified by:

deleteRole in interface RoleHolder2

Parameters:

role - the Role object to be removed

Throws:

WTException

addPool

public void addPool(Role role,
                    ObjectReference poolMember)
             throws WTException

Add a role to principal (pool) mapping to the rolePoolMap.

Supported API: true

Specified by:

addPool in interface RoleHolder2

Parameters:

role - the Role object to be added to the rolePrincipalMap

poolMember - the object to be added to the rolePrincipalMap. The only objects allowed are Teams and WTPrincipals.

Throws:

WTException

getPoolTarget

public Enumeration getPoolTarget(Role role)
                          throws WTException

Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap

Supported API: true

Specified by:

getPoolTarget in interface RoleHolder2

Parameters:

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

Returns:

Enumeration

Throws:

WTException

deletePoolTarget

public void deletePoolTarget(Role role,
                             ObjectReference poolMember)
                      throws WTException

Remove role to principal (pool) assignment pair from the RolePoolMap

Supported API: true

Specified by:

deletePoolTarget in interface RoleHolder2

Parameters:

role - the Role object used as search criteria in the removal of the WTPrincipal from the rolePrincipalMap

poolMember - a reference to the object to be removed from the rolePrincipalMap

Throws:

WTException

getMembers

public Vector getMembers()
                  throws WTException

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

Supported API: true

Returns:

Vector

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 WTObject

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 WTObject

Returns:

int

setRolePrincipalMap

public void setRolePrincipalMap(Map map)

getRolePrincipalMap

public Map getRolePrincipalMap()
                        throws WTException

Throws:

WTException

getReadOnlyRolePrincipalMap

protected Map getReadOnlyRolePrincipalMap()