wt.projmgmt.resource
Class MaterialResource

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

All Implemented Interfaces:

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

public class MaterialResource

extends ProjectResource

implements CostResource, Externalizable

MaterialResource represents cost resources that corresponds to supplies or consumables.

Use the newMaterialResource static factory method(s), not the MaterialResource 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:

CostResource, Serialized Form

Field Summary

private static String	CLASSNAME
private Currency	costPerUse
static long	EXTERNALIZATION_VERSION_UID
static String	MATERIAL_LABEL Label for the attribute.
private static int	MATERIAL_LABEL_UPPER_LIMIT
private String	materialLabel
static String	MAX_UNITS Label for the attribute; Percentage/number, calculated/entered that contains the maximum percentage or number of units representing the maximum capacity for which the resource is available.
private int	maxUnits
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(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.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

MaterialResource()

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.
String	getMaterialLabel() Gets the value of the attribute: MATERIAL_LABEL.
int	getMaxUnits() Gets the value of the attribute: MAX_UNITS.
CurrencyRate	getStandardRate() Gets the value of the attribute: STANDARD_RATE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static MaterialResource	newMaterialResource(ProjectPlan plan) Constructs a material resource object given its host plan.
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(MaterialResource 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	setMaterialLabel(String a_MaterialLabel) Sets the value of the attribute: MATERIAL_LABEL.
void	setMaxUnits(int a_MaxUnits) Sets the value of the attribute: MAX_UNITS.
void	setStandardRate(CurrencyRate a_StandardRate) Sets the value of the attribute: STANDARD_RATE.
String	toString() Produces string representation of material resource.
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

MATERIAL_LABEL

public static final String MATERIAL_LABEL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MATERIAL_LABEL_UPPER_LIMIT

private static int MATERIAL_LABEL_UPPER_LIMIT

materialLabel

private String materialLabel

MAX_UNITS

public static final String MAX_UNITS

Label for the attribute; Percentage/number, calculated/entered that contains the maximum percentage or number of units representing the maximum capacity for which the resource is available. If one assigns a resource to more units than it is allowed by max units, the resource will become "overallocated."

Supported API: false

See Also:

Constant Field Values

maxUnits

private int maxUnits

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

MaterialResource

public MaterialResource()

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(MaterialResource 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

getMaterialLabel

public String getMaterialLabel()

Gets the value of the attribute: MATERIAL_LABEL.

Supported API: false

Returns:

String

setMaterialLabel

public void setMaterialLabel(String a_MaterialLabel)

Sets the value of the attribute: MATERIAL_LABEL.

Supported API: false

Parameters:

a_MaterialLabel -

getMaxUnits

public int getMaxUnits()

Gets the value of the attribute: MAX_UNITS. Percentage/number, calculated/entered that contains the maximum percentage or number of units representing the maximum capacity for which the resource is available. If one assigns a resource to more units than it is allowed by max units, the resource will become "overallocated."

Supported API: false

Returns:

int

setMaxUnits

public void setMaxUnits(int a_MaxUnits)

Sets the value of the attribute: MAX_UNITS. Percentage/number, calculated/entered that contains the maximum percentage or number of units representing the maximum capacity for which the resource is available. If one assigns a resource to more units than it is allowed by max units, the resource will become "overallocated."

Supported API: false

Parameters:

a_MaxUnits -

newMaterialResource

public static MaterialResource newMaterialResource(ProjectPlan plan)
                                            throws WTException

Constructs a material resource object given its host plan.

Supported API: false

Parameters:

plan -

Returns:

MaterialResource

Throws:

WTException

toString

public String toString()

Produces string representation of material resource.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

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