org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentProtocolBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.ProtocolAssociateBase

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentBase

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentProtocolBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, TypedAttachment, Sequenceable, SequenceAssociate<ProtocolBase>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

IacucProtocolAttachmentProtocol, ProtocolAttachmentProtocol

public abstract class ProtocolAttachmentProtocolBase
extends ProtocolAttachmentBase

This class represents the ProtocolBase Attachment ProtocolBase.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolAttachmentProtocolBase.PropertyName Contains all the property names in this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected Integer	attachmentVersion
protected boolean	changed
protected String	comments
static String	COMPLETE_STATUS_CODE
protected String	contactEmailAddress
protected String	contactName
protected String	contactPhoneNumber
protected Timestamp	createTimestamp
protected String	description
protected String	documentStatusCode
static String	INCOMPLETE_STATUS_CODE
protected ProtocolAttachmentStatusBase	status
protected String	statusCode
protected ProtocolAttachmentTypeBase	type
protected String	typeCode
protected List<ProtocolAttachmentProtocolBase>	versions

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

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

extension, versionNumber

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolAttachmentProtocolBase() empty ctor to satisfy JavaBean convention.
protected	ProtocolAttachmentProtocolBase(ProtocolBase protocol) Convenience ctor to add the protocol as an owner.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
abstract String	getAttachmentDescription() A human readable description of the attachment type.
Integer	getAttachmentVersion()
String	getComments() Gets the ProtocolBase Attachment ProtocolBase Comments.
String	getContactEmailAddress() Gets the ProtocolBase Attachment ProtocolBase Contact Email Address.
String	getContactName() Gets the ProtocolBase Attachment ProtocolBase Contact Name.
String	getContactPhoneNumber() Gets the ProtocolBase Attachment ProtocolBase Contact Phone Number.
Timestamp	getCreateTimestamp()
String	getDescription() Gets the Description.
String	getDocumentStatusCode()
abstract String	getGroupCode() The group code that the ProtocolBase Attachment belongs to.
ProtocolAttachmentStatusBase	getStatus() Gets the ProtocolBase Attachment ProtocolBase Status.
String	getStatusCode() Gets the status Code.
ProtocolAttachmentTypeBase	getType() Gets the ProtocolBase Attachment Base Type.
String	getTypeCode() Gets the type Code .
List<ProtocolAttachmentProtocolBase>	getVersions() Gets the versions attribute.
int	hashCode()
boolean	isActive()
boolean	isChanged()
abstract boolean	isDeleted()
abstract boolean	isDraft()
abstract boolean	isFinal()
protected void	prePersist()
void	setActive(boolean active)
void	setAttachmentVersion(Integer attachmentVersion)
void	setChanged(boolean changed)
void	setComments(String comments) Sets the ProtocolBase Attachment ProtocolBase comments.
void	setContactEmailAddress(String contactEmailAddress) Sets the ProtocolBase Attachment ProtocolBase Contact Email Address.
void	setContactName(String contactName) Sets the ProtocolBase Attachment ProtocolBase Contact Name.
void	setContactPhoneNumber(String contactPhoneNumber) Sets the ProtocolBase Attachment ProtocolBase Contact Phone Number.
void	setCreateTimestamp(Timestamp createTimestamp)
abstract void	setDeleted()
void	setDescription(String description) Sets the Description.
void	setDocumentStatusCode(String documentStatusCode)
abstract void	setDraft()
abstract void	setFinal()
void	setStatus(ProtocolAttachmentStatusBase status) Sets the ProtocolBase Attachment ProtocolBase Status.
void	setStatusCode(String statusCode) Sets the status Code.
void	setType(ProtocolAttachmentTypeBase type) Sets the ProtocolBase Attachment Base Type.
void	setTypeCode(String typeCode) Sets the type Code.
void	setUpdateTimestamp(Timestamp updateTimestamp)
void	setUpdateUser(String updateUser) Sets the update user, making sure it is not the system user and truncating the name so it will fit.
void	setVersions(List<ProtocolAttachmentProtocolBase> versions) Sets the versions attribute value.
boolean	supportsVersioning() Method to check whether an attachment supports versioning.

