wt.project
Class Project

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

All Implemented Interfaces:

AccessControlled, AccessControlList, ActorRoleHolder, AdHocControlled, BusinessInformation, CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Identified, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RoleHolder, Serializable

Deprecated. at R6.0 Project will be replaced by a new Team object in a future release.

public class Project

extends WTActorRoleHolder

implements Notifiable, DomainAdministered, AccessControlled, BusinessInformation, Foldered, Ownable, Identified, AdHocControlled, Externalizable

Project establishes associations between roles and principals and/or actor roles. When a life cycle managed object is associated with a project, the role assignments of the project take precedence of their default assignments for the life cycle phase.

A project is FolderResident.

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

FolderResident, PhaseTemplate, Phase, Serialized Form

Field Summary

private static String	CLASSNAME Deprecated.
private String	description Deprecated.
static String	DESCRIPTION Deprecated. Label for the attribute; A free text description of the project Supported API: false
private static int	DESCRIPTION_UPPER_LIMIT Deprecated.
private AdminDomainRef	domainRef Deprecated.
private boolean	enabled Deprecated.
static String	ENABLED Deprecated. Label for the attribute; A boolean that notates whether the Project is enabled or disabled Supported API: false
private AclEntrySet	entrySet Deprecated.
private WTStringSet	eventSet Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private FolderingInfo	folderingInfo Deprecated.
private boolean	inheritedDomain Deprecated.
static String	LEFTPAREN Deprecated.
private String	name Deprecated.
static String	NAME Deprecated. Label for the attribute; The name of the project Supported API: false
private static int	NAME_UPPER_LIMIT Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
private Ownership	ownership Deprecated.
private static String	RESOURCE Deprecated.
static String	RIGHTPAREN Deprecated.
(package private) static long	serialVersionUID Deprecated.
private boolean	template Deprecated.
static String	TEMPLATE Deprecated. Label for the attribute.

Fields inherited from class wt.project.WTActorRoleHolder

Fields inherited from class wt.project.WTRoleHolder

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.project.ActorRoleHolder

ROLE_ACTOR_ROLE_MAP

Fields inherited from interface wt.project.RoleHolder

ROLE_PRINCIPAL_MAP

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

Project()
Deprecated.

Method Summary

private void	descriptionValidate(String a_Description) Deprecated.
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.
String	getBusinessType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getBusinessType(). Another alternative is ((WTObject)obj).getDisplayType().
CabinetReference	getCabinet() Deprecated. Gets the value of the attribute: CABINET.
String	getCabinetName() Deprecated. Gets the value of the attribute: CABINET_NAME.
CabinetReference	getCabinetReference() Deprecated. Gets the value of the attribute: CABINET_REFERENCE.
String	getConceptualClassname() Deprecated.
String	getDescription() Deprecated. Gets the value of the attribute: DESCRIPTION.
AdminDomainRef	getDomainRef() Deprecated. Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Deprecated. Gets the value of the attribute: ENTRY_SET.
WTStringSet	getEventSet() Deprecated. Gets the value of the attribute: EVENT_SET.
FolderingInfo	getFolderingInfo() Deprecated. Gets the object for the association that plays role: FOLDERING_INFO.
String	getFolderPath() Deprecated. Gets the value of the attribute: FOLDER_PATH.
IdentificationObject	getIdentificationObject() Deprecated. Constructs and returns an identification object.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity()
protected String	getKey() Deprecated.
String	getLocation() Deprecated. Gets the value of the attribute: LOCATION.
String	getName() Deprecated. Gets the value of the attribute: NAME.
Ownership	getOwnership() Deprecated. Gets the object for the association that plays role: OWNERSHIP.
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.
boolean	isEnabled() Deprecated. Gets the value of the attribute: ENABLED.
boolean	isInheritedDomain() Deprecated. Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isTemplate() Deprecated. Gets the value of the attribute: TEMPLATE.
private void	nameValidate(String a_Name) Deprecated.
static Project	newProject() Deprecated. Default factory for the class.
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(Project thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source.
void	setDescription(String a_Description) Deprecated. Sets the value of the attribute: DESCRIPTION.
void	setDomainRef(AdminDomainRef a_DomainRef) Deprecated. Sets the object for the association that plays role: DOMAIN_REF.
void	setEnabled(boolean a_Enabled) Deprecated. Sets the value of the attribute: ENABLED.
void	setEntrySet(AclEntrySet a_EntrySet) Deprecated. Sets the value of the attribute: ENTRY_SET.
void	setEventSet(WTStringSet a_EventSet) Deprecated. Sets the value of the attribute: EVENT_SET.
void	setFolderingInfo(FolderingInfo a_FolderingInfo) Deprecated. Sets the object for the association that plays role: FOLDERING_INFO.
void	setInheritedDomain(boolean a_InheritedDomain) Deprecated. Sets the value of the attribute: INHERITED_DOMAIN.
protected void	setName(String a_Name) Deprecated. Sets the value of the attribute: NAME.
void	setOwnership(Ownership a_Ownership) Deprecated. Sets the object for the association that plays role: OWNERSHIP.
void	setProjectIdentity(String name) Deprecated. set the identity of the project Supported API: false
Project	setProjectLocation(String folder) Deprecated. set the location of the project Supported API: false
void	setTemplate(boolean a_Template) Deprecated. Sets the value of the attribute: TEMPLATE.
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.project.WTActorRoleHolder

addActorRole, deleteActorRoleTarget, deleteRole, getActorRoleTarget, getRoleActorRoleMap, getRoles, readVersion, setRoleActorRoleMap

Methods inherited from class wt.project.WTRoleHolder

addPrincipal, deletePrincipal, getMembers, getPrincipals, getRolePrincipalMap, mapAsString, readVersion, rolePrincipalMapAsString, setRolePrincipalMap

Methods inherited from class wt.fc.WTObject

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

getClassInfo

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.project.RoleHolder

addPrincipal, deletePrincipal, getPrincipals, getRolePrincipalMap, rolePrincipalMapAsString, setRolePrincipalMap

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

NAME

public static final String NAME

Deprecated.

Label for the attribute; The name of the project

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

Deprecated.

name

private String name

Deprecated.

DESCRIPTION

public static final String DESCRIPTION

Deprecated.

Label for the attribute; A free text description of the project

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

Deprecated.

description

private String description

Deprecated.

ENABLED

public static final String ENABLED

Deprecated.

Label for the attribute; A boolean that notates whether the Project is enabled or disabled

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

Deprecated.

TEMPLATE

public static final String TEMPLATE

Deprecated.

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

template

private boolean template

Deprecated.

eventSet

private WTStringSet eventSet

Deprecated.

inheritedDomain

private boolean inheritedDomain

Deprecated.

domainRef

private AdminDomainRef domainRef

Deprecated.

folderingInfo

private FolderingInfo folderingInfo

Deprecated.

ownership

private Ownership ownership

Deprecated.

entrySet

private AclEntrySet entrySet

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

LEFTPAREN

public static final String LEFTPAREN

Deprecated.

See Also:

Constant Field Values

RIGHTPAREN

public static final String RIGHTPAREN

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Project

public Project()

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 WTActorRoleHolder

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 WTActorRoleHolder

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Project 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 WTActorRoleHolder

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 WTActorRoleHolder

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

getName

public String getName()

Deprecated.

Gets the value of the attribute: NAME. The name of the project

Supported API: false

Specified by:

getName in interface CabinetBased

Returns:

String

setName

protected void setName(String a_Name)
                throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: NAME. The name of the project

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Deprecated.

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Deprecated.

Gets the value of the attribute: DESCRIPTION. A free text description of the project

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: DESCRIPTION. A free text description of the project

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Deprecated.

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Deprecated.

Gets the value of the attribute: ENABLED. A boolean that notates whether the Project is enabled or disabled

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)
                throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: ENABLED. A boolean that notates whether the Project is enabled or disabled

