curam.core.sl.impl

Class Attachment

java.lang.Object

curam.core.sl.base.Attachment

curam.core.sl.impl.Attachment

All Implemented Interfaces:

Attachment

Direct Known Subclasses:

AttachmentFactory

@AccessLevel(value=EXTERNAL)
public abstract class Attachment
extends Attachment

Field Summary

Fields

Modifier and Type	Field and Description
protected curam.attachment.impl.Attachment	attachment

Constructor Summary

Constructors

Constructor and Description
Attachment()

Method Summary

Modifier and Type	Method and Description
void	cancelAttachment(curam.core.struct.AttachmentKey key) Service layer method for canceling an attachment
void	cancelAttachmentAndAttachmentInfo(curam.core.struct.AttachmentKey attachmentKey) Cancels an Attachment and its corresponding Attachment Info record.
curam.core.struct.AttachmentKey	createAttachment(curam.core.struct.AttachmentDtls details) Service layer method for creating an attachment
curam.core.struct.AttachmentKey	createAttachmentAndAttachmentInfo(curam.core.sl.struct.AttachmentAndInfoDetails details) Creates a new Attachment and Attachment Info record (which stores additional information about the attachment).
void	modifyAttachment(curam.core.struct.AttachmentDtls details) Service layer method for modifying an attachment
curam.core.struct.AttachmentDtls	readAttachment(curam.core.struct.AttachmentKey key) Service layer method to read an Attachment
curam.core.sl.struct.AttachmentAndInfoDetails	readAttachmentAndAttachmentInfo(curam.core.struct.AttachmentKey key) Reads the details of an Attachment and its corresponding Attachment Info record.

Methods inherited from class java.lang.Object

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

Field Detail

attachment

@Inject
protected curam.attachment.impl.Attachment attachment

Constructor Detail

Attachment

public Attachment()

Method Detail

createAttachment

@AccessLevel(value=EXTERNAL)
public curam.core.struct.AttachmentKey createAttachment(curam.core.struct.AttachmentDtls details)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Service layer method for creating an attachment

Parameters:

details - Details of the attachment

Returns:

key The attachment key id

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelAttachment

@AccessLevel(value=EXTERNAL)
public void cancelAttachment(curam.core.struct.AttachmentKey key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Service layer method for canceling an attachment

Parameters:

key - The attachmentID to cancel

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyAttachment

@AccessLevel(value=EXTERNAL)
public void modifyAttachment(curam.core.struct.AttachmentDtls details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Service layer method for modifying an attachment

Parameters:

details - Attachment details to modify.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAttachment

@AccessLevel(value=EXTERNAL)
public curam.core.struct.AttachmentDtls readAttachment(curam.core.struct.AttachmentKey key)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Service layer method to read an Attachment

Parameters:

key - The attachmentID key

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAttachmentAndAttachmentInfo

public curam.core.sl.struct.AttachmentAndInfoDetails readAttachmentAndAttachmentInfo(curam.core.struct.AttachmentKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Reads the details of an Attachment and its corresponding Attachment Info record.

Parameters:

key - Contains the unique identifier of the Attachment.

Returns:

The details of the Attachment and its corresponding info.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelAttachmentAndAttachmentInfo

public void cancelAttachmentAndAttachmentInfo(curam.core.struct.AttachmentKey attachmentKey)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Cancels an Attachment and its corresponding Attachment Info record.

Parameters:

attachmentKey - Contains the unique identifier of the Attachment record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAttachmentAndAttachmentInfo

public curam.core.struct.AttachmentKey createAttachmentAndAttachmentInfo(curam.core.sl.struct.AttachmentAndInfoDetails details)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

Creates a new Attachment and Attachment Info record (which stores additional information about the attachment).

Parameters:

details - The file contents and other details to be stored in the Attachment and Attachment Info records.

Returns:

Details containing the unique id of the new Attachment record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException