wt.projmgmt.resource
Class ProjectResource

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fc.Item
          extended bywt.projmgmt.resource.ProjectResource
All Implemented Interfaces:
AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, Indexable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained
Direct Known Subclasses:
EquipmentResource, FacilityResource, InformationResource, MaterialResource, PersonResource, RoleResource

public abstract class ProjectResource
extends Item
implements WTContained, Indexable, Externalizable

ProjectResource represents resources necessary for the execution of an activity. These resources include people, equipment, faclities, material employed in the project and information used or generated.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private  ResourceCategory category
           
static String CATEGORY
          Label for the attribute; Classification attribute.
private static int CATEGORY_UPPER_LIMIT
           
private static String CLASSNAME
           
static String CONTAINER
          Label for the attribute.
private  WTContainerRef containerReference
           
private  String description
           
static String DESCRIPTION
          Label for the attribute; Resource description.
private static int DESCRIPTION_UPPER_LIMIT
           
private  boolean enabled
           
static String ENABLED
          Label for the attribute; Determines whether the resource can be assigned to an activity.
static long EXTERNALIZATION_VERSION_UID
           
private  IndexerSet indexerSet
           
private  String name
           
static String NAME
          Label for the attribute; Resource name.
private static int NAME_UPPER_LIMIT
           
protected static long OLD_FORMAT_VERSION_UID
           
static String PLAN
          Label for the attribute.
static String PLAN_REFERENCE
          Label for the attribute.
private  ObjectReference planReference
           
static long R60_EXTERNALIZATION_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
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.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
ProjectResource()
           
 
Method Summary
private  void containerReferenceValidate(WTContainerRef a_ContainerReference)
           
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
 ResourceCategory getCategory()
          Gets the value of the attribute: CATEGORY.
 WTContainer getContainer()
          Gets the object for the association that plays role: CONTAINER.
 String getContainerName()
          Gets the value of the attribute: CONTAINER_NAME.
 WTContainerRef getContainerReference()
          Gets the value of the attribute: CONTAINER_REFERENCE.
 String getDescription()
          Gets the value of the attribute: DESCRIPTION.
 IndexerSet getIndexerSet()
          Gets the value of the attribute: INDEXER_SET.
 String getName()
          Gets the value of the attribute: NAME.
 ProjectPlan getPlan()
          Gets the object for the association that plays role: PLAN.
 ObjectReference getPlanReference()
          Gets the value of the attribute: PLAN_REFERENCE.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize(ProjectPlan plan)
          

Supported API: false
 boolean isEnabled()
          Gets the value of the attribute: ENABLED.
