sapphire.attachmenthandler

Class BaseAttachmentHandler

java.lang.Object

com.labvantage.sapphire.BaseCustom

com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

sapphire.attachmenthandler.BaseAttachmentHandler

All Implemented Interfaces:

AttachmentHandler

public abstract class BaseAttachmentHandler
extends com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler
implements AttachmentHandler

Extend this class for your Attachment Handler implementation and implement the handleData method.

Field Summary

Fields inherited from class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

connectionInfo, database

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseAttachmentHandler()

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String filepath, java.lang.String aliasFileName, java.lang.String attachmentClass) Add a file to the return of the attachment handler The result will be this file will be come an additional attachment on the primary.
void	addFileMetaData(PropertyList propertyList, Attachment attachment) Will add one or many attributes to the provided attachment record.
void	addLinkSDI(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Add an sdi link which is a link from the primary executing the attachment handler to the sdi provided (e.g.
void	addMetaData(java.lang.String name, java.lang.String value) Will add an attribute to the primary record running the attachment handler (e.g.
java.lang.String	getAtachmentHandlerId() Returns the attachment handler keyid1
PropertyList	getFileMetaData(Attachment attachment) Returns the attributes for the provided attachment object
java.lang.String	getHandlerId() Returns the handler id
HandlerType	getHandlerType() Returns the HandlerType value of the enumeration
java.lang.String	getHelperURL() Returns the helper GUI The helper URL will be opened in a dialog and must return JSON of set up properties.
java.lang.String	getKeyId1() Returns the keyid1 for the primary that the attachment handler is running on
java.lang.String	getKeyId2() Returns the keyid2 for the primary that the attachment handler is running on
java.lang.String	getKeyId3() Returns the keyid3 for the primary that the attachment handler is running on
SDILinks	getLinkSDI() Returns the collection of sdi links
PropertyList	getMetaData() Returns all the attributes for the primary (e.g.
com.labvantage.sapphire.modules.sdms.util.ResultDataGrid	getResultGrid() Will return the result grid from the collection of result grids
com.labvantage.sapphire.modules.sdms.util.ResultDataGrid	getResultGrid(int resultgridindex) Will return a result grid from the collection of result grids
int	getResultResultGridCount() Will return the number of result grids added into this attachment handler
java.lang.String	getSDCId() Returns the sdcid for the primary that the attachment handler is running on (e.g.
abstract void	handleData(java.util.List<Attachment> attachments, PropertyList properties) Override this method to provide the entry point for your handler.
boolean	isDatabaseRequired() Returns true if the database object is required.
boolean	isDebugMode() Returns true if the handler is run in debug mode from a test button Debug mode will output higher level of logging
void	logMessage(java.lang.String message) Will add a message to the log which will end up being stored in the operation execution.
void	setActionBlock(ActionBlock actionBlock) Set the action block of the attachment handler
void	setResultGrid(com.labvantage.sapphire.modules.sdms.util.ResultDataGrid resultGrid) Add a result grid object into the result grid collection.

Methods inherited from class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

addResultGrid, getExecutionId, logDebug, logError, logError, logWarn, setDebugMode

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface sapphire.attachmenthandler.AttachmentHandler

addResultGrid

Constructor Detail

BaseAttachmentHandler

public BaseAttachmentHandler()

Method Detail

isDebugMode

public boolean isDebugMode()

Returns true if the handler is run in debug mode from a test button Debug mode will output higher level of logging

Overrides:

isDebugMode in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

getHelperURL

public java.lang.String getHelperURL()

Returns the helper GUI The helper URL will be opened in a dialog and must return JSON of set up properties. If this returns a value then the Attachment Handler maintenance page will show a Helper button

Overrides:

getHelperURL in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

getSDCId

public java.lang.String getSDCId()

Returns the sdcid for the primary that the attachment handler is running on (e.g. LV_DataCapture)

Specified by:

getSDCId in interface AttachmentHandler

Overrides:

getSDCId in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

the sdcid

getKeyId1

public java.lang.String getKeyId1()

Returns the keyid1 for the primary that the attachment handler is running on

Specified by:

getKeyId1 in interface AttachmentHandler

Overrides:

getKeyId1 in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

the keyid1

getKeyId2

public java.lang.String getKeyId2()

Returns the keyid2 for the primary that the attachment handler is running on

Specified by:

getKeyId2 in interface AttachmentHandler

Overrides:

getKeyId2 in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

the keyid2

getKeyId3

public java.lang.String getKeyId3()

Returns the keyid3 for the primary that the attachment handler is running on

Specified by:

getKeyId3 in interface AttachmentHandler

Overrides:

getKeyId3 in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

the keyid3

getAtachmentHandlerId

public java.lang.String getAtachmentHandlerId()

Returns the attachment handler keyid1

Specified by:

getAtachmentHandlerId in interface AttachmentHandler

Overrides:

getAtachmentHandlerId in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

the attachment handler id

logMessage

public void logMessage(java.lang.String message)

Will add a message to the log which will end up being stored in the operation execution.

Specified by:

logMessage in interface AttachmentHandler

Overrides:

logMessage in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

message -

addFile

public void addFile(java.lang.String filepath,
                    java.lang.String aliasFileName,
                    java.lang.String attachmentClass)

Add a file to the return of the attachment handler The result will be this file will be come an additional attachment on the primary.

Specified by:

addFile in interface AttachmentHandler

Overrides:

addFile in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

filepath -

aliasFileName -

attachmentClass -

setResultGrid

public void setResultGrid(com.labvantage.sapphire.modules.sdms.util.ResultDataGrid resultGrid)

Add a result grid object into the result grid collection.

Specified by:

setResultGrid in interface AttachmentHandler

Overrides:

setResultGrid in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

resultGrid - The result grid object you have constructed

getResultResultGridCount

public int getResultResultGridCount()

Will return the number of result grids added into this attachment handler

Specified by:

getResultResultGridCount in interface AttachmentHandler

Overrides:

getResultResultGridCount in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

An integer representing the number of result grids

getResultGrid

public com.labvantage.sapphire.modules.sdms.util.ResultDataGrid getResultGrid(int resultgridindex)

Will return a result grid from the collection of result grids

Specified by:

getResultGrid in interface AttachmentHandler

Overrides:

getResultGrid in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

resultgridindex - The index of the result grid in the collection

Returns:

The result grid object

getResultGrid

public com.labvantage.sapphire.modules.sdms.util.ResultDataGrid getResultGrid()

Will return the result grid from the collection of result grids

Specified by:

getResultGrid in interface AttachmentHandler

Overrides:

getResultGrid in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

The result grid object

addMetaData

public void addMetaData(java.lang.String name,
                        java.lang.String value)

Will add an attribute to the primary record running the attachment handler (e.g. Data Capture SDI)

Specified by:

addMetaData in interface AttachmentHandler

Overrides:

addMetaData in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

name -

value -

addFileMetaData

public void addFileMetaData(PropertyList propertyList,
                            Attachment attachment)

Will add one or many attributes to the provided attachment record.

Specified by:

addFileMetaData in interface AttachmentHandler

Overrides:

addFileMetaData in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

propertyList - The attributes key value pair

attachment - The attachment object to add the attributes to. This could be one of the attachments passed in.

setActionBlock

public void setActionBlock(ActionBlock actionBlock)

Set the action block of the attachment handler

Specified by:

setActionBlock in interface AttachmentHandler

Overrides:

setActionBlock in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

actionBlock - The action block object

addLinkSDI

public void addLinkSDI(java.lang.String sdcid,
                       java.lang.String keyid1,
                       java.lang.String keyid2,
                       java.lang.String keyid3)

Add an sdi link which is a link from the primary executing the attachment handler to the sdi provided (e.g. data capture to sample)

Specified by:

addLinkSDI in interface AttachmentHandler

Overrides:

addLinkSDI in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

sdcid - The sdcid to link to

keyid1 - The keyid1 to link to

keyid2 - The keyid2 to link to

keyid3 - The keyid3 to link to

isDatabaseRequired

public boolean isDatabaseRequired()

Returns true if the database object is required. Override and return false if you do not wish to load up the data base object.

Specified by:

isDatabaseRequired in interface AttachmentHandler

Overrides:

isDatabaseRequired in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

True or false

getFileMetaData

public PropertyList getFileMetaData(Attachment attachment)

Returns the attributes for the provided attachment object

Specified by:

getFileMetaData in interface AttachmentHandler

Overrides:

getFileMetaData in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

attachment - The attachment object to return attributes from

Returns:

A propertyly of key value pairs of attributes

getLinkSDI

public SDILinks getLinkSDI()

Returns the collection of sdi links

Specified by:

getLinkSDI in interface AttachmentHandler

Overrides:

getLinkSDI in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

The collection of sdi links

getHandlerId

public java.lang.String getHandlerId()

Returns the handler id

Specified by:

getHandlerId in interface AttachmentHandler

Overrides:

getHandlerId in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

The handler id

getMetaData

public PropertyList getMetaData()

Returns all the attributes for the primary (e.g. data capture meta data)

Specified by:

getMetaData in interface AttachmentHandler

Overrides:

getMetaData in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

The property list of attributes

handleData

public abstract void handleData(java.util.List<Attachment> attachments,
                                PropertyList properties)
                         throws SapphireException

Override this method to provide the entry point for your handler.

Specified by:

handleData in interface AttachmentHandler

Specified by:

handleData in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Parameters:

attachments - The collection of attachments to be processed that match the operation criteria (e.g. those with the correct class as defined in the operations)

properties - The set up properties for the attachment handler as defined in the operations

Throws:

SapphireException

getHandlerType

public HandlerType getHandlerType()

Returns the HandlerType value of the enumeration

Specified by:

getHandlerType in interface AttachmentHandler

Overrides:

getHandlerType in class com.labvantage.sapphire.modules.sdms.handlers.BaseAttachmentHandler

Returns:

The Handler Type