net.sf.mpxj

Class ActivityCode

java.lang.Object

net.sf.mpxj.ActivityCode

All Implemented Interfaces:

Code, ProjectEntityWithUniqueID

public final class ActivityCode
extends Object
implements Code

Activity code type definition, contains a list of the valid values for this activity code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActivityCode.Builder ActivityCode builder.

Method Summary

Modifier and Type	Method and Description
void	addValue(ActivityCodeValue value) Add a value to this activity code.
List<ActivityCodeValue>	getChildValues() Retrieve a list of top level values for his activity code.
Integer	getMaxLength() Retrieve the max length.
String	getName() Retrieve the activity code name.
ActivityCodeScope	getScope() Retrieve the scope of this activity code.
Integer	getScopeEpsUniqueID() Scope EPS unique ID.
Integer	getScopeProjectUniqueID() Scope project unique ID.
boolean	getSecure() Retrieve the secure flag.
Integer	getSequenceNumber() Retrieve the sequence number of this activity code.
Integer	getUniqueID() Retrieve the activity code unique ID.
ActivityCodeValue	getValueByUniqueID(Integer id) Retrieve a value belonging to this activity code using its unique ID.
List<ActivityCodeValue>	getValues() Retrieve a list of all values for this activity code, including child values from the hierarchy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUniqueID

public Integer getUniqueID()

Retrieve the activity code unique ID.

Specified by:

getUniqueID in interface Code

Specified by:

getUniqueID in interface ProjectEntityWithUniqueID

Returns:

unique ID

getScope

public ActivityCodeScope getScope()

Retrieve the scope of this activity code.

Returns:

activity code scope

getScopeProjectUniqueID

public Integer getScopeProjectUniqueID()

Scope project unique ID.

Returns:

project unique ID

getScopeEpsUniqueID

public Integer getScopeEpsUniqueID()

Scope EPS unique ID.

Returns:

EPS unique ID

getSequenceNumber

public Integer getSequenceNumber()

Retrieve the sequence number of this activity code.

Specified by:

getSequenceNumber in interface Code

Returns:

sequence number

getName

public String getName()

Retrieve the activity code name.

Specified by:

getName in interface Code

Returns:

name

getSecure

public boolean getSecure()

Retrieve the secure flag.

Specified by:

getSecure in interface Code

Returns:

secure flag

getMaxLength

public Integer getMaxLength()

Retrieve the max length.

Specified by:

getMaxLength in interface Code

Returns:

max length

getValues

public List<ActivityCodeValue> getValues()

Retrieve a list of all values for this activity code, including child values from the hierarchy.

Specified by:

getValues in interface Code

Returns:

list of ActivityCodeValue instances

getChildValues

public List<ActivityCodeValue> getChildValues()

Retrieve a list of top level values for his activity code. This excludes any child values from further down the hierarchy of values.

Specified by:

getChildValues in interface Code

Returns:

list of ActivityCodeValue instances

addValue

public void addValue(ActivityCodeValue value)

Add a value to this activity code.

Parameters:

value - activity code value

getValueByUniqueID

public ActivityCodeValue getValueByUniqueID(Integer id)

Retrieve a value belonging to this activity code using its unique ID.

Parameters:

id - activity code value unique ID

Returns:

ActivityCodeValue instance or null