org.sandev.TaskHeap.sandmessages
Interface PlanComponentInterface

All Superinterfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandPersistMessage, org.sandev.basics.structs.SandStructMessage

All Known Implementing Classes:

ExternalPlan, Plan, PlanComponent, Task

public interface PlanComponentInterface
extends org.sandev.basics.structs.SandPersistMessage

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.PlanComponentStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary

Fields inherited from interface org.sandev.basics.structs.SandPersistMessage

RECORDSTATUS_ACTIVE, RECORDSTATUS_ARCHIVED, RECORDSTATUS_DELETED, WRITEACCESS_NORMAL, WRITEACCESS_READONLY

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

FIELDCHECK_EMPTYSTRINGPRINTVAL, FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Method Summary

void	addNotes(Note element) Appends a value to notes
void	addNotes(Note[] elements) Appends an array of values to notes
void	addResponsibilities(long element) Appends a value to responsibilities
void	addResponsibilities(long[] elements) Appends an array of values to responsibilities
void	clearNotes() Clears all values from notes
void	clearResponsibilities() Clears all values from responsibilities
long	getAssignedTo() Accessor for assignedTo
java.util.Date	getCreationTime() Accessor for creationTime
java.lang.String	getDescription() Accessor for description
java.util.Date	getDueDate() Accessor for dueDate
int	getDueDelta() Accessor for dueDelta
int	getDueDeltaSense() Accessor for dueDeltaSense
int	getDueDeltaValue() Accessor for dueDeltaValue
long	getDueReference() Accessor for dueReference
int	getDueTimeUnits() Accessor for dueTimeUnits
int	getDueType() Accessor for dueType
long	getHeap() Accessor for heap
int	getInstanceWriteAccess() Accessor for instanceWriteAccess
java.util.Date	getLastAccessedTime() Accessor for lastAccessedTime
java.lang.String	getLastModifiedReason() Accessor for lastModifiedReason
java.util.Date	getLastModifiedTime() Accessor for lastModifiedTime
java.lang.String	getName() Accessor for name
Note[]	getNotes() Accessor for notes.
Note	getNotes(int index) Returns the element at the specified index.
long	getParent() Accessor for parent
int	getRecordStatus() Accessor for recordStatus
int	getRelRoundDay() Accessor for relRoundDay
int	getRelRounding() Accessor for relRounding
long[]	getResponsibilities() Accessor for responsibilities.
long	getResponsibilities(int index) Returns the element at the specified index.
long	getRevisionNumber() Accessor for revisionNumber
int	getTimeEstimate() Accessor for timeEstimate
long	getUniqueID() Accessor for uniqueID
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal)
void	insertNotes(int index, Note value) Insert the specified element at the specified index.
void	insertResponsibilities(int index, long value) Insert the specified element at the specified index.
boolean	notesContains(Note val) Returns true if notes contains the specified value.
int	notesIndexOf(Note val) Return the index of the specified value in notes, or -1 if not found.
Note	removeNotes(int index) Remove the element at the specified index and return it.
boolean	removeNotesValue(Note value) Removes the given element from notes.
long	removeResponsibilities(int index) Remove the element at the specified index and return it.
boolean	removeResponsibilitiesValue(long value) Removes the given element from responsibilities.
boolean	responsibilitiesContains(long val) Returns true if responsibilities contains the specified value.
int	responsibilitiesIndexOf(long val) Return the index of the specified value in responsibilities, or -1 if not found.
void	setAssignedTo(long assignedTo) Mutator for assignedTo
void	setCreationTime(java.util.Date creationTime) Mutator for creationTime
void	setCreationTime(java.lang.Object creationTime) Generic mutator for creationTime
void	setDescription(java.lang.Object description) Generic mutator for description
void	setDescription(java.lang.String description) Mutator for description
void	setDueDate(java.util.Date dueDate) Mutator for dueDate
void	setDueDate(java.lang.Object dueDate) Generic mutator for dueDate
void	setDueDelta(int dueDelta) Mutator for dueDelta
void	setDueDeltaSense(int dueDeltaSense) Mutator for dueDeltaSense
void	setDueDeltaValue(int dueDeltaValue) Mutator for dueDeltaValue
void	setDueReference(long dueReference) Mutator for dueReference
void	setDueTimeUnits(int dueTimeUnits) Mutator for dueTimeUnits
void	setDueType(int dueType) Mutator for dueType
void	setHeap(long heap) Mutator for heap
void	setInstanceWriteAccess(int instanceWriteAccess) Mutator for instanceWriteAccess
void	setLastAccessedTime(java.util.Date lastAccessedTime) Mutator for lastAccessedTime
void	setLastAccessedTime(java.lang.Object lastAccessedTime) Generic mutator for lastAccessedTime
void	setLastModifiedReason(java.lang.Object lastModifiedReason) Generic mutator for lastModifiedReason
void	setLastModifiedReason(java.lang.String lastModifiedReason) Mutator for lastModifiedReason
void	setLastModifiedTime(java.util.Date lastModifiedTime) Mutator for lastModifiedTime
void	setLastModifiedTime(java.lang.Object lastModifiedTime) Generic mutator for lastModifiedTime
void	setName(java.lang.Object name) Generic mutator for name
void	setName(java.lang.String name) Mutator for name
void	setNotes(int index, Note value) Set the value at the index specified.
void	setNotes(Note[] notes) Mutator for notes
void	setNotes(java.lang.Object[] notes) Generic mutator for notes
void	setParent(long parent) Mutator for parent
void	setRecordStatus(int recordStatus) Mutator for recordStatus
void	setRelRoundDay(int relRoundDay) Mutator for relRoundDay
void	setRelRounding(int relRounding) Mutator for relRounding
void	setResponsibilities(int index, long value) Set the value at the index specified.
void	setResponsibilities(long[] responsibilities) Mutator for responsibilities
void	setRevisionNumber(long revisionNumber) Mutator for revisionNumber
void	setTimeEstimate(int timeEstimate) Mutator for timeEstimate
void	setUniqueID(long uniqueID) Mutator for uniqueID
int	sizeofNotes() Returns the size of notes.
int	sizeofResponsibilities() Returns the size of responsibilities.

Methods inherited from interface org.sandev.basics.structs.SandStructMessage

find, getInstance, getInstance, getPrintname

Methods inherited from interface org.sandev.basics.structs.SandInstanceMessage

cloneMessage, convertToSuperstructClass, copyFieldValue, debugDump, defaultField, fieldHasFlag, fieldsValid, fieldValidate, generalAccessor, generalDereference, generalModifier, getAllFields, getContainedMessageFields, getDisplayFields, getDisplayFieldsPrint, getDisplayID, getDisplayValues, getLayoutXML, getPrintnameForField

Methods inherited from interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse, getCollectionMessage, getQueryMessage, getShortName, getStructMessage, getUpdateMessage, isEquivalent

Method Detail

getName

java.lang.String getName()

Accessor for name

setName

void setName(java.lang.String name)

Mutator for name

setName

void setName(java.lang.Object name)

Generic mutator for name

getDescription

java.lang.String getDescription()

Accessor for description

setDescription

void setDescription(java.lang.String description)

Mutator for description

setDescription

void setDescription(java.lang.Object description)

Generic mutator for description

getParent

long getParent()

Accessor for parent

setParent

void setParent(long parent)

Mutator for parent

getHeap

long getHeap()

Accessor for heap

setHeap

void setHeap(long heap)

Mutator for heap

getTimeEstimate

int getTimeEstimate()

Accessor for timeEstimate

setTimeEstimate

void setTimeEstimate(int timeEstimate)

Mutator for timeEstimate

getResponsibilities

long[] getResponsibilities()

Accessor for responsibilities. The returned value may or may not be the actual data member. Always write back a changed array using setResponsibilities.

setResponsibilities

void setResponsibilities(long[] responsibilities)

Mutator for responsibilities

addResponsibilities

void addResponsibilities(long element)

Appends a value to responsibilities

addResponsibilities

void addResponsibilities(long[] elements)

Appends an array of values to responsibilities

getResponsibilities

long getResponsibilities(int index)

Returns the element at the specified index. Returns -1 if responsibilities is null or smaller than index.

setResponsibilities

void setResponsibilities(int index,
                         long value)

Set the value at the index specified.

insertResponsibilities

void insertResponsibilities(int index,
                            long value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeResponsibilities

long removeResponsibilities(int index)

Remove the element at the specified index and return it.

removeResponsibilitiesValue

boolean removeResponsibilitiesValue(long value)

Removes the given element from responsibilities. Returns true if the element was found.

clearResponsibilities

void clearResponsibilities()

Clears all values from responsibilities

responsibilitiesContains

boolean responsibilitiesContains(long val)

Returns true if responsibilities contains the specified value.

responsibilitiesIndexOf

int responsibilitiesIndexOf(long val)

Return the index of the specified value in responsibilities, or -1 if not found.

sizeofResponsibilities

int sizeofResponsibilities()

Returns the size of responsibilities. Returns -1 if responsibilities is null.

getAssignedTo

long getAssignedTo()

Accessor for assignedTo

setAssignedTo

void setAssignedTo(long assignedTo)

Mutator for assignedTo

getDueType

int getDueType()

Accessor for dueType

setDueType

void setDueType(int dueType)

Mutator for dueType

getDueDate

java.util.Date getDueDate()

Accessor for dueDate

setDueDate

void setDueDate(java.util.Date dueDate)

Mutator for dueDate

setDueDate

void setDueDate(java.lang.Object dueDate)

Generic mutator for dueDate

getDueDelta

int getDueDelta()

Accessor for dueDelta

setDueDelta

void setDueDelta(int dueDelta)

Mutator for dueDelta

getDueDeltaValue

int getDueDeltaValue()

Accessor for dueDeltaValue

setDueDeltaValue

void setDueDeltaValue(int dueDeltaValue)

Mutator for dueDeltaValue

getDueDeltaSense

int getDueDeltaSense()

Accessor for dueDeltaSense

setDueDeltaSense

void setDueDeltaSense(int dueDeltaSense)

Mutator for dueDeltaSense

getDueTimeUnits

int getDueTimeUnits()

Accessor for dueTimeUnits

setDueTimeUnits

void setDueTimeUnits(int dueTimeUnits)

Mutator for dueTimeUnits

getDueReference

long getDueReference()

Accessor for dueReference

setDueReference

void setDueReference(long dueReference)

Mutator for dueReference

getRelRounding

int getRelRounding()

Accessor for relRounding

setRelRounding

void setRelRounding(int relRounding)

Mutator for relRounding

getRelRoundDay

int getRelRoundDay()

Accessor for relRoundDay

setRelRoundDay

void setRelRoundDay(int relRoundDay)

Mutator for relRoundDay

getNotes

Note[] getNotes()

Accessor for notes. The returned value may or may not be the actual data member. Always write back a changed array using setNotes.

setNotes

void setNotes(Note[] notes)

Mutator for notes

setNotes

void setNotes(java.lang.Object[] notes)

Generic mutator for notes

addNotes

void addNotes(Note element)

Appends a value to notes

addNotes

void addNotes(Note[] elements)

Appends an array of values to notes

getNotes

Note getNotes(int index)

Returns the element at the specified index. Returns null if notes is null or smaller than index.

setNotes

void setNotes(int index,
              Note value)

Set the value at the index specified.

insertNotes

void insertNotes(int index,
                 Note value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeNotes

Note removeNotes(int index)

Remove the element at the specified index and return it.

removeNotesValue

boolean removeNotesValue(Note value)

Removes the given element from notes. Returns true if the element was found.

clearNotes

void clearNotes()

Clears all values from notes

notesContains

boolean notesContains(Note val)

Returns true if notes contains the specified value.

notesIndexOf

int notesIndexOf(Note val)

Return the index of the specified value in notes, or -1 if not found.

sizeofNotes

int sizeofNotes()

Returns the size of notes. Returns -1 if notes is null.

getUniqueID

long getUniqueID()

Accessor for uniqueID

Specified by:

getUniqueID in interface org.sandev.basics.structs.SandPersistMessage

setUniqueID

void setUniqueID(long uniqueID)

Mutator for uniqueID

Specified by:

setUniqueID in interface org.sandev.basics.structs.SandPersistMessage

getCreationTime

java.util.Date getCreationTime()

Accessor for creationTime

Specified by:

getCreationTime in interface org.sandev.basics.structs.SandPersistMessage

setCreationTime

void setCreationTime(java.util.Date creationTime)

Mutator for creationTime

setCreationTime

void setCreationTime(java.lang.Object creationTime)

Generic mutator for creationTime

getLastModifiedTime

java.util.Date getLastModifiedTime()

Accessor for lastModifiedTime

Specified by:

getLastModifiedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedTime

void setLastModifiedTime(java.util.Date lastModifiedTime)

Mutator for lastModifiedTime

setLastModifiedTime

void setLastModifiedTime(java.lang.Object lastModifiedTime)

Generic mutator for lastModifiedTime

getLastModifiedReason

java.lang.String getLastModifiedReason()

Accessor for lastModifiedReason

Specified by:

getLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

void setLastModifiedReason(java.lang.String lastModifiedReason)

Mutator for lastModifiedReason

Specified by:

setLastModifiedReason in interface org.sandev.basics.structs.SandPersistMessage

setLastModifiedReason

void setLastModifiedReason(java.lang.Object lastModifiedReason)

Generic mutator for lastModifiedReason

getRevisionNumber

long getRevisionNumber()

Accessor for revisionNumber

Specified by:

getRevisionNumber in interface org.sandev.basics.structs.SandPersistMessage

setRevisionNumber

void setRevisionNumber(long revisionNumber)

Mutator for revisionNumber

Specified by:

setRevisionNumber in interface org.sandev.basics.structs.SandPersistMessage

getLastAccessedTime

java.util.Date getLastAccessedTime()

Accessor for lastAccessedTime

Specified by:

getLastAccessedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastAccessedTime

void setLastAccessedTime(java.util.Date lastAccessedTime)

Mutator for lastAccessedTime

Specified by:

setLastAccessedTime in interface org.sandev.basics.structs.SandPersistMessage

setLastAccessedTime

void setLastAccessedTime(java.lang.Object lastAccessedTime)

Generic mutator for lastAccessedTime

getInstanceWriteAccess

int getInstanceWriteAccess()

Accessor for instanceWriteAccess

Specified by:

getInstanceWriteAccess in interface org.sandev.basics.structs.SandPersistMessage

setInstanceWriteAccess

void setInstanceWriteAccess(int instanceWriteAccess)

Mutator for instanceWriteAccess

Specified by:

setInstanceWriteAccess in interface org.sandev.basics.structs.SandPersistMessage

getRecordStatus

int getRecordStatus()

Accessor for recordStatus

Specified by:

getRecordStatus in interface org.sandev.basics.structs.SandPersistMessage

setRecordStatus

void setRecordStatus(int recordStatus)

Mutator for recordStatus

getValueForFieldName

java.lang.String getValueForFieldName(java.lang.String fieldname,
                                      org.sandev.basics.util.IDLookup lookup,
                                      org.sandev.basics.util.AuthUser user,
                                      java.lang.String defaultVal)