org.kuali.kra.protocol.noteattachment

Interface TypedAttachment

All Known Implementing Classes:

IacucProtocolAttachmentPersonnel, IacucProtocolAttachmentProtocol, ProtocolAttachmentBase, ProtocolAttachmentPersonnel, ProtocolAttachmentPersonnelBase, ProtocolAttachmentProtocol, ProtocolAttachmentProtocolBase

public interface TypedAttachment

Defines a Attachment that has a type with a description.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TypedAttachment.PropertyName Contains all the property names that will be used by implementations.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Gets the Description.
Integer	getDocumentId() Gets the Document Id.
String	getGroupCode() The group code that the ProtocolBase Attachment belongs to.
ProtocolAttachmentTypeBase	getType() Gets the ProtocolBase Attachment Base Type.
String	getTypeCode() Gets the type Code .
void	setDescription(String description) Sets the Description.
void	setDocumentId(Integer documentId) Sets the Document Id.
void	setType(ProtocolAttachmentTypeBase type) Sets the ProtocolBase Attachment Base Type.
void	setTypeCode(String typeCode) Sets the type Code.

Method Detail

getType

ProtocolAttachmentTypeBase getType()

Gets the ProtocolBase Attachment Base Type.

Returns:

the ProtocolBase Attachment Base Type

setType

void setType(ProtocolAttachmentTypeBase type)

Sets the ProtocolBase Attachment Base Type.

Parameters:

type - the ProtocolBase Attachment Base Type

getTypeCode

String getTypeCode()

Gets the type Code .

Returns:

the type Code.

setTypeCode

void setTypeCode(String typeCode)

Sets the type Code.

Parameters:

typeCode - the type Code.

getDocumentId

Integer getDocumentId()

Gets the Document Id. The document id is used to allow multiple typed attachments to exist. So two attachments of the same type will have different document numbers.

Returns:

the Document Id

setDocumentId

void setDocumentId(Integer documentId)

Sets the Document Id.

Parameters:

documentId - the Document Id

See Also:

getDocumentId()

getDescription

String getDescription()

Gets the Description.

Returns:

the Description

setDescription

void setDescription(String description)

Sets the Description.

Parameters:

description - the Description

getGroupCode

String getGroupCode()

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

Returns:

the group code.