Supported API: false

Parameters:

a_Enabled -

Throws:

WTPropertyVetoException

isTemplate

public boolean isTemplate()

Deprecated.

Gets the value of the attribute: TEMPLATE.

Supported API: false

Returns:

boolean

setTemplate

public void setTemplate(boolean a_Template)
                 throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: TEMPLATE.

Supported API: false

Parameters:

a_Template -

Throws:

WTPropertyVetoException

setProjectIdentity

public void setProjectIdentity(String name)
                        throws WTException

Deprecated.

set the identity of the project

Supported API: false

Parameters:

name - the name of the project

Throws:

WTException

setProjectLocation

public Project setProjectLocation(String folder)
                           throws WTException

Deprecated.

set the location of the project

Supported API: false

Parameters:

folder - the name of the folder where the project should be located

Returns:

Project

Throws:

WTException

newProject

public static Project newProject()
                          throws WTException

Deprecated.

Default factory for the class.

Supported API: false

Returns:

Project

Throws:

WTException

getEventSet

public WTStringSet getEventSet()

Deprecated.

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Deprecated.

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

isInheritedDomain

public boolean isInheritedDomain()

Deprecated.

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

Deprecated.

Gets the object for the association that plays role: DOMAIN_REF.

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

Deprecated.

Sets the object for the association that plays role: DOMAIN_REF.

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity()

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface BusinessInformation

Overrides:

getIdentity in class WTObject

Returns:

String

getBusinessType

public String getBusinessType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getBusinessType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: BUSINESS_TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getBusinessType in interface BusinessInformation

Returns:

String

getCabinetName

public String getCabinetName()

Deprecated.

Gets the value of the attribute: CABINET_NAME.

Supported API: false

Specified by:

getCabinetName in interface Foldered

Returns:

String

getCabinet

public CabinetReference getCabinet()

Deprecated.

Gets the value of the attribute: CABINET.

Supported API: false

Specified by:

getCabinet in interface Foldered

Returns:

CabinetReference

getFolderingInfo

public FolderingInfo getFolderingInfo()

Deprecated.

Gets the object for the association that plays role: FOLDERING_INFO.

Supported API: false

Specified by:

getFolderingInfo in interface Foldered

Returns:

FolderingInfo

setFolderingInfo

public void setFolderingInfo(FolderingInfo a_FolderingInfo)

Deprecated.

Sets the object for the association that plays role: FOLDERING_INFO.

Supported API: false

Specified by:

setFolderingInfo in interface Foldered

Parameters:

a_FolderingInfo -

getFolderPath

public String getFolderPath()

Deprecated.

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Specified by:

getFolderPath in interface CabinetBased

Returns:

String

getLocation

public String getLocation()

Deprecated.

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Specified by:

getLocation in interface CabinetBased

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Deprecated.

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Specified by:

getCabinetReference in interface CabinetBased

Returns:

CabinetReference

getOwnership

public Ownership getOwnership()

Deprecated.

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Deprecated.

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Deprecated.

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getEntrySet

public AclEntrySet getEntrySet()

Deprecated.

Gets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

getEntrySet in interface AdHocControlled

Returns:

AclEntrySet

setEntrySet

public void setEntrySet(AclEntrySet a_EntrySet)

Deprecated.

Sets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

setEntrySet in interface AdHocControlled

Parameters:

a_EntrySet -

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 WTActorRoleHolder

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 WTActorRoleHolder

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 WTActorRoleHolder

Throws:

WTException

getKey

protected String getKey()

Deprecated.