Methods inherited from class org.kuali.kra.protocol.noteattachment.ProtocolAttachmentBase

addAttachmentToCollection, filterExistingAttachments, filterNewAttachments, getDocumentId, getFile, getFileId, getId, getNewFile, getUpdateUserFullName, isNew, removeAttachmentFromCollection, resetPersistenceState, setDocumentId, setFile, setFileId, setId, setNewFile, setUpdateUserFullName

Methods inherited from class org.kuali.kra.protocol.ProtocolAssociateBase

getProtocol, getProtocolId, getProtocolNumber, getSequenceNumber, getSequenceOwner, init, postInitHook, setProtocol, setProtocolId, setProtocolNumber, setSequenceNumber, setSequenceOwner

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, preUpdate, setUpdateUserSet

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

INCOMPLETE_STATUS_CODE

public static final String INCOMPLETE_STATUS_CODE

See Also:

Constant Field Values

COMPLETE_STATUS_CODE

public static final String COMPLETE_STATUS_CODE

See Also:

Constant Field Values

statusCode

protected String statusCode

status

protected ProtocolAttachmentStatusBase status

contactName

protected String contactName

contactEmailAddress

protected String contactEmailAddress

contactPhoneNumber

protected String contactPhoneNumber

comments

protected String comments

typeCode

protected String typeCode

type

protected ProtocolAttachmentTypeBase type

description

protected String description

documentStatusCode

protected String documentStatusCode

attachmentVersion

protected Integer attachmentVersion

createTimestamp

protected Timestamp createTimestamp

versions

protected List<ProtocolAttachmentProtocolBase> versions

active

protected boolean active

changed

protected boolean changed

Constructor Detail

ProtocolAttachmentProtocolBase

protected ProtocolAttachmentProtocolBase()

empty ctor to satisfy JavaBean convention.

ProtocolAttachmentProtocolBase

protected ProtocolAttachmentProtocolBase(ProtocolBase protocol)

Convenience ctor to add the protocol as an owner.

This ctor does not validate any of the properties.

Parameters:

protocol - the protocol.

Method Detail

getStatus

public ProtocolAttachmentStatusBase getStatus()

Gets the ProtocolBase Attachment ProtocolBase Status.

Returns:

the ProtocolBase Attachment ProtocolBase Status

setStatus

public void setStatus(ProtocolAttachmentStatusBase status)

Sets the ProtocolBase Attachment ProtocolBase Status.

Parameters:

status - the ProtocolBase Attachment ProtocolBase Status

getContactName

public String getContactName()

Gets the ProtocolBase Attachment ProtocolBase Contact Name.

Returns:

the ProtocolBase Attachment ProtocolBase Contact Name

setContactName

public void setContactName(String contactName)

Sets the ProtocolBase Attachment ProtocolBase Contact Name.

Parameters:

contactName - the ProtocolBase Attachment ProtocolBase Contact Name

getContactEmailAddress

public String getContactEmailAddress()

Gets the ProtocolBase Attachment ProtocolBase Contact Email Address.

Returns:

the ProtocolBase Attachment ProtocolBase Contact Email Address

setContactEmailAddress

public void setContactEmailAddress(String contactEmailAddress)

Sets the ProtocolBase Attachment ProtocolBase Contact Email Address.

Parameters:

contactEmailAddress - the ProtocolBase Attachment ProtocolBase Contact Email Address

getContactPhoneNumber

public String getContactPhoneNumber()

Gets the ProtocolBase Attachment ProtocolBase Contact Phone Number.

Returns:

the ProtocolBase Attachment ProtocolBase Contact Phone Number

setContactPhoneNumber

public void setContactPhoneNumber(String contactPhoneNumber)

Sets the ProtocolBase Attachment ProtocolBase Contact Phone Number.

Parameters:

contactPhoneNumber - the ProtocolBase Attachment ProtocolBase Contact Phone Number

getComments

public String getComments()

Gets the ProtocolBase Attachment ProtocolBase Comments.

Returns:

the ProtocolBase Attachment ProtocolBase Comments

setComments

public void setComments(String comments)

Sets the ProtocolBase Attachment ProtocolBase comments.

Parameters:

comments - the ProtocolBase Attachment ProtocolBase comments

getStatusCode

public String getStatusCode()

Gets the status Code.

Returns:

the status Code.

setStatusCode

public void setStatusCode(String statusCode)

Sets the status Code.

Parameters:

statusCode - the status Code.

getType

public ProtocolAttachmentTypeBase getType()

Gets the ProtocolBase Attachment Base Type.

Returns:

the ProtocolBase Attachment Base Type

setType

public void setType(ProtocolAttachmentTypeBase type)

Sets the ProtocolBase Attachment Base Type.

Parameters:

type - the ProtocolBase Attachment Base Type

getTypeCode

public String getTypeCode()

Gets the type Code .

Returns:

the type Code.

setTypeCode

public void setTypeCode(String typeCode)

Sets the type Code.

Parameters:

typeCode - the type Code.

getGroupCode

public abstract String getGroupCode()

The group code that the ProtocolBase Attachment belongs to. The group code relates to ProtocolAttachmentGroup.

Returns:

the group code.

getDescription

public String getDescription()

Gets the Description.

Returns:

the Description

setDescription

public void setDescription(String description)

Sets the Description.

Parameters:

description - the Description

getAttachmentDescription

public abstract String getAttachmentDescription()

A human readable description of the attachment type.

Specified by:

getAttachmentDescription in class ProtocolAttachmentBase

Returns:

a description

getVersions

public List<ProtocolAttachmentProtocolBase> getVersions()

Gets the versions attribute.

Returns:

Returns the versions.

setVersions

public void setVersions(List<ProtocolAttachmentProtocolBase> versions)

Sets the versions attribute value.

Parameters:

versions - The versions to set.

supportsVersioning

public boolean supportsVersioning()

Method to check whether an attachment supports versioning. Currently, all attachments have structural capabilities to version; however, currently we are not versioning all attachment types to be consistent with other parts of KC.

Specified by:

supportsVersioning in class ProtocolAttachmentBase

Returns:

true is attachment supports versioning.

isDraft

public abstract boolean isDraft()

setDraft

public abstract void setDraft()

isFinal

public abstract boolean isFinal()

setFinal

public abstract void setFinal()

isDeleted

public abstract boolean isDeleted()

setDeleted

public abstract void setDeleted()

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolAttachmentBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolAttachmentBase

getDocumentStatusCode

public String getDocumentStatusCode()

setDocumentStatusCode

public void setDocumentStatusCode(String documentStatusCode)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

setUpdateTimestamp

public void setUpdateTimestamp(Timestamp updateTimestamp)

Overrides:

setUpdateTimestamp in class KraPersistableBusinessObjectBase

setUpdateUser

public void setUpdateUser(String updateUser)

Description copied from class: KraPersistableBusinessObjectBase

Sets the update user, making sure it is not the system user and truncating the name so it will fit.

Overrides:

setUpdateUser in class KraPersistableBusinessObjectBase

Parameters:

updateUser - the user who updated this object

getAttachmentVersion

public Integer getAttachmentVersion()

setAttachmentVersion

public void setAttachmentVersion(Integer attachmentVersion)

isChanged

public boolean isChanged()

setChanged

public void setChanged(boolean changed)

getCreateTimestamp

public Timestamp getCreateTimestamp()

setCreateTimestamp

public void setCreateTimestamp(Timestamp createTimestamp)

prePersist

protected void prePersist()

Description copied from class: KraPersistableBusinessObjectBase

Overrides:

prePersist in class KraPersistableBusinessObjectBase

See Also:

org.kuali.core.bo.PersistableBusinessObjectBase#beforeInsert()