private  void planReferenceValidate(ObjectReference a_PlanReference)
           
 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(ProjectResource thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setCategory(ResourceCategory a_Category)
          Sets the value of the attribute: CATEGORY.
 void setContainer(WTContainer a_Container)
          Sets the object for the association that plays role: CONTAINER.
 void setContainerReference(WTContainerRef a_ContainerReference)
          Sets the value of the attribute: CONTAINER_REFERENCE.
 void setDescription(String a_Description)
          Sets the value of the attribute: DESCRIPTION.
 void setEnabled(boolean a_Enabled)
          Sets the value of the attribute: ENABLED.
 void setIndexerSet(IndexerSet a_IndexerSet)
          Sets the value of the attribute: INDEXER_SET.
 void setName(String a_Name)
          Sets the value of the attribute: NAME.
 void setPlan(ProjectPlan a_Plan)
          Sets the object for the association that plays role: PLAN.
 void setPlanReference(ObjectReference a_PlanReference)
          Sets the value of the attribute: PLAN_REFERENCE.
 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.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, toString
 
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, getConceptualClassname
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME
Label for the attribute; Resource name.

Supported API: false

See Also:
Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

DESCRIPTION

public static final String DESCRIPTION
Label for the attribute; Resource description.

Supported API: false

See Also:
Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

CATEGORY

public static final String CATEGORY
Label for the attribute; Classification attribute.

Supported API: false

See Also:
Constant Field Values

CATEGORY_UPPER_LIMIT

private static int CATEGORY_UPPER_LIMIT

category

private ResourceCategory category

ENABLED

public static final String ENABLED
Label for the attribute; Determines whether the resource can be assigned to an activity. This is typically the case of a person resource that is removed from the plan but its data needs to be retained because it influenced some accrued quantity such as cost.

Supported API: false

See Also:
Constant Field Values

enabled

private boolean enabled

PLAN

public static final String PLAN
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

PLAN_REFERENCE

public static final String PLAN_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

planReference

private ObjectReference planReference

CONTAINER

public static final String CONTAINER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

containerReference

private WTContainerRef containerReference

indexerSet

private IndexerSet indexerSet

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

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

ProjectResource

public ProjectResource()
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 Item
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 Item
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(ProjectResource 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 Item
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 Item
Parameters:
input -
Throws:
SQLException
DatastoreException

getName

public String getName()
Gets the value of the attribute: NAME. Resource name.

Supported API: false

Returns:
String

setName

public void setName(String a_Name)
Sets the value of the attribute: NAME. Resource name.

Supported API: false

Parameters:
a_Name -

getDescription

public String getDescription()
Gets the value of the attribute: DESCRIPTION. Resource description.

Supported API: false

Returns:
String

setDescription

public void setDescription(String a_Description)
Sets the value of the attribute: DESCRIPTION. Resource description.

Supported API: false

Parameters:
a_Description -

getCategory

public ResourceCategory getCategory()
Gets the value of the attribute: CATEGORY. Classification attribute.

Supported API: false

Returns:
ResourceCategory

setCategory

public void setCategory(ResourceCategory a_Category)
Sets the value of the attribute: CATEGORY. Classification attribute.

Supported API: false

Parameters:
a_Category -

isEnabled

public boolean isEnabled()
Gets the value of the attribute: ENABLED. Determines whether the resource can be assigned to an activity. This is typically the case of a person resource that is removed from the plan but its data needs to be retained because it influenced some accrued quantity such as cost.

Supported API: false

Returns:
boolean

setEnabled

public void setEnabled(boolean a_Enabled)
Sets the value of the attribute: ENABLED. Determines whether the resource can be assigned to an activity. This is typically the case of a person resource that is removed from the plan but its data needs to be retained because it influenced some accrued quantity such as cost.

Supported API: false

Parameters:
a_Enabled -

getPlan

public ProjectPlan getPlan()
Gets the object for the association that plays role: PLAN.

Supported API: false

Returns:
ProjectPlan

setPlan

public void setPlan(ProjectPlan a_Plan)
             throws WTPropertyVetoException,
                    WTException
Sets the object for the association that plays role: PLAN.

Supported API: false

Parameters:
a_Plan -
Throws:
WTPropertyVetoException
WTException

getPlanReference

public ObjectReference getPlanReference()
Gets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Returns:
ObjectReference

setPlanReference

public void setPlanReference(ObjectReference a_PlanReference)
                      throws WTPropertyVetoException
Sets the value of the attribute: PLAN_REFERENCE.

Supported API: false

Parameters:
a_PlanReference -
Throws:
WTPropertyVetoException

planReferenceValidate

private void planReferenceValidate(ObjectReference a_PlanReference)
                            throws WTPropertyVetoException
Parameters:
a_PlanReference -
Throws:
WTPropertyVetoException

initialize

protected void initialize(ProjectPlan plan)
                   throws WTException


Supported API: false

Parameters:
plan -
Throws:
WTException

getContainerName

public String getContainerName()
Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:
getContainerName in interface WTContained
Returns:
String

getContainer

public WTContainer getContainer()
Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:
getContainer in interface WTContained
Returns:
WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException
Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:
setContainer in interface WTContained
Parameters:
a_Container -
Throws:
WTPropertyVetoException
WTException

getContainerReference

public WTContainerRef getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:
getContainerReference in interface WTContained
Returns:
WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:
setContainerReference in interface WTContained
Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException
Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

getIndexerSet

public IndexerSet getIndexerSet()
Gets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:
getIndexerSet in interface Indexable
Returns:
IndexerSet

setIndexerSet

public void setIndexerSet(IndexerSet a_IndexerSet)
Sets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:
setIndexerSet in interface Indexable
Parameters:
a_IndexerSet -

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 Item
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 Item
Returns:
int