uk.ac.ed.epcc.safe.accounting.db

Interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>

Type Parameters:

T -

All Superinterfaces:

PropertyContainerParseTarget<T>

All Known Implementing Classes:

AllocationFactory, ChargedAllocationFactory, ConfigUsageRecordFactory, ParseUsageRecordFactory, SequenceAllocationFactory, UsageRecordParseTargetPlugIn

public interface UsageRecordParseTarget<T extends UsageRecordFactory.Use>
extends PropertyContainerParseTarget<T>

Interface for UsageRecord PropertyContainerParseTarget. Usage records are normally parsed once with duplicate values being ignored.

Author:

spb

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowReplace(DerivedPropertyMap map, T record) Should replacement of the existing record with new values be allowed.
boolean	commitRecord(PropertyContainer map, T record) Commit a new record also apply any required side-effects As the record may only contain a sub-set of the known properties the full PropertyContainer is passed separately
void	deleteRecord(T old_record) Delete an existing Record including any required side-effects
T	findDuplicate(T r) find a record in the database that is a previous version of the current line.
boolean	isComplete(T r) Is this a complete or partial record.
T	prepareRecord(DerivedPropertyMap map) Create an uncommitted DB record from the property map.
void	updateRecord(DerivedPropertyMap map, T record) Perform a full update of an existing record.

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.db.PropertyContainerParseTarget

endParse, getFinder, parse, splitRecords, startParse

Method Detail

findDuplicate

T findDuplicate(T r)
                                               throws java.lang.Exception

find a record in the database that is a previous version of the current line.

Throws:

java.lang.Exception

Parameters:

r - Uncommitted AccountingRecord

Returns:

Old AccountingRecord or null if not found

isComplete

boolean isComplete(T r)

Is this a complete or partial record.

Parameters:

r -

Returns:

boolean

deleteRecord

void deleteRecord(T old_record)
                  throws java.lang.Exception,
                         uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Delete an existing Record including any required side-effects

Throws:

java.lang.Exception

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Parameters:

old_record -

commitRecord

boolean commitRecord(PropertyContainer map,
                   T record)
                     throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Commit a new record also apply any required side-effects As the record may only contain a sub-set of the known properties the full PropertyContainer is passed separately

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

Parameters:

map - Full PropertyContainer for new record

record - new record to commit

Returns:

true if record was complete

updateRecord

void updateRecord(DerivedPropertyMap map,
                T record)
                  throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                         java.lang.Exception

Perform a full update of an existing record. This includes applying the side-effects corresponding to record delete and create

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

java.lang.Exception

Parameters:

map -

record -

prepareRecord

T prepareRecord(DerivedPropertyMap map)
                                               throws uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault,
                                                      InvalidPropertyException,
                                                      AccountingParseException

Create an uncommitted DB record from the property map.

Throws:

uk.ac.ed.epcc.webapp.model.data.Exceptions.DataFault

InvalidPropertyException

AccountingParseException

Parameters:

map -

Returns:

Uncommitted record

allowReplace

boolean allowReplace(DerivedPropertyMap map,
                   T record)

Should replacement of the existing record with new values be allowed. This is an extension point to allow policies to detect refunded jobs and veto a replacement.

Parameters:

map - DerivedPropertyMap of new parsed values

record - existing record

Returns:

boolean