org.kuali.rice.kns.bo
Class Note

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.bo.Note

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BusinessObject, PersistableBusinessObject

public class Note
extends PersistableBusinessObjectBase

Represents a user note in the system.

See Also:

Serialized Form

Field Summary

private AdHocRouteRecipient	adHocRouteRecipient
private Attachment	attachment
private String	attachmentIdentifier
private String	attachmentLink
private Person	authorUniversal
private String	authorUniversalIdentifier
private Long	noteIdentifier
private Timestamp	notePostedTimestamp
private String	notePurgeCode
private String	noteText
private String	noteTopicText
private NoteType	noteType
private String	noteTypeCode
private String	remoteObjectIdentifier
private static long	serialVersionUID

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Note()
Default constructor.

Method Summary

void	addAttachment(Attachment attachment) Adds the given attachment to this note.
AdHocRouteRecipient	getAdHocRouteRecipient()
Attachment	getAttachment() Gets the attachment attribute.
String	getAttachmentIdentifier() Gets the attachmentIdentifier attribute.
String	getAttachmentLink()
Person	getAuthorUniversal() Gets the authorUniversal attribute.
String	getAuthorUniversalIdentifier() Gets the authorUniversalIdentifier attribute.
Long	getNoteIdentifier() Gets the noteIdentifier attribute.
Timestamp	getNotePostedTimestamp() Gets the notePostedTimestamp attribute.
String	getNotePurgeCode() Gets the notePurgeCode attribute.
String	getNoteText() Gets the noteText attribute.
String	getNoteTopicText() Gets the noteTopicText attribute.
NoteType	getNoteType() Gets the noteType attribute.
String	getNoteTypeCode() Gets the noteTypeCode attribute.
String	getRemoteObjectIdentifier() Gets the remoteObjectIdentifier attribute.
void	removeAttachment() Removes the current attachment, if any.
void	setAdHocRouteRecipient(AdHocRouteRecipient adHocRouteRecipient)
void	setAttachment(Attachment attachment) Sets the attachment attribute value.
void	setAttachmentIdentifier(String attachmentIdentifier) Sets the attachmentIdentifier attribute value.
void	setAuthorUniversal(Person authorUniversal) Deprecated.
void	setAuthorUniversalIdentifier(String noteAuthorIdentifier) Sets the authorUniversalIdentifier attribute.
void	setNoteIdentifier(Long noteIdentifier) Sets the noteIdentifier attribute value.
void	setNotePostedTimestamp(Timestamp notePostedTimestamp) Sets the notePostedTimestamp attribute.
void	setNotePostedTimestampToCurrent() Sets the setNotePostedTimestamp(Timestamp) to the current time.
void	setNotePurgeCode(String notePurgeCode) Sets the notePurgeCode attribute.
void	setNoteText(String noteText) Sets the noteText attribute.
void	setNoteTopicText(String noteTopicText) Sets the noteTopicText attribute value.
void	setNoteType(NoteType noteType) Deprecated.
void	setNoteTypeCode(String noteTypeCode) Sets the noteTypeCode attribute.
void	setRemoteObjectIdentifier(String remoteObjectIdentifier) Sets the remoteObjectIdentifier attribute.
protected LinkedHashMap	toStringMapper()

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

noteIdentifier

private Long noteIdentifier

remoteObjectIdentifier

private String remoteObjectIdentifier

authorUniversalIdentifier

private String authorUniversalIdentifier

notePostedTimestamp

private Timestamp notePostedTimestamp

noteTypeCode

private String noteTypeCode

noteText

private String noteText

noteTopicText

private String noteTopicText

notePurgeCode

private String notePurgeCode

attachmentIdentifier

private String attachmentIdentifier

noteType

private NoteType noteType

authorUniversal

private Person authorUniversal

attachment

private Attachment attachment

adHocRouteRecipient

private AdHocRouteRecipient adHocRouteRecipient

attachmentLink

private String attachmentLink

Constructor Detail

Note

public Note()

Default constructor.

Method Detail

setNotePostedTimestampToCurrent

public void setNotePostedTimestampToCurrent()

Sets the setNotePostedTimestamp(Timestamp) to the current time.

getNoteIdentifier

public Long getNoteIdentifier()

Gets the noteIdentifier attribute.

Returns:

Returns the noteIdentifier.

setNoteIdentifier

public void setNoteIdentifier(Long noteIdentifier)

Sets the noteIdentifier attribute value.

Parameters:

noteIdentifier - The noteIdentifier to set.

getRemoteObjectIdentifier

public String getRemoteObjectIdentifier()

Gets the remoteObjectIdentifier attribute.

