org.mpxj

Class RoleCode

java.lang.Object

org.mpxj.RoleCode

All Implemented Interfaces:

Code, ProjectEntityWithUniqueID

public final class RoleCode
extends Object
implements Code

Role code type definition, contains a list of the valid values for this role code.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addValue(RoleCodeValue value) Add value to this code.
List<RoleCodeValue>	getChildValues() Retrieve the immediate child values for this code.
Integer	getMaxLength() Retrieve the max length.
String	getName() Retrieve the project code name.
boolean	getSecure() Retrieve the secure flag.
Integer	getSequenceNumber() Retrieve the sequence number of this project code.
Integer	getUniqueID() Retrieve the project code unique ID.
RoleCodeValue	getValueByUniqueID(Integer id) Retrieve a value by unique ID.
List<RoleCodeValue>	getValues() Retrieve all values for this code.

Methods inherited from class java.lang.Object

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

Method Detail

getUniqueID

public Integer getUniqueID()

Description copied from interface: Code

Retrieve the project code unique ID.

Specified by:

getUniqueID in interface Code

Specified by:

getUniqueID in interface ProjectEntityWithUniqueID

Returns:

unique ID

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: Code

Retrieve the sequence number of this project code.

Specified by:

getSequenceNumber in interface Code

Returns:

sequence number

getName

public String getName()

Description copied from interface: Code

Retrieve the project code name.

Specified by:

getName in interface Code

Returns:

name

getSecure

public boolean getSecure()

Description copied from interface: Code

Retrieve the secure flag.

Specified by:

getSecure in interface Code

Returns:

secure flag

getMaxLength

public Integer getMaxLength()

Description copied from interface: Code

Retrieve the max length.

Specified by:

getMaxLength in interface Code

Returns:

max length

getValues

public List<RoleCodeValue> getValues()

Description copied from interface: Code

Retrieve all values for this code.

Specified by:

getValues in interface Code

Returns:

list of all values

getChildValues

public List<RoleCodeValue> getChildValues()

Description copied from interface: Code

Retrieve the immediate child values for this code.

Specified by:

getChildValues in interface Code

Returns:

list of child values

addValue

public void addValue(RoleCodeValue value)

Add value to this code.

Parameters:

value - new value

getValueByUniqueID

public RoleCodeValue getValueByUniqueID(Integer id)

Retrieve a value by unique ID.

Parameters:

id - unique ID

Returns:

value or null