wt.projmgmt.resource
Class RoleResource

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.projmgmt.resource.ProjectResource
              wt.projmgmt.resource.RoleResource

All Implemented Interfaces:

AccessControlled, CostResource, DisplayIdentification, DomainAdministered, Externalizable, Indexable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, TimeResource, WTContained

public class RoleResource

extends ProjectResource

implements TimeResource, Externalizable

This class is used to collect cost related information associated to a role (rather to a specific individual).

Use the newRoleResource static factory method(s), not the RoleResource 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 Currency	costPerUse
static long	EXTERNALIZATION_VERSION_UID
private int	maxPercentUtilization
protected static long	OLD_FORMAT_VERSION_UID
private CurrencyRate	overtimeRate
private static String	RESOURCE
private Role	role
static String	ROLE Label for the attribute; Role referred to by the resource.
private static int	ROLE_UPPER_LIMIT
(package private) static long	serialVersionUID
private CurrencyRate	standardRate

Fields inherited from class wt.projmgmt.resource.ProjectResource

CATEGORY, CONTAINER, DESCRIPTION, ENABLED, NAME, PLAN, PLAN_REFERENCE, R60_EXTERNALIZATION_VERSION_UID

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.projmgmt.resource.TimeResource

MAX_PERCENT_UTILIZATION, OVERTIME_RATE

Fields inherited from interface wt.projmgmt.resource.CostResource

COST_PER_USE, STANDARD_RATE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

RoleResource()

Method Summary

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.
Currency	getCostPerUse() Gets the value of the attribute: COST_PER_USE.
int	getMaxPercentUtilization() Gets the value of the attribute: MAX_PERCENT_UTILIZATION.
CurrencyRate	getOvertimeRate() Gets the value of the attribute: OVERTIME_RATE.
Role	getRole() Gets the value of the attribute: ROLE.
CurrencyRate	getStandardRate() Gets the value of the attribute: STANDARD_RATE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static RoleResource	newRoleResource(ProjectPlan plan) Constructs a role resource belonging to the plan passed as argument.
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(RoleResource thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCostPerUse(Currency a_CostPerUse) Sets the value of the attribute: COST_PER_USE.
void	setMaxPercentUtilization(int a_MaxPercentUtilization) Sets the value of the attribute: MAX_PERCENT_UTILIZATION.
void	setOvertimeRate(CurrencyRate a_OvertimeRate) Sets the value of the attribute: OVERTIME_RATE.
void	setRole(Role a_Role) Sets the value of the attribute: ROLE.
void	setStandardRate(CurrencyRate a_StandardRate) Sets the value of the attribute: STANDARD_RATE.
String	toString() Returns string representation of the object.
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.projmgmt.resource.ProjectResource

getCategory, getContainer, getContainerName, getContainerReference, getDescription, getIndexerSet, getName, getPlan, getPlanReference, initialize, isEnabled, readVersion, setCategory, setContainer, setContainerReference, setDescription, setEnabled, setIndexerSet, setName, setPlan, setPlanReference

Methods inherited from class wt.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

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

ROLE

public static final String ROLE

Label for the attribute; Role referred to by the resource.

Supported API: false

See Also:

Constant Field Values

ROLE_UPPER_LIMIT

private static int ROLE_UPPER_LIMIT

role

private Role role

overtimeRate

private CurrencyRate overtimeRate

maxPercentUtilization

private int maxPercentUtilization

standardRate

private CurrencyRate standardRate

costPerUse

private Currency costPerUse

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

RoleResource

public RoleResource()

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 ProjectResource

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 ProjectResource

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(RoleResource 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 ProjectResource

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 ProjectResource

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

getRole

public Role getRole()

Gets the value of the attribute: ROLE. Role referred to by the resource.

Supported API: false

Returns:

Role

setRole

public void setRole(Role a_Role)

Sets the value of the attribute: ROLE. Role referred to by the resource.

Supported API: false

Parameters:

a_Role -

newRoleResource

public static RoleResource newRoleResource(ProjectPlan plan)
                                    throws WTException

Constructs a role resource belonging to the plan passed as argument.

Supported API: false

Parameters:

plan -

Returns:

RoleResource

Throws:

WTException

toString

public String toString()

Returns string representation of the object.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

getOvertimeRate

public CurrencyRate getOvertimeRate()

Gets the value of the attribute: OVERTIME_RATE. Cost rate if resource is used outside its normal working hours. The normal working hours is specified by the baseCalendar attribute.

Supported API: false

Specified by:

getOvertimeRate in interface TimeResource

Returns:

CurrencyRate

setOvertimeRate

public void setOvertimeRate(CurrencyRate a_OvertimeRate)

Sets the value of the attribute: OVERTIME_RATE. Cost rate if resource is used outside its normal working hours. The normal working hours is specified by the baseCalendar attribute.

Supported API: false

Specified by:

setOvertimeRate in interface TimeResource

Parameters:

a_OvertimeRate -

getMaxPercentUtilization

public int getMaxPercentUtilization()

Gets the value of the attribute: MAX_PERCENT_UTILIZATION. Integer number between 0 and 100 indicating the maximum portion of time a time resource can be used in project tasks.

Supported API: false

Specified by:

getMaxPercentUtilization in interface TimeResource

Returns:

int

setMaxPercentUtilization

public void setMaxPercentUtilization(int a_MaxPercentUtilization)

Sets the value of the attribute: MAX_PERCENT_UTILIZATION. Integer number between 0 and 100 indicating the maximum portion of time a time resource can be used in project tasks.

Supported API: false

Specified by:

setMaxPercentUtilization in interface TimeResource

Parameters:

a_MaxPercentUtilization -

getStandardRate

public CurrencyRate getStandardRate()

Gets the value of the attribute: STANDARD_RATE. Rate of pay for regular, non overtime work performed by resource. The rate is given in the local currency per some standard unit of time (hours or units) depending on the nature of the resource.

Supported API: false

Specified by:

getStandardRate in interface CostResource

Returns:

CurrencyRate

See Also:

wt.projmgmt.util.CurrencyRate

setStandardRate

public void setStandardRate(CurrencyRate a_StandardRate)

Sets the value of the attribute: STANDARD_RATE. Rate of pay for regular, non overtime work performed by resource. The rate is given in the local currency per some standard unit of time (hours or units) depending on the nature of the resource.

Supported API: false

Specified by:

setStandardRate in interface CostResource

Parameters:

a_StandardRate -

See Also:

wt.projmgmt.util.CurrencyRate

getCostPerUse

public Currency getCostPerUse()

Gets the value of the attribute: COST_PER_USE. Cost that accrues each time resource is used; it is added each time is assigned to a task. It does not vary with the amount of time the resource is used. The cost is given in the local currency.

Supported API: false

Specified by:

getCostPerUse in interface CostResource

Returns:

Currency

See Also:

wt.projmgmt.util.Currency

setCostPerUse

public void setCostPerUse(Currency a_CostPerUse)

Sets the value of the attribute: COST_PER_USE. Cost that accrues each time resource is used; it is added each time is assigned to a task. It does not vary with the amount of time the resource is used. The cost is given in the local currency.

Supported API: false

Specified by:

setCostPerUse in interface CostResource

Parameters:

a_CostPerUse -

See Also:

wt.projmgmt.util.Currency

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 ProjectResource

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 ProjectResource

Returns:

int