org.kuali.kra.bo

Class AttachmentFile

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.SeparateAssociate

org.kuali.kra.bo.AttachmentFile

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, KcAttachment, SeparatelySequenceableAssociate, Sequenceable, 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

public class AttachmentFile
extends SeparateAssociate
implements KcAttachment

Represents a Protocol Attachment File.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttachmentFile.CreateException Exception thrown when unable to create instance from static factory.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FILE_NAME_LENGTH the max file name length.
static int	MAX_FILE_TYPE_LENGTH the max file type length.

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

Constructor and Description
AttachmentFile() empty ctor to satisfy JavaBean convention.
AttachmentFile(String name, String type, byte[] data) Convenience ctor to set the relevant properties of this class.

Method Summary

Methods

Modifier and Type	Method and Description
static AttachmentFile	createFromFormFile(org.apache.struts.upload.FormFile formFile) factory method creating an instance from a FormFile.
boolean	equals(Object obj)
byte[]	getData() Gets the Protocol Attachment File data.
String	getIconPath() Return the image file path based on mime type or other criteria.
Long	getId() Gets the id.
String	getName() Gets the Protocol Attachment File name.
String	getType() Gets the Protocol Attachment File type.
int	hashCode()
void	setData(byte[] data) Sets the Protocol Attachment File data.
void	setId(Long id) Sets the id.
void	setName(String name) Sets the Protocol Attachment File name.
void	setType(String type) Sets the Protocol Attachment File type.

Methods inherited from class org.kuali.kra.SeparateAssociate

getSequenceNumber, incrementSequenceNumber, resetPersistenceState, setSequenceNumber

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

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, 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

MAX_FILE_NAME_LENGTH

public static final int MAX_FILE_NAME_LENGTH

the max file name length. length=150

See Also:

Constant Field Values

MAX_FILE_TYPE_LENGTH

public static final int MAX_FILE_TYPE_LENGTH

the max file type length. length=250

See Also:

Constant Field Values

Constructor Detail

AttachmentFile

public AttachmentFile()

empty ctor to satisfy JavaBean convention.

AttachmentFile

public AttachmentFile(String name,
              String type,
              byte[] data)

Convenience ctor to set the relevant properties of this class.

This ctor does not validate any of the properties.

Parameters:

name - the name.

type - the type.

data - the data.

Method Detail

createFromFormFile

public static final AttachmentFile createFromFormFile(org.apache.struts.upload.FormFile formFile)

factory method creating an instance from a FormFile.

If the file name's length > MAX_FILE_NAME_LENGTH then the name will be modified.

If the file type's length > MAX_FILE_TYPE_LENGTH then the type will be modified.

Parameters:

formFile - the FormFile

Returns:

an instance

Throws:

IllegalArgumentException - if the formfile is null.

AttachmentFile.CreateException - if unable to create from FormFile.

getName

public String getName()

Gets the Protocol Attachment File name.

Specified by:

getName in interface KcAttachment

Returns:

the Protocol Attachment File name

setName

public void setName(String name)

Sets the Protocol Attachment File name.

Parameters:

name - the Protocol Attachment File name

getType

public String getType()

Gets the Protocol Attachment File type.

Specified by:

getType in interface KcAttachment

Returns:

the Protocol Attachment File type

setType

public void setType(String type)

Sets the Protocol Attachment File type.

Parameters:

type - the Protocol Attachment File type

getData

public byte[] getData()

Gets the Protocol Attachment File data.

Specified by:

getData in interface KcAttachment

Returns:

the Protocol Attachment File data

setData

public void setData(byte[] data)

Sets the Protocol Attachment File data.

Parameters:

data - the Protocol Attachment File data

hashCode

public int hashCode()

Overrides:

hashCode in class SeparateAssociate

equals

public boolean equals(Object obj)

Overrides:

equals in class SeparateAssociate

getIconPath

public String getIconPath()

Description copied from interface: KcAttachment

Return the image file path based on mime type or other criteria.

Specified by:

getIconPath in interface KcAttachment

Returns:

getId

public Long getId()

Description copied from class: SeparateAssociate

Gets the id.

Overrides:

getId in class SeparateAssociate

Returns:

the id

setId

public void setId(Long id)

Description copied from class: SeparateAssociate

Sets the id.

Overrides:

setId in class SeparateAssociate

Parameters:

id - the id