Returns:

Returns the remoteObjectIdentifier

setRemoteObjectIdentifier

public void setRemoteObjectIdentifier(String remoteObjectIdentifier)

Sets the remoteObjectIdentifier attribute.

Parameters:

remoteObjectIdentifier - The remoteObjectIdentifier to set.

getAuthorUniversalIdentifier

public String getAuthorUniversalIdentifier()

Gets the authorUniversalIdentifier attribute.

Returns:

Returns the authorUniversalIdentifier

setAuthorUniversalIdentifier

public void setAuthorUniversalIdentifier(String noteAuthorIdentifier)

Sets the authorUniversalIdentifier attribute.

Parameters:

authorUniversalIdentifier - The authorUniversalIdentifier to set.

getNotePostedTimestamp

public Timestamp getNotePostedTimestamp()

Gets the notePostedTimestamp attribute.

Returns:

Returns the notePostedTimestamp

setNotePostedTimestamp

public void setNotePostedTimestamp(Timestamp notePostedTimestamp)

Sets the notePostedTimestamp attribute.

Parameters:

notePostedTimestamp - The notePostedTimestamp to set.

getNoteTypeCode

public String getNoteTypeCode()

Gets the noteTypeCode attribute.

Returns:

Returns the noteTypeCode

setNoteTypeCode

public void setNoteTypeCode(String noteTypeCode)

Sets the noteTypeCode attribute.

Parameters:

noteTypeCode - The noteTypeCode to set.

getNoteText

public String getNoteText()

Gets the noteText attribute.

Returns:

Returns the noteText

setNoteText

public void setNoteText(String noteText)

Sets the noteText attribute.

Parameters:

noteText - The noteText to set.

getNoteTopicText

public String getNoteTopicText()

Gets the noteTopicText attribute.

Returns:

Returns the noteTopicText.

setNoteTopicText

public void setNoteTopicText(String noteTopicText)

Sets the noteTopicText attribute value.

Parameters:

noteTopicText - The noteTopicText to set.

getNotePurgeCode

public String getNotePurgeCode()

Gets the notePurgeCode attribute.

Returns:

Returns the notePurgeCode

setNotePurgeCode

public void setNotePurgeCode(String notePurgeCode)

Sets the notePurgeCode attribute.

Parameters:

notePurgeCode - The notePurgeCode to set.

getNoteType

public NoteType getNoteType()

Gets the noteType attribute.

Returns:

Returns the noteType.

setNoteType

public void setNoteType(NoteType noteType)

Deprecated.

Sets the noteType attribute value.

Parameters:

noteType - The noteType to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class BusinessObjectBase

Returns:

Map containing the fieldValues of the key fields for this class, indexed by fieldName

See Also:

BusinessObjectBase.toStringMapper()

getAuthorUniversal

public Person getAuthorUniversal()

Gets the authorUniversal attribute.

Returns:

Returns the authorUniversal.

setAuthorUniversal

public void setAuthorUniversal(Person authorUniversal)

Deprecated.

Sets the authorUniversal attribute value.

Parameters:

authorUniversal - The authorUniversal to set.

getAttachment

public Attachment getAttachment()

Gets the attachment attribute.

Returns:

Returns the attachment.

setAttachment

public void setAttachment(Attachment attachment)

Sets the attachment attribute value.

Parameters:

attachment - The attachment to set.

getAttachmentIdentifier

public String getAttachmentIdentifier()

Gets the attachmentIdentifier attribute.

Returns:

Returns the attachmentIdentifier.

setAttachmentIdentifier

public void setAttachmentIdentifier(String attachmentIdentifier)

Sets the attachmentIdentifier attribute value.

Parameters:

attachmentIdentifier - The attachmentIdentifier to set.

addAttachment

public void addAttachment(Attachment attachment)

Adds the given attachment to this note. More specifically, sets both the attachmentIdentifier and the attachment reference, since they both need to be done separately now that we aren't using anonymous keys.

Parameters:

attachment -

removeAttachment

public void removeAttachment()

Removes the current attachment, if any. More specifically, clears both the attachmentIdentifier and the attachment reference, since they both need to be done separately now that we aren't using anonymous keys.

getAdHocRouteRecipient

public AdHocRouteRecipient getAdHocRouteRecipient()

Returns:

the adHocRouteRecipient

setAdHocRouteRecipient

public void setAdHocRouteRecipient(AdHocRouteRecipient adHocRouteRecipient)

Parameters:

adHocRouteRecipient - the adHocRouteRecipient to set

getAttachmentLink

public String getAttachmentLink()

Returns:

the attachmentLink