Money Mobiliser API Reference - SyBooks...
Transcript of Money Mobiliser API Reference - SyBooks...
-
Money Mobiliser API Reference
Sybase Mobiliser Platform 5.1SP03
-
DOCUMENT ID: DC01980-01-0513-01LAST REVISED: August 2013Copyright © 2013 by Sybase, Inc. All rights reserved.This publication pertains to Sybase software and to any subsequent release until otherwise indicated in new editions ortechnical notes. Information in this document is subject to change without notice. The software described herein is furnishedunder a license agreement, and it may be used or copied only in accordance with the terms of that agreement.Upgrades are provided only at regularly scheduled software release dates. No part of this publication may be reproduced,transmitted, or translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the priorwritten permission of Sybase, Inc.Sybase trademarks can be viewed at the Sybase trademarks page at http://www.sybase.com/detail?id=1011207. Sybase andthe marks listed are trademarks of Sybase, Inc. ® indicates registration in the United States of America.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registeredtrademarks of SAP AG in Germany and in several other countries all over the world.Java and all Java-based marks are trademarks or registered trademarks of Oracle and/or its affiliates in the U.S. and othercountries.Unicode and the Unicode Logo are registered trademarks of Unicode, Inc.All other company and product names mentioned may be trademarks of the respective companies with which they areassociated.Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.Sybase, Inc., One Sybase Drive, Dublin, CA 94568.
http://www.sybase.com/detail?id=1011207
-
Contents
com.sybase365.mobiliser.money package .........................1ams package ..................................................................1
dao package ..........................................................1export package ....................................................50
businesslogic package ..................................................59audit package ......................................................60authentication package ........................................68billpayment package ............................................76binary package ....................................................83bulkprocessing package ......................................93customer package .............................................110fee package .......................................................157invoice package .................................................166normalizer package ...........................................174oauth2 package .................................................178payment package ...............................................179system package .................................................218transaction package ...........................................258umgr package ....................................................424umgrroles package ............................................435util package ........................................................438wallet package ...................................................491
coupon package .........................................................507businesslogic package .......................................507dao package ......................................................537
flows package .............................................................590bulkfileprocessing package ................................590customer package .............................................595wallet package ...................................................605
jobs package ...............................................................609alerts package ...................................................609
Money Mobiliser API Reference iii
-
event package ....................................................634tasks package ....................................................659
odc package ...............................................................664businesslogic package .......................................664dao package ......................................................674
persistence package ...................................................700dao package ......................................................700model package ..................................................826
svcpkg package ........................................................1603businesslogic package .....................................1603dao package ....................................................1616
Contents
iv Sybase Mobiliser Platform
-
com.sybase365.mobiliser.money package
MembersAll public members of the money package.
• ams package –• businesslogic package –• coupon package –• flows package –• jobs package –• odc package –• persistence package –• svcpkg package –
ams package
MembersAll public members of the ams package.
• dao package –• export package –
dao package
MembersAll public members of the dao package.
• api package –• model package –
api package
MembersAll public members of the api package.
• BookingDao interface – Interface BookingDao for accessing the Booking entity.• ClearingConfigDao interface – Interface ClearingConfigDao for accessing the
ClearingConfig entity.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 1
-
• CurrencyExchangeDao interface – Interface CurrencyExchangeDao for accessing theCurrencyExchange entity.
• DocDao interface – Interface DocDao for accessing the Doc entity.• PaymentDao interface – Interface PaymentDao for accessing the Payment entity.• PiBalanceDao interface – Interface PiBalanceDao for accessing the PiBalance entity.• ReversalDao interface – Interface ReversalDao for accessing the Reversal entity.
BookingDao interfaceInterface BookingDao for accessing the Booking entity.
Syntaxpublic interface BookingDao
Usage2013 SAP® AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
ClearingConfigDao interfaceInterface ClearingConfigDao for accessing the ClearingConfig entity.
Syntaxpublic interface ClearingConfigDao
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
CurrencyExchangeDao interfaceInterface CurrencyExchangeDao for accessing the CurrencyExchange entity.
Syntaxpublic interface CurrencyExchangeDao
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
2 Sybase Mobiliser Platform
-
DocDao interfaceInterface DocDao for accessing the Doc entity.
Syntaxpublic interface DocDao
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
PaymentDao interfaceInterface PaymentDao for accessing the Payment entity.
Syntaxpublic interface PaymentDao
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
PiBalanceDao interfaceInterface PiBalanceDao for accessing the PiBalance entity.
Syntaxpublic interface PiBalanceDao
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
ReversalDao interfaceInterface ReversalDao for accessing the Reversal entity.
Syntaxpublic interface ReversalDao
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 3
-
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
model package
MembersAll public members of the model package.
• Booking class – Booking Entity bean.• ClearingConfig class – ClearingConfig.• CurrencyExchange class – CurrencyExchange.• Doc class – Doc.• Payment class – Payment.• PiBalance class – PiBalance.• Reversal class – Reversal.
Booking classBooking Entity bean.
Syntaxpublic class Booking
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
BookingPk class
Syntaxpublic class BookingPk
UsageThis is the embedded primary key, comprising the according document this booking belongsto and the sequence of this booking within the document.
© 2000-2009 by paybox solutions AG
Revision:1.2Name:not supported by cvs2svn
com.sybase365.mobiliser.money package
4 Sybase Mobiliser Platform
-
BookingPk() constructor
SyntaxBookingPk ()
Usage
Creates a new instance of
BookingPk.
BookingPk(Long, int) constructor
SyntaxBookingPk ( Long docId , int sequence )
Parameters
• doc – the according document this booking belongs to• sequence – the sequence of this booking within the document
Usage
Creates a new instance of
BookingPk.
compareTo(BookingPk) method
Syntaxint compareTo ( BookingPk o )
equals(Object) method
Syntaxboolean equals ( Object arg0 )
getDocId() method
SyntaxLong getDocId ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 5
-
Returnsthe docId
Usage
the docId
getSequence() method
Syntaxint getSequence ()
Returnsthe sequence of this booking within the document
Usage
the sequence of this booking within the document
hashCode() method
Syntaxint hashCode ()
setDocId(Long) method
Syntaxvoid setDocId ( Long docId )
Parameters
• docId – the docId to set
setSequence(int) method
Syntaxvoid setSequence ( int sequence )
Parameters
• sequence – the sequence of this booking within the document
com.sybase365.mobiliser.money package
6 Sybase Mobiliser Platform
-
toString() method
SyntaxString toString ()
Booking() constructor
SyntaxBooking ()
Usage
Creates a new instance of
TcmDtinFile.
Booking(BookingPk) constructor
SyntaxBooking ( BookingPk id )
Parameters
• id – the PK
Usage
Creates a new instance of
Booking.
getAmount() method
SyntaxBigDecimal getAmount ()
Returnsthe amount of the instance
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 7
-
Usage
the amount of the instance
getAmountBalance() method
SyntaxBigDecimal getAmountBalance ()
Returnsthe amountBalance
Usage
the amountBalance
getBookingType() method
SyntaxString getBookingType ()
Returnsthe bookingType
Usage
the bookingType
getClearingModeId() method
SyntaxString getClearingModeId ()
Returnsthe clearingModeId
Usage
the clearingModeId
getClearingNumber() method
SyntaxLong getClearingNumber ()
com.sybase365.mobiliser.money package
8 Sybase Mobiliser Platform
-
Returnsthe clearingNumber
Usage
the clearingNumber
getClearingPiId() method
SyntaxLong getClearingPiId ()
Returnsthe clearingPiId
Usage
the clearingPiId
getCustomerId() method
SyntaxLong getCustomerId ()
Returnsthe customerId
Usage
the customerId
getDbOp() method
SyntaxCharacter getDbOp ()
Returnsthe dbOp
Usage
the dbOp
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 9
-
getFeeTypeId() method
SyntaxInteger getFeeTypeId ()
Returnsthe feeTypeid
Usage
the feeTypeid
getOriginalPiId() method
SyntaxLong getOriginalPiId ()
Returnsthe originalPiId
Usage
the originalPiId
getPiId() method
Syntaxlong getPiId ()
Returnsthe piId
Usage
the piId
getStatus() method
Syntaxint getStatus ()
Returnsthe status
com.sybase365.mobiliser.money package
10 Sybase Mobiliser Platform
-
Usage
the status
getTxnDate() method
SyntaxDate getTxnDate ()
Returnsthe posting date of the instance
Usage
the posting date of the instance
isCredit() method
Syntaxboolean isCredit ()
Returnstrue if this instance is a credit booking; false otherwise
Usage
true if this instance is a credit booking; false otherwise
isSetAmount() method
Syntaxboolean isSetAmount ()
isSetAmountBalance() method
Syntaxboolean isSetAmountBalance ()
isSetBookingType() method
Syntaxboolean isSetBookingType ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 11
-
isSetClearingModeId() method
Syntaxboolean isSetClearingModeId ()
Returnsthe clearingModeId
Usage
the clearingModeId
isSetClearingNumber() method
Syntaxboolean isSetClearingNumber ()
isSetClearingPiId() method
Syntaxboolean isSetClearingPiId ()
Returnsthe clearingPiId
Usage
the clearingPiId
isSetCredit() method
Syntaxboolean isSetCredit ()
isSetCustomerId() method
Syntaxboolean isSetCustomerId ()
Returnsthe customerId
com.sybase365.mobiliser.money package
12 Sybase Mobiliser Platform
-
Usage
the customerId
isSetDbOp() method
Syntaxboolean isSetDbOp ()
isSetFeeTypeId() method
Syntaxboolean isSetFeeTypeId ()
Returnsthe feeTypeid
Usage
the feeTypeid
isSetOriginalPiId() method
Syntaxboolean isSetOriginalPiId ()
Returnsthe originalPiId
Usage
the originalPiId
isSetPiId() method
Syntaxboolean isSetPiId ()
Returnsthe piId
Usage
the piId
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 13
-
isSetStatus() method
Syntaxboolean isSetStatus ()
isSetTxnDate() method
Syntaxboolean isSetTxnDate ()
setAmount(BigDecimal) method
Syntaxvoid setAmount ( BigDecimal amount )
Parameters
• amount – the amount to set
setAmountBalance(BigDecimal) method
Syntaxvoid setAmountBalance ( BigDecimal amountBalance )
Parameters
• amountBalance – the amountBalance to set
setBookingType(String) method
Syntaxvoid setBookingType ( String bookingType )
Parameters
• bookingType – the bookingType to set
setClearingModeId(String) method
Syntaxvoid setClearingModeId ( String clearingModeId )
com.sybase365.mobiliser.money package
14 Sybase Mobiliser Platform
-
Parameters
• clearingModeId – the clearingModeId to set
setClearingNumber(Long) method
Syntaxvoid setClearingNumber ( Long clearingNumber )
Parameters
• clearingNumber – the clearingNumber to set
setClearingPiId(Long) method
Syntaxvoid setClearingPiId ( Long clearingPiId )
Parameters
• clearingPiId – the clearingPiId to set
setCredit(boolean) method
Syntaxvoid setCredit ( boolean credit )
Parameters
• credit – the credit value to set
setCustomerId(Long) method
Syntaxvoid setCustomerId ( Long customerId )
Parameters
• customerId – the customerId to set
setDbOp(Character) method
Syntaxvoid setDbOp ( Character dbOp )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 15
-
Parameters
• dbOp – the dbOp to set
setFeeTypeId(Integer) method
Syntaxvoid setFeeTypeId ( Integer feeTypeId )
Parameters
• feeTypeid – the feeTypeid to set
setOriginalPiId(Long) method
Syntaxvoid setOriginalPiId ( Long originalPiId )
Parameters
• originalPiId – the originalPiId to set
setPiId(long) method
Syntaxvoid setPiId ( long piId )
Parameters
• piId – the piId to set
setStatus(int) method
Syntaxvoid setStatus ( int status )
Parameters
• status – the status to set
setTxnDate(Date) method
Syntaxvoid setTxnDate ( Date txnDate )
com.sybase365.mobiliser.money package
16 Sybase Mobiliser Platform
-
Parameters
• txnDate – the posting date to set
ClearingConfig classClearingConfig.
Syntaxpublic class ClearingConfig
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
ClearingConfigPk class
Syntaxpublic class ClearingConfigPk
UsageThis is the embedded primary key, comprising the according document this ClearingConfigbelongs to.
© 2000-2009 by paybox solutions AG
Revision:1.2Name:not supported by cvs2svn
ClearingConfigPk() constructor
SyntaxClearingConfigPk ()
Usage
Creates a new instance of
BookingPk.
ClearingConfigPk(String, String, String, Currency) constructor
SyntaxClearingConfigPk ( String orgunitId , String settlementModeId , StringclearingModeId , Currency currency )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 17
-
Usage
Creates a new instance of
BookingPk.
compareTo(ClearingConfigPk) method
Syntaxint compareTo ( ClearingConfigPk o )
equals(Object) method
Syntaxboolean equals ( Object arg0 )
getClearingModeId() method
SyntaxString getClearingModeId ()
Returnsthe clearingModeId
Usage
the clearingModeId
getCurrency() method
SyntaxCurrency getCurrency ()
Returnsthe currency of the instance
Usage
the currency of the instance
com.sybase365.mobiliser.money package
18 Sybase Mobiliser Platform
-
getOrgunitId() method
SyntaxString getOrgunitId ()
getSettlementModeId() method
SyntaxString getSettlementModeId ()
Returnsthe settlementModeId
Usage
the settlementModeId
hashCode() method
Syntaxint hashCode ()
setClearingModeId(String) method
Syntaxvoid setClearingModeId ( String clearingModeId )
Parameters
• clearingModeId – the clearingModeId to set
setCurrency(Currency) method
Syntaxvoid setCurrency ( Currency currency )
Parameters
• the – currency to set
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 19
-
setOrgunitId(String) method
Syntaxvoid setOrgunitId ( String orgunitId )
setSettlementModeId(String) method
Syntaxvoid setSettlementModeId ( String settlementModeId )
Parameters
• settlementModeId – the settlementModeId to set
toString() method
SyntaxString toString ()
ClearingConfig() constructor
SyntaxClearingConfig ()
Usage
Creates a new instance of
Product.
ClearingConfig(ClearingConfigPk) constructor
SyntaxClearingConfig ( ClearingConfigPk id )
Usage
Creates a new instance of
Product.
com.sybase365.mobiliser.money package
20 Sybase Mobiliser Platform
-
getClearingPi() method
SyntaxPaymentInstrument getClearingPi ()
Returnsthe clearingPi
Usage
the clearingPi
setClearingPi(PaymentInstrument) method
Syntaxvoid setClearingPi ( PaymentInstrument clearingPi )
Parameters
• clearingPi – the clearingPi to set
CurrencyExchange classCurrencyExchange.
Syntaxpublic class CurrencyExchange
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
CurrencyExchangePk class
Syntaxpublic class CurrencyExchangePk
UsageThis is the embedded primary key, comprising the according document thisCurrencyExchange belongs to.
© 2000-2009 by paybox solutions AG
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 21
-
Revision:1.2Name:not supported by cvs2svn
CurrencyExchangePk() constructor
SyntaxCurrencyExchangePk ()
Usage
Creates a new instance of
BookingPk.
CurrencyExchangePk(String, String) constructor
SyntaxCurrencyExchangePk ( String currencyFrom , String currencyTo )
Parameters
• currencyFrom –• currencyTo –
Usage
Creates a new instance of
CurrencyExchangePk.
compareTo(CurrencyExchangePk) method
Syntaxint compareTo ( CurrencyExchangePk o )
equals(Object) method
Syntaxboolean equals ( Object arg0 )
com.sybase365.mobiliser.money package
22 Sybase Mobiliser Platform
-
getCurrencyFrom() method
SyntaxCurrency getCurrencyFrom ()
Returnsthe transaction's Currency
Usage
Returns the currency this transaction is executed with.
the transaction's Currency
getCurrencyTo() method
SyntaxCurrency getCurrencyTo ()
Returnsthe transaction's Currency
Usage
Returns the currency this transaction is executed with.
the transaction's Currency
hashCode() method
Syntaxint hashCode ()
setCurrencyFrom(Currency) method
Syntaxvoid setCurrencyFrom ( Currency dbCurrencyFrom )
Parameters
• currency – the currency value to set
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 23
-
Usage
Sets the
currency
of this instance.
setCurrencyTo(Currency) method
Syntaxvoid setCurrencyTo ( Currency dbCurrencyTo )
Parameters
• currency – the currency value to set
Usage
Sets the
currency
of this instance.
toString() method
SyntaxString toString ()
CurrencyExchange() constructor
SyntaxCurrencyExchange ()
Usage
Creates a new instance of
CurrencyExchange.
CurrencyExchange(CurrencyExchangePk) constructor
SyntaxCurrencyExchange ( CurrencyExchangePk id )
com.sybase365.mobiliser.money package
24 Sybase Mobiliser Platform
-
Parameters
• id –
Usage
Creates a new instance of
CurrencyExchange.
getPaymentInstrumentId() method
Syntaxlong getPaymentInstrumentId ()
Returnsthe paymentInstrumentId
Usage
the paymentInstrumentId
isSetPaymentInstrumentId() method
Syntaxboolean isSetPaymentInstrumentId ()
setPaymentInstrumentId(long) method
Syntaxvoid setPaymentInstrumentId ( long paymentInstrumentId )
Parameters
• paymentInstrumentId – the paymentInstrumentId to set
Doc classDoc.
Syntaxpublic class Doc
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the express
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 25
-
permission of SAP AG. The information contained herein may be changed without priornotice.
Doc() constructor
SyntaxDoc ()
Usage
Creates a new instance of
TcmDtinFile.
getStatus() method
Syntaxint getStatus ()
Returnsthe status of the instance
Usage
the status of the instance
getSubTxnId() method
SyntaxLong getSubTxnId ()
Returnsthe subTxnId
Usage
the subTxnId
setStatus(int) method
Syntaxvoid setStatus ( int status )
com.sybase365.mobiliser.money package
26 Sybase Mobiliser Platform
-
Parameters
• status – the status to set
setSubTxnId(Long) method
Syntaxvoid setSubTxnId ( Long subTxnId )
Parameters
• subTxnId – the subTxnId to set
Payment classPayment.
Syntaxpublic class Payment
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
Payment() constructor
SyntaxPayment ()
Usage
Creates a new instance of
TcmDtinFile.
getAmount() method
SyntaxBigDecimal getAmount ()
Returnsthe amount of the instance
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 27
-
Usage
the amount of the instance
getBankRef() method
SyntaxString getBankRef ()
Returnsthe bank ref. of the instance
Usage
the bank ref. of the instance
getBatchRunId() method
SyntaxLong getBatchRunId ()
Returnsthe batchRunId
Usage
the batchRunId
getClearingNumber() method
SyntaxLong getClearingNumber ()
Returnsthe clearing number of the instance
Usage
the clearing number of the instance
getClearingPiId() method
SyntaxLong getClearingPiId ()
com.sybase365.mobiliser.money package
28 Sybase Mobiliser Platform
-
Returnsthe clearingPiId
Usage
the clearingPiId
getCurrency() method
SyntaxCurrency getCurrency ()
Returnsthe currency of the instance
Usage
the currency of the instance
getDocId() method
SyntaxLong getDocId ()
Returnsthe docId
Usage
the docId
getFee() method
SyntaxBigDecimal getFee ()
Returnsthe fee amount of the instance
Usage
the fee amount of the instance
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 29
-
getFile() method
SyntaxFile getFile ()
Returnsthe file of the instance
Usage
the file of the instance
getFrom() method
SyntaxDate getFrom ()
Returnsthe from
Usage
the from
getPiId() method
SyntaxLong getPiId ()
Returnsthe piId
Usage
the piId
getPostingDate() method
SyntaxDate getPostingDate ()
Returnsthe posting date of the instance
com.sybase365.mobiliser.money package
30 Sybase Mobiliser Platform
-
Usage
the posting date of the instance
getReversalDate() method
SyntaxDate getReversalDate ()
Returnsthe reversal date of the instance
Usage
the reversal date of the instance
getSendDate() method
SyntaxDate getSendDate ()
Returnsthe send date of the instance
Usage
the send date of the instance
getSettlementMode() method
SyntaxString getSettlementMode ()
Returnsthe settlement mode of the instance
Usage
the settlement mode of the instance
getStatus() method
Syntaxint getStatus ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 31
-
Returnsthe status of the instance
Usage
the status of the instance
getSubTxnId() method
SyntaxLong getSubTxnId ()
getTo() method
SyntaxDate getTo ()
Returnsthe to
Usage
the to
getTxnAmount() method
SyntaxBigDecimal getTxnAmount ()
Returnsthe transaction amount of the instance
Usage
the transaction amount of the instance
getTxnCount() method
SyntaxLong getTxnCount ()
Returnsthe number of transactions for this instance
com.sybase365.mobiliser.money package
32 Sybase Mobiliser Platform
-
Usage
the number of transactions for this instance
getVat() method
SyntaxBigDecimal getVat ()
Returnsthe vat amount of the instance
Usage
the vat amount of the instance
isCredit() method
Syntaxboolean isCredit ()
Returnstrue if this instance is a credit payment; false otherwise
Usage
true if this instance is a credit payment; false otherwise
setAmount(BigDecimal) method
Syntaxvoid setAmount ( BigDecimal amount )
Parameters
• amount – the amount to set
setBankRef(String) method
Syntaxvoid setBankRef ( String bankRef )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 33
-
Parameters
• bankRef – the bank ref. to set
setBatchRunId(Long) method
Syntaxvoid setBatchRunId ( Long batchRunId )
Parameters
• batchRunId – the batchRunId to set
setClearingNumber(Long) method
Syntaxvoid setClearingNumber ( Long clearingNumber )
Parameters
• clearingNumber – the clearing number to set
setClearingPiId(Long) method
Syntaxvoid setClearingPiId ( Long clearingPiId )
Parameters
• clearingPiId – the clearingPiId to set
setCredit(boolean) method
Syntaxvoid setCredit ( boolean credit )
Parameters
• credit – the credit value to set
setCurrency(Currency) method
Syntaxvoid setCurrency ( Currency currency )
com.sybase365.mobiliser.money package
34 Sybase Mobiliser Platform
-
Parameters
• the – currency to set
setCurrency(String) method
Syntaxvoid setCurrency ( String currency )
Parameters
• the – currency to set
setDocId(Long) method
Syntaxvoid setDocId ( Long docId )
Parameters
• docId – the docId to set
setFee(BigDecimal) method
Syntaxvoid setFee ( BigDecimal fee )
Parameters
• fee – the fee amount to set
setFile(File) method
Syntaxvoid setFile ( File file )
Parameters
• file – the file to set
setFrom(Date) method
Syntaxvoid setFrom ( Date from )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 35
-
Parameters
• from – the from to set
setPiId(Long) method
Syntaxvoid setPiId ( Long piId )
Parameters
• piId – the piId to set
setPostingDate(Date) method
Syntaxvoid setPostingDate ( Date postingDate )
Parameters
• postingDate – the posting date to set
setReversalDate(Date) method
Syntaxvoid setReversalDate ( Date reversalDate )
Parameters
• reversalDate – the reversal date to set
setSendDate(Date) method
Syntaxvoid setSendDate ( Date sendDate )
Parameters
• sendDate – the send date to set
setSettlementMode(String) method
Syntaxvoid setSettlementMode ( String settlementMode )
com.sybase365.mobiliser.money package
36 Sybase Mobiliser Platform
-
Parameters
• settlementMode – the settlement mode to set
setStatus(int) method
Syntaxvoid setStatus ( int status )
Parameters
• status – the status to set
setSubTxnId(Long) method
Syntaxvoid setSubTxnId ( Long subTxnId )
setTo(Date) method
Syntaxvoid setTo ( Date to )
Parameters
• to – the to to set
setTxnAmount(BigDecimal) method
Syntaxvoid setTxnAmount ( BigDecimal txnAmount )
Parameters
• txnAmount – the transaction amount to set
setTxnCount(Long) method
Syntaxvoid setTxnCount ( Long txnCount )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 37
-
Parameters
• txnCount – the number of transactions to set
setVat(BigDecimal) method
Syntaxvoid setVat ( BigDecimal vat )
Parameters
• vat – the vat amount to set
PiBalance classPiBalance.
Syntaxpublic class PiBalance
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
PiBalance() constructor
SyntaxPiBalance ()
Usage
Creates a new instance of
PiBalance.
PiBalance(Long) constructor
SyntaxPiBalance ( Long id )
com.sybase365.mobiliser.money package
38 Sybase Mobiliser Platform
-
Parameters
• id –
Usage
Creates a new instance of
PiBalance.
add2Credit(BigDecimal) method
Syntaxvoid add2Credit ( BigDecimal amount )
add2Debit(BigDecimal) method
Syntaxvoid add2Debit ( BigDecimal amount )
getBalance() method
SyntaxBigDecimal getBalance ()
getClearingRun() method
SyntaxLong getClearingRun ()
Returnsthe clearingRun
Usage
the clearingRun
getCreditBalance() method
SyntaxBigDecimal getCreditBalance ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 39
-
Returnsthe creditBalance
Usage
the creditBalance
getDebitBalance() method
SyntaxBigDecimal getDebitBalance ()
Returnsthe debitBalance
Usage
the debitBalance
getLastCreditBalance() method
SyntaxBigDecimal getLastCreditBalance ()
Returnsthe lastCreditBalance
Usage
the lastCreditBalance
getLastDebitBalance() method
SyntaxBigDecimal getLastDebitBalance ()
Returnsthe lastDebitBalance
Usage
the lastDebitBalance
com.sybase365.mobiliser.money package
40 Sybase Mobiliser Platform
-
getLastDocId() method
SyntaxLong getLastDocId ()
Returnsthe lastDocId
Usage
the lastDocId
getNextClearingNumber() method
Syntaxlong getNextClearingNumber ()
setClearingRun(Long) method
Syntaxvoid setClearingRun ( Long clearingRun )
Parameters
• clearingRun – the clearingRun to set
setCreditBalance(BigDecimal) method
Syntaxvoid setCreditBalance ( BigDecimal creditBalance )
Parameters
• creditBalance – the creditBalance to set
setDebitBalance(BigDecimal) method
Syntaxvoid setDebitBalance ( BigDecimal debitBalance )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 41
-
Parameters
• debitBalance – the debitBalance to set
setLastCreditBalance(BigDecimal) method
Syntaxvoid setLastCreditBalance ( BigDecimal lastCreditBalance )
Parameters
• lastCreditBalance – the lastCreditBalance to set
setLastDebitBalance(BigDecimal) method
Syntaxvoid setLastDebitBalance ( BigDecimal lastDebitBalance )
Parameters
• lastDebitBalance – the lastDebitBalance to set
setLastDocId(Long) method
Syntaxvoid setLastDocId ( Long lastDocId )
Parameters
• lastDocId – the lastDocId to set
Reversal classReversal.
Syntaxpublic class Reversal
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
42 Sybase Mobiliser Platform
-
Reversal() constructor
SyntaxReversal ()
Usage
Creates a new instance of
TcmDtinFile.
getAmount() method
SyntaxBigDecimal getAmount ()
Returnsthe amount of the instance
Usage
the amount of the instance
getBankFee() method
SyntaxLong getBankFee ()
Returnsthe bank fee of the instance
Usage
the bank fee of the instance
getCurrency() method
SyntaxCurrency getCurrency ()
Returnsthe currency of the instance
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 43
-
Usage
the currency of the instance
getCustomer() method
SyntaxCustomer getCustomer ()
Returnsthe customer of the instance
Usage
the customer of the instance
getFile() method
SyntaxFile getFile ()
Returnsthe file of the instance
Usage
the file of the instance
getForeignReference() method
SyntaxString getForeignReference ()
Returnsthe foreign reference of the instance
Usage
the foreign reference of the instance
getOtherFee() method
SyntaxLong getOtherFee ()
com.sybase365.mobiliser.money package
44 Sybase Mobiliser Platform
-
Returnsthe other fees of the instance
Usage
the other fees of the instance
getPayment() method
SyntaxPayment getPayment ()
Returnsthe payment of the instance
Usage
the payment of the instance
getPi() method
SyntaxPaymentInstrument getPi ()
Returnsthe PI of the instance
Usage
the PI of the instance
getReason() method
SyntaxString getReason ()
Returnsthe reason of the instance
Usage
the reason of the instance
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 45
-
getReasonId() method
SyntaxInteger getReasonId ()
Returnsthe reason ID of the instance
Usage
the reason ID of the instance
getStatus() method
SyntaxInteger getStatus ()
Returnsthe status of the instance
Usage
the status of the instance
getTxn() method
SyntaxTransaction getTxn ()
Returnsthe transaction of the instance
Usage
the transaction of the instance
isCredit() method
Syntaxboolean isCredit ()
Returnstrue if this instance is a credit payment; false otherwise
com.sybase365.mobiliser.money package
46 Sybase Mobiliser Platform
-
Usage
true if this instance is a credit payment; false otherwise
setAmount(BigDecimal) method
Syntaxvoid setAmount ( BigDecimal amount )
Parameters
• amount – the amount to set
setBankFee(Long) method
Syntaxvoid setBankFee ( Long bankFee )
Parameters
• bankFee – the bank fee to set
setCredit(boolean) method
Syntaxvoid setCredit ( boolean credit )
Parameters
• credit – the credit value to set
setCurrency(Currency) method
Syntaxvoid setCurrency ( Currency currency )
Parameters
• the – currency to set
setCurrency(String) method
Syntaxvoid setCurrency ( String currency )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 47
-
Parameters
• the – currency to set
setCustomer(Customer) method
Syntaxvoid setCustomer ( Customer customer )
Parameters
• customer – the customer to set
setFile(File) method
Syntaxvoid setFile ( File file )
Parameters
• file – the file to set
setForeignReference(String) method
Syntaxvoid setForeignReference ( String foreignReference )
Parameters
• foreignReference – the foreign reference to set
setOtherFee(Long) method
Syntaxvoid setOtherFee ( Long otherFee )
Parameters
• otherFee – the other fees to set
setPayment(Payment) method
Syntaxvoid setPayment ( Payment payment )
com.sybase365.mobiliser.money package
48 Sybase Mobiliser Platform
-
Parameters
• payment – the payment to set
setPi(PaymentInstrument) method
Syntaxvoid setPi ( PaymentInstrument pi )
Parameters
• pi – the PI to set
setReason(String) method
Syntaxvoid setReason ( String reason )
Parameters
• reason – the reason to set
setReasonId(Integer) method
Syntaxvoid setReasonId ( Integer reasonId )
Parameters
• reasonId – the reason ID to set
setStatus(Integer) method
Syntaxvoid setStatus ( Integer status )
Parameters
• status – the status to set
setTxn(Transaction) method
Syntaxvoid setTxn ( Transaction txn )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 49
-
Parameters
• txn – the transaction to set
export package
MembersAll public members of the export package.
• api package –
api package
MembersAll public members of the api package.
• FileExporter< RowType, ExportType > class –• IFileExporter interface –
FileExporter< RowType, ExportType > class
Syntaxpublic class FileExporter< RowType, ExportType >
UsageThis abstract class forms a base class for file exporters. It implements the IFileExporterinterface and adds further abstract methods that need to be implemented. Those methodsenhance the IFileExporter interface by means to be used within the mobiliser AMScontext, which means it adds things like a file type, a batchrung type, etc. This class offers adefault implementation of the export() method utilizing AMS functionalities such asopening up a new batchrun for the current file. It further drives the usage of spring batch asmeans of querying the data to be exported, to process the data and to do the actual file export byserializing the processed export data into a XML file.
The most important methos to implement are doExport() and newFileStarted() toimplement the actual file export (how the records are read, processed and written) and how thefile exporter should react to a new file (e.g. writing an ams files entry or finishing the previousfile).
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
50 Sybase Mobiliser Platform
-
afterPropertiesSet() method
Syntaxvoid afterPropertiesSet () throws Exception
closeItemReader() method
Syntaxvoid closeItemReader () throws ItemStreamException
closeItemWriter() method
Syntaxvoid closeItemWriter () throws ItemStreamException
doExport(ExecutionContext, ClearingEvent) methodIs called from within export() and has to implement the actual export mechanism.
Syntaxabstract List< Long > doExport ( ExecutionContext ctx ,ClearingEvent event ) throws Exception
Parameters
• ctx –• event –
Exceptions
• Exception –
Usage
The reference implementation uses the item reader to read records from the database, uses theitem processor to do some basic checks and uses the item writer to export the processedrecords.
existPaymentsToExport() methodPerform checks to see wheather there are records to export.
Syntaxabstract boolean existPaymentsToExport () throws Exception
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 51
-
Exceptions
• Exception –
export(final ClearingEvent, long) methodDefault implementation of the file exporting mechanism.
Syntaxsynchronized boolean export ( final ClearingEvent event , longcallerId )
Usage
• Try to acquire a new batchrun lock• Save the batchrun in the local variable batchRunLock• Check if there is any data available to export• Initialize the spring batch context• Create a new file• Initialize the item writer with the newly created file• Open the item reader• Open the item writer• Signal a new file was created (creating a new ams files entry)• Do the actual export• Close item reader• Close item writer• Update exported records (e.g. set new status)• Validate the exported files
exportRecord(ExportType) method
Syntaxvoid exportRecord ( ExportType record ) throws Exception
getBatchRunLock() method
SyntaxIBatchRunLock getBatchRunLock ()
getBatchRunMaxAgeInSeconds() methodReturns the max age in seconds of the batchrun.
Syntaxabstract int getBatchRunMaxAgeInSeconds ()
com.sybase365.mobiliser.money package
52 Sybase Mobiliser Platform
-
getBatchRunType() methodReturns the batchrun type.
Syntaxabstract int getBatchRunType ()
getCallerId() method
SyntaxLong getCallerId ()
getCurrentBatchRun() method
SyntaxBatchRun getCurrentBatchRun ()
getCurrentFile() method
Syntaxcom.sybase365.mobiliser.money.persistence.model.system.FilegetCurrentFile ()
getFileCreationPath() method
SyntaxString getFileCreationPath ()
getFileDao() method
SyntaxFileDAO getFileDao ()
getFileType() methodReturns the ams file type.
Syntaxabstract int getFileType ()
getItemProcessor() method
SyntaxItemProcessor< RowType, ExportType > getItemProcessor ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 53
-
getItemReader() method
SyntaxAbstractItemCountingItemStreamItemReader< RowType >getItemReader ()
getItemWriter() method
SyntaxResourceAwareItemWriterItemStream< ExportType > getItemWriter()
getJdbcTemplate() method
Syntaxfinal JdbcOperations getJdbcTemplate ()
getNewFile(ClearingEvent) methodIs called whenever a new (physical) file has to be created (e.g.
Syntaxabstract File getNewFile ( ClearingEvent event )
Parameters
• event – The clearing finished event initially triggering the export
Usage
the first time it is called from within
export()). The file exporter reference implementation calls this method whenever it finds a switch ofthe debit/credit flag of the export data.
isItemReaderOpen() method
Syntaxboolean isItemReaderOpen ()
com.sybase365.mobiliser.money package
54 Sybase Mobiliser Platform
-
isItemWriterOpen() method
Syntaxboolean isItemWriterOpen ()
newFileStarted(File) method
Syntaxvoid newFileStarted ( File file )
openItemReader(ExecutionContext, boolean) method
Syntaxvoid openItemReader ( ExecutionContext ctx , boolean forceClose ) throwsIllegalArgumentException, ItemStreamException
openItemWriter(ExecutionContext, boolean) method
Syntaxvoid openItemWriter ( ExecutionContext ctx , boolean forceClose ) throwsIllegalArgumentException, ItemStreamException
renameFile(File) methodRename the temporary file.
Syntaxabstract File renameFile ( File file )
Parameters
• file –
setBatchRunLock(IBatchRunLock) method
Syntaxvoid setBatchRunLock ( IBatchRunLock batchRunLock )
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 55
-
setCurrentFile(com.sybase365.mobiliser.money.persistence.model.system.File)method
Syntaxvoid setCurrentFile( com.sybase365.mobiliser.money.persistence.model.system.FilecurrentFile )
setFileCreationPath(String) method
Syntaxvoid setFileCreationPath ( String fileCreationPath )
setFileDao(FileDAO) method
Syntaxvoid setFileDao ( FileDAO fileDao )
setItemProcessor(ItemProcessor< RowType, ExportType >) method
Syntaxvoid setItemProcessor ( ItemProcessor< RowType, ExportType >itemProcessor )
setItemReader(AbstractItemCountingItemStreamItemReader< RowType >) method
Syntaxvoid setItemReader ( AbstractItemCountingItemStreamItemReader<RowType > itemReader )
setItemWriter(ResourceAwareItemWriterItemStream< ExportType >) method
Syntaxvoid setItemWriter ( ResourceAwareItemWriterItemStream<ExportType > itemWriter )
setJdbcTemplate(JdbcOperations) method
Syntaxvoid setJdbcTemplate ( JdbcOperations jdbcTemplate )
com.sybase365.mobiliser.money package
56 Sybase Mobiliser Platform
-
startNewFile(RowType, RowType) methodHandle the creation of a new file.
Syntaxabstract boolean startNewFile ( RowType lastRecord , RowTypecurrentRecord )
Parameters
• lastRecord –• currentRecord –
Usage
The reference implementation creates a new ams files entry.
updateRecords(final List< Long >, final long) method
Syntaxvoid updateRecords ( final List< Long > updatedPaymentIds , finallong callerId ) throws DataAccessException
validateFile(File) methodValidate the written files.
Syntaxboolean validateFile ( File file )
Parameters
• file –
writeFilesEntry(BatchRun, String, Long) method
Syntaxlong writeFilesEntry ( BatchRun batchRun , String fileName , LongcallerId )
DF variable
Syntaxfinal DateFormat DF
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 57
-
exportedRecordsCount variable
Syntaxlong exportedRecordsCount
fileCreationPath variable
SyntaxString fileCreationPath
fileList variable
SyntaxList< File > fileList
PAYMENT_STATUS_PROCESSED variable
Syntaxfinal int PAYMENT_STATUS_PROCESSED
IFileExporter interface
Syntaxpublic interface IFileExporter
Derived classes
• FileExporter< RowType, ExportType > on page 50
UsageThis interface defines methods which each ams file exporter has to implement.
Usually an AMS file exporter will be triggered by an event handler listening to "clearingfinished events". This event hanlder will call the export() method, which must implementthe complete file handling process, e.g. where the data is read from, how the data is processedand how the export file is written.
For a reference implementation see ReferenceFileExporter and its abstract base classFileExporter.2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
58 Sybase Mobiliser Platform
-
export(final ClearingEvent, long) methodHas to do the actual export job.
Syntaxboolean export ( final ClearingEvent event , long callerId )
Parameters
• event –• callerId –
Returnstrue if no exceptions or unforseen behavior occured during processing false otherwise
Usage
true if no exceptions or unforseen behavior occured during processing false otherwise
businesslogic package
MembersAll public members of the businesslogic package.
• audit package –• authentication package –• billpayment package –• binary package –• bulkprocessing package –• customer package –• fee package –• invoice package –• normalizer package –• oauth2 package –• payment package –• system package –• transaction package –• umgr package –• umgrroles package –• util package –
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 59
-
• wallet package –
audit package
MembersAll public members of the audit package.
• IAuditLogLogic interface –• INoteLogic interface –
IAuditLogLogic interface
Syntaxpublic interface IAuditLogLogic
UsageThis interface defines CRUD operations on AuditLogs. In addition, a few find operations aredefined. All operations depend on an existing database transaction.
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
createAuditLog(final AuditLog, final long) methodCreates the passed AuditLog in the database.
Syntaxlong createAuditLog ( final AuditLog auditLog , final long callerId )throws EntityMandatoryException, IllegalDataException
Parameters
• auditLog – the audit log entry to create.• callerId – the caller id that is persisted as creator of this audit log.
Returnsthe id of the newly created audit log.
Exceptions
• EntityMandatoryException – if the passed auditLog is null.• IllegalDataException – if the passed auditLog has an id provided.
com.sybase365.mobiliser.money package
60 Sybase Mobiliser Platform
-
Usage
The id must be
null, since it will be generated during creation.
the id of the newly created audit log.
deleteAuditLog(final long, final long) methodDeletes the passed AuditLog from the database.
Syntaxvoid deleteAuditLog ( final long auditLogId , final long callerId ) throwsEntityNotFoundException
Parameters
• auditLogId – the id of the audit log• callerId – the current caller id
Exceptions
• EntityNotFoundException – if the audit log is not found with the passed id
getAuditLog(final long, final long) methodGets the AuditLog with the passed id from the database.
SyntaxAuditLog getAuditLog ( final long auditLogId , final long callerId )throws EntityNotFoundException
Parameters
• auditLogId – the id of the audit log• callerId – the current caller id
Returnsthe audit log
Exceptions
• EntityNotFoundException – if the audit log is not found with the passed id
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 61
-
Usage
the audit log
getAuditLogs(Date, Date, Long, Long, Long, Boolean, List< String >, Integer) methodLoads a list of AuditLogs based on the given search criteria.
SyntaxList< AuditLog > getAuditLogs ( Date start , Date end , Long callerId ,Long customerId , Long transactionId , Boolean faultyOnly , List< String >category , Integer rows )
Parameters
• start – filters by creation date after this date• end – filters by creation date before this date• callerId – filters by caller id• customerId – filters by customer id• transactionId – filters by transaction id• faultyOnly – is set to true only audit logs with AuditLog#getActionResultCode() not
equal to zero will be returned• category – filters by category• rows – limits the maximum size of the returned list
Usage
All criteria are optional, however this method will always return 1000 records max.
getAuditLogsByCustomer(final long, final long) methodLoad AuditLogs created for a specific customer.
SyntaxList< AuditLog > getAuditLogsByCustomer ( final long customerId ,final long callerId ) throws EntityNotFoundException
Parameters
• customerId – the customer id to filter for• callerId – the current caller id
Returnsa list of matching audit logs
com.sybase365.mobiliser.money package
62 Sybase Mobiliser Platform
-
Exceptions
• EntityNotFoundException – if no customer exists for the given customer id
Usage
a list of matching audit logs
getAuditLogsByTransaction(final long, final long) methodLoad AuditLogs created for a specific transaction.
SyntaxList< AuditLog > getAuditLogsByTransaction ( final long txnId ,final long callerId ) throws EntityNotFoundException
Parameters
• txnId – the transaction id to filter for• callerId – the current caller id
Returnsa list of matching audit logs
Exceptions
• EntityNotFoundException – if no transaction exists for the given transaction id
Usage
a list of matching audit logs
updateAuditLog(final AuditLog, final long) methodUpdates the passed AuditLog in the database.
Syntaxvoid updateAuditLog ( final AuditLog auditLog , final long callerId )throws EntityMandatoryException
Parameters
• auditLog – the audit log to update• callerId – the caller id that is persisted as updater of this audit log.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 63
-
Exceptions
• EntityMandatoryException – if the passed auditLog or its id are null
Usage
The audit log id must be provided.
INoteLogic interface
Syntaxpublic interface INoteLogic
UsageThis interface defines CRUD operations on Notes. In addition, a few find operations areprovided. All operations depend on an existing database transaction.
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
createNote(final Note, final long) methodCreates the passed Note in the database.
Syntaxlong createNote ( final Note note , final long callerId ) throwsEntityMandatoryException, IllegalDataException
Parameters
• note – the note to create.• callerId – the caller id that is persisted as creator of this note.
Returnsthe id of the newly created note.
Exceptions
• EntityMandatoryException – if the passed note is null.• IllegalDataException – if the passed note has an id provided.
Usage
The id must be
com.sybase365.mobiliser.money package
64 Sybase Mobiliser Platform
-
null, since it will be generated during creation.
the id of the newly created note.
deleteNote(final long, final long) methodDeletes the passed Note from the database.
Syntaxvoid deleteNote ( final long noteId , final long callerId ) throwsEntityNotFoundException
Parameters
• noteId – the id of the note• callerId – the current caller id
Exceptions
• EntityNotFoundException – if the note is not found with the passed id
getCountedNotes(final Long, final Integer, final Integer, final Date, final Date, finalString, final String, final Integer, final int, final long) methodSearches for Notes based on the given search criteria.
SyntaxList< Note > getCountedNotes ( final Long customerId , finalInteger noteType , final Integer status , final Date fromDate , finalDate toDate , final String subject , final String creator , finalInteger creatorIdentificationType , final int maxRecords , final longcallerId ) throws EntityNotFoundException
Parameters
• customerId – filter by customer id• noteType – filter by note type• status – filter by status• fromDate – filter by creation date after this date• toDate – filter by creation date before this date• subject – filter by subject• creator – filter by creator; in this case you must also define the identification type,
otherwise the method does not filter by creator• creatorIdentificationType – identification type of the passed creator identification
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 65
-
• maxRecords – limits the maximum size of the result list• callerId – filter by caller id
Returnsthe list of matching Notes
Exceptions
• EntityNotFoundException – if filtering by a creator that does not exist
Usage
the list of matching Notes
getNote(final long, final long) methodGets the Note with the passed id from the database.
SyntaxNote getNote ( final long noteId , final long callerId ) throwsEntityNotFoundException
Parameters
• noteId – the id of the note• callerId – the current caller id
Returnsthe note
Exceptions
• EntityNotFoundException – if the note is not found with the passed id
Usage
the note
getNotesByCustomer(final long, final Integer, final Integer, final Date, final Date, finalString, final String, final Integer, final long) methodSearches for Notes based on the given search criteria.
SyntaxList< Note > getNotesByCustomer ( final long customerId , finalInteger noteType , final Integer status , final Date fromDate , finalDate toDate , final String subject , final String creator , final
com.sybase365.mobiliser.money package
66 Sybase Mobiliser Platform
-
Integer creatorIdentificationType , final long callerId ) throwsEntityNotFoundException
Parameters
• customerId – filter by customer id• noteType – filter by note type• status – filter by status• fromDate – filter by creation date after this date• toDate – filter by creation date before this date• subject – filter by subject• creator – filter by creator; in this case you must also define the identification type,
otherwise the method does not filter by creator• creatorIdentificationType – identification type of the passed creator identification• callerId – filter by caller id
Returnsthe list of matching Notes
Exceptions
• EntityNotFoundException – if filtering by a creator that does not exist
Usage
the list of matching Notes
updateNote(final Note, final long) methodUpdates the passed Note in the database.
Syntaxvoid updateNote ( final Note note , final long callerId ) throwsEntityMandatoryException
Parameters
• note – the note to update• callerId – the caller id that is persisted as updater of this note.
Exceptions
• EntityMandatoryException – if the passed note or it's id are null
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 67
-
Usage
The note id must be provided.
authentication package
MembersAll public members of the authentication package.
• api package –
api package
MembersAll public members of the api package.
• IAuthenticationBroker interface – An IAuthenticationBroker provides a way to retrievethe IAuthenticationHandler needed for a configured authentication method.
• IAuthenticationHandler interface –• IAuthenticationMethodService interface – Implementations of this can compute the
authentication methods required for a given SubTransaction.• IConsumerAuthenticator interface – Abstraction of a consumer authentication for a
transaction.• IResetableAuthHandler interface – The Resetable Authentication Handler Interface is
implemented by Authentication methods that can reset/restart the authentication process.
IAuthenticationBroker interfaceAn IAuthenticationBroker provides a way to retrieve the IAuthenticationHandler needed for aconfigured authentication method.
Syntaxpublic interface IAuthenticationBroker
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
getAuthenticationHandler(final Integer) methodReturns the the authentication handler for the given method.
SyntaxIAuthenticationHandler getAuthenticationHandler ( final IntegerauthenticationMethod )
com.sybase365.mobiliser.money package
68 Sybase Mobiliser Platform
-
Parameters
• authenticationMethod – the authentication method
Returnsthe handler or null if no handler is configured for the given method
Usage
If no match is found, null is returned.
the handler or null if no handler is configured for the given method
getResetableAutHandler(final Integer) methodLike.
SyntaxIResetableAuthHandler getResetableAutHandler ( final IntegerauthenticaionMethod )
Parameters
• authenticaionMethod – the authentication method
Returnsthe handler or null if no IResetableAuthHandler is found
Usage
the handler or null if no IResetableAuthHandler is found
IAuthenticationHandler interface
Syntaxpublic interface IAuthenticationHandler
Derived classes
• IResetableAuthHandler on page 75
UsageThe IAuthenticationHandler implementation is responsible for authenticating atransaction, i.e. get the user's approval for the transaction.If the authentication returnsnormally, it is assumed that the transaction was authenticated. Otherwise, an exception shouldbe thrown.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 69
-
Multiple instances with different coverages can be active parallel and additionalimplementation of this interface can be added to the OSGi container. As soon as a new instanceis registered the IAuthenticationBroker service is notified and the service can be used. In orderto add a new AuthenticationHandler, a new entry in MOB_AUTHENTICATION_METHODtable is needed for the new coverage
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
authenticate(final SubTransaction, final String, final boolean) method
Syntaxvoid authenticate ( final SubTransaction transaction , final StringauthToken , final boolean payer ) throws AuthenticationException
Parameters
• transaction – the SubTransaction to authenticate (in general, this should be thereservation)
• authToken – the Authentication value• authTokenType – the Authentication Type id to apply• payer – indicates if payer or payee must authenticate for the transaction
Exceptions
• AuthenticationException – if authentication fails• AuthenticationFailedException – if the authentication failed but can be retried• AuthenticationFailedPermanentlyException – if the authentication failed and can not
be retried
Usage
Authenticates the specified transaction.
getCoverage() method
SyntaxInteger[] getCoverage ()
Returnsan array of AuthenticationMethods IDs
com.sybase365.mobiliser.money package
70 Sybase Mobiliser Platform
-
Usage
Returns the types of authentication methods this handler is responsible for.
an array of AuthenticationMethods IDs
getName() method
SyntaxString getName ()
Usage
Returns the authentication handler name
initAuthentication(final SubTransaction, final boolean) method
Syntaxboolean initAuthentication ( final SubTransaction transaction ,final boolean payer ) throws AuthenticationException
Parameters
• transaction – the SubTransaction to authenticate (in general, this should be thereservation)
• method – the AuthenticationMethod id to apply• payer – indicates if payer or payee must authenticate for the transaction
Returnstrue if the initialisation did not create a new authentication token and the authentication canbe continued right after the initialization. On false the transaction processing should breakimmediately
Exceptions
• AuthenticationException – if the initialization fails and the transaction processing can tobe picked up later
Usage
Initializes the Authentication for payer or payee. This method can be used by the actualauthentication handler to send notifications to the participants, such as one time transactiontokens created on time.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 71
-
true if the initialisation did not create a new authentication token and the authentication canbe continued right after the initialization. On false the transaction processing should breakimmediately
isDynamicCredentials() method
Syntaxboolean isDynamicCredentials ()
Usage
Returns true if the authentication handler initializes a new credential in the init call. If it doesnot an authorise call can contain the credentials already
isInlineAuthentication() method
Syntaxboolean isInlineAuthentication ()
Usage
Returns true if it is an inline authentication and the transaction is continued/authenticatedwithout the service caller automatically
Example: An SMS AoC authentication handler calls the brand mobiliser and the brandmobilier does the continueAuthentication service call.
IAuthenticationMethodService interfaceImplementations of this can compute the authentication methods required for a givenSubTransaction.
Syntaxpublic interface IAuthenticationMethodService
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
72 Sybase Mobiliser Platform
-
computeRules(final SubTransaction, final Long) method
SyntaxAuthenticationMethodComputation computeRules ( finalSubTransaction txn , final Long actor ) throwsMobiliserServiceException
Parameters
• txn – the subtransaction• actor – the actor
Returnsthe computed authentication methods
Exceptions
• MobiliserServiceException – if computing the rules fails for any business rules relatedreason
Usage
Computes the authentication rules for the given transaction.
the computed authentication methods
IConsumerAuthenticator interfaceAbstraction of a consumer authentication for a transaction.
Syntaxpublic interface IConsumerAuthenticator
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
consumerAuthentication(final SubTransaction, final Integer, final String, finalboolean, final Integer, final String, final boolean) method
SyntaxConsumerAuthenticationResult consumerAuthentication ( finalSubTransaction txn , final Integer payeeAuthenticationMethod , final
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 73
-
String payeeAuthToken , final boolean resetPayeeAuth , final IntegerpayerAuthenticationMethod , final String payerAuthToken , final booleanresetPayerAuth ) throws MobiliserServiceException
Parameters
• txn – the transaction to authenticate• payeeAuthenticationMethod – the auth method for the payee• payeeAuthToken – the auth token for the payee• payerAuthenticationMethod – the auth method for the payer• payerAuthToken – the auth token for the payer
ReturnsConsumerAuthenticationResultthe result of the authentication:• FAILED_BOTH: authentication failed and may be repeated• FAILED_PAYER: authentication failed for payee and may be repeated• FAILED_PAYEE: authentication failed for payer and may be repeated
Exceptions
• MobiliserServiceException – if computing the authenticating fails
Usage
Performs the appropriate transaction authentication with the affected consumer.
ConsumerAuthenticationResultthe result of the authentication:• FAILED_BOTH: authentication failed and may be repeated• FAILED_PAYER: authentication failed for payee and may be repeated• FAILED_PAYEE: authentication failed for payer and may be repeated
initConsumerAuthentication(final SubTransaction, final Integer, final Integer) method
SyntaxConsumerAuthenticationResult initConsumerAuthentication ( finalSubTransaction txn , final Integer payeeAuthenticationMethod , finalInteger payerAuthenticationMethod ) throws MobiliserServiceException
Parameters
• txn – the transaction to authenticate• payeeAuthenticationMethod – the auth method for the payee
com.sybase365.mobiliser.money package
74 Sybase Mobiliser Platform
-
• payerAuthenticationMethod – the auth method for the payer
ReturnsConsumerAuthenticationResultthe result of the authentication:• FAILED_BOTH: authentication is asynchronous for both participants• FAILED_PAYER: authentication is asynchronous for payee• FAILED_PAYEE: authentication is asynchronous for payer
Exceptions
• MobiliserServiceException – if computing the initialisation fails final
Usage
Performs the appropriate transaction authentication initialization with the affectedconsumers. If the call does not return success, one of the participants authentication isasynchronous and the transaction processing should wait/stop until the transaction processingcan be picked up with the new participants auth token in the request
ConsumerAuthenticationResultthe result of the authentication:• FAILED_BOTH: authentication is asynchronous for both participants• FAILED_PAYER: authentication is asynchronous for payee• FAILED_PAYEE: authentication is asynchronous for payer
IResetableAuthHandler interfaceThe Resetable Authentication Handler Interface is implemented by Authentication methodsthat can reset/restart the authentication process.
Syntaxpublic interface IResetableAuthHandler
UsageThis can be used to implement the business logic such as resent an authentication token thatwas generated during the authentication initialization. Reset does not mean that theauthentication is in the initial state afterwards. Wrong credentials counts may not be reset to0.
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 75
-
resetAuthentication(final SubTransaction, final boolean) methodReset the transaction authentication.
Syntaxvoid resetAuthentication ( final SubTransaction transaction , finalboolean payer ) throws AuthenticationException
Parameters
• transaction –• payer –
Exceptions
• AuthenticationException – like when the transaction can not be reset multiple times orcurrent condition does not allow to reset it
billpayment package
MembersAll public members of the billpayment package.
• api package –
api package
MembersAll public members of the api package.
• BillPaymentHandler interface – The BillPaymentHandler interface isimplemented by actual bill payment handler.
• IBillPaymentBroker interface – IBillPaymentBroker OSGi service interface ofthe bill payment broker.
• InvoiceStatusCode class – Additional status codes / return values used by the invoicebundles.
BillPaymentHandler interfaceThe BillPaymentHandler interface is implemented by actual bill payment handler.
Syntaxpublic interface BillPaymentHandler
com.sybase365.mobiliser.money package
76 Sybase Mobiliser Platform
-
UsageOn service startup the actual bill payment handler triggers an registration event and the billpayment broker gets the coverage of it
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
checkInvoice(Invoice) methodThis method gets called before the funds get authorized from the bill payer.
Syntaxvoid checkInvoice ( Invoice invoice ) throwsUnsupportedOperationException, BillPaymentHandlerException
Parameters
• invoice – to check
Exceptions
• UnsupportedOperationException – must be thrown if checking is not possible, the billpayment process will continue as if the check were successful
• BillPaymentHandlerException – indicates that the bill cannot be paid, bill paymentprocess must fail
Usage
It is important that all possible checks that could prevent the bill from being paid are executedat this stage. If the bill cannot be paid, a
BillPaymentHandlerException
must be thrown. However, the checkInvoice is not binding in any way. If the authorization isnot possible at a later point no further information is sent to the bill payment handler.
getInvoiceTypeHandlerTypeCoverage() methodReturns the list of invoice types for which this implementation is responsible for.
Syntaxint[] getInvoiceTypeHandlerTypeCoverage ()
Returnsthe list of incoice types for which this implementation is responsible for.
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 77
-
Usage
the list of incoice types for which this implementation is responsible for.
getName() method
SyntaxString getName ()
Returnsthe name.
Usage
Returns the name of the PaymentHandler. Can be the class name or a short description. This isshown by the broker in the log file
the name.
invoiceStatusChangeAdvice(Invoice, InvoiceStatus) methodThis service is called when the Invoice status has changed (e.g.
Syntaxvoid invoiceStatusChangeAdvice ( Invoice invoice , InvoiceStatusinvoiceStatus )
Parameters
• invoice – where the status has changed• newInvoiceStatus –
Usage
canceled by user, expired, failed, ...).
payInvoice(Invoice, long) methodThis method gets called when the invoice is being paid.
SyntaxString payInvoice ( Invoice invoice , long txnId ) throwsBillPaymentHandlerException
com.sybase365.mobiliser.money package
78 Sybase Mobiliser Platform
-
Parameters
• invoice – the invoice to pay
ReturnsA reference for the bill payment process, can be null if no external reference is generated
Exceptions
• BillPaymentHandlerException – if the bill cannot be closed, this will result in thetransaction being rolled back.
Usage
The money from the payer is already secured.
A reference for the bill payment process, can be null if no external reference is generated
resendInvoiceStatusChange(Invoice, int) methodThis method is called when the invoices is pending status on the OnlineCommnandQueue.
Syntaxboolean resendInvoiceStatusChange ( Invoice invoice , int counter )
Parameters
• invoice – where the status needs to be resend• counter – retry counter
Returnstrue if success or false.
Usage
true if success or false.
updateAndCreateInvoices(InvoiceType) methodThis method is called based on the configure interval.
Syntaxvoid updateAndCreateInvoices ( InvoiceType invoiceType )
Parameters
• invoiceType – where to update/create an invoice
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 79
-
Usage
It is not connected to the actual bill payment process but rather gives the implementation theoption to update existing invoices or create new ones.
updateAndCreateInvoicesForInvoiceConfiguration(InvoiceConfiguration) methodThis method is used to query for new or updated invoices based on an existingInvoiceConfiguration.
Syntaxvoid updateAndCreateInvoicesForInvoiceConfiguration( InvoiceConfiguration invoiceConfiguration )
Parameters
• invoiceType – where to update/create the invoice configuration
Usage
The process is usually invoked by the customer.
IBillPaymentBroker interfaceIBillPaymentBroker OSGi service interface of the bill payment broker.
Syntaxpublic interface IBillPaymentBroker
UsageThe broker is responsible to get the payment handler for a given type
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
getBillPaymentHandler(Integer) methodFind the matching BillPaymentHandler.
SyntaxBillPaymentHandler getBillPaymentHandler ( Integer type )
Parameters
• type –
com.sybase365.mobiliser.money package
80 Sybase Mobiliser Platform
-
Returnsthe matching bill payment handler or null if no matching
Usage
the matching bill payment handler or null if no matching
InvoiceStatusCode classAdditional status codes / return values used by the invoice bundles.
Syntaxpublic class InvoiceStatusCode
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
ERROR_ACTIVE_INVOICES variable
Syntaxfinal int ERROR_ACTIVE_INVOICES
ERROR_CUSTOMER_REFERENCE_UNKNOWN variable
Syntaxfinal int ERROR_CUSTOMER_REFERENCE_UNKNOWN
ERROR_INVOICE_ALREADY_PAID variable
Syntaxfinal int ERROR_INVOICE_ALREADY_PAID
ERROR_INVOICE_AMOUNT_INCORRECT variable
Syntaxfinal int ERROR_INVOICE_AMOUNT_INCORRECT
ERROR_INVOICE_AMOUNT_TOO_HIGH variable
Syntaxfinal int ERROR_INVOICE_AMOUNT_TOO_HIGH
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 81
-
ERROR_INVOICE_AMOUNT_TOO_LOW variable
Syntaxfinal int ERROR_INVOICE_AMOUNT_TOO_LOW
ERROR_INVOICE_CANCELED variable
Syntaxfinal int ERROR_INVOICE_CANCELED
ERROR_INVOICE_EXPIRED variable
Syntaxfinal int ERROR_INVOICE_EXPIRED
ERROR_INVOICE_REFERENCE_UNKNOWN variable
Syntaxfinal int ERROR_INVOICE_REFERENCE_UNKNOWN
ERROR_INVOICE_STATUS_INCORRECT variable
Syntaxfinal int ERROR_INVOICE_STATUS_INCORRECT
ERROR_INVOICE_TYPE_REFERENCE_UNKNOWN variable
Syntaxfinal int ERROR_INVOICE_TYPE_REFERENCE_UNKNOWN
ERROR_ISSUER_TECH_ERROR variable
Syntaxfinal int ERROR_ISSUER_TECH_ERROR
ERROR_UNKNOWN_ERROR variable
Syntaxfinal int ERROR_UNKNOWN_ERROR
com.sybase365.mobiliser.money package
82 Sybase Mobiliser Platform
-
binary package
MembersAll public members of the binary package.
• BinaryData class – Data container for binary data and some meta information.• BinaryDataDestination interface – A mobiliser abstraction for adding binary data.• BinaryDataDownloadException class – Exception used when data is being uploaded.• BinaryDataSource interface – A mobiliser abstraction for accessing binary data.• BinaryDataUploadException class – Exception used when data is being uploaded.• BinaryDataUrlHandler interface – The interface for creating upload and download
urls.
BinaryData classData container for binary data and some meta information.
Syntaxpublic class BinaryData
Usage2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
getContentType() method
SyntaxString getContentType ()
Returnsthe contentType
Usage
the contentType
getData() method
Syntaxbyte[] getData ()
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 83
-
Returnsthe data
Usage
the data
getName() method
SyntaxString getName ()
Returnsthe name
Usage
the name
isAddContentDisposition() method
Syntaxboolean isAddContentDisposition ()
Returnsthe addContentDisposition
Usage
the addContentDisposition
setAddContentDisposition(final boolean) method
Syntaxvoid setAddContentDisposition ( final boolean addContentDisposition )
Parameters
• addContentDisposition – the addContentDisposition to set
setContentType(final String) method
Syntaxvoid setContentType ( final String contentType )
com.sybase365.mobiliser.money package
84 Sybase Mobiliser Platform
-
Parameters
• contentType – the contentType to set
setData(final byte[]) method
Syntaxvoid setData ( final byte[] data )
Parameters
• data – the data to set
setName(final String) method
Syntaxvoid setName ( final String name )
Parameters
• name – the name to set
addContentDisposition variable
Syntaxboolean addContentDisposition
contentType variable
SyntaxString contentType
data variable
Syntaxbyte[] data
name variable
SyntaxString name
com.sybase365.mobiliser.money package
Money Mobiliser API Reference 85
-
BinaryDataDestination interfaceA mobiliser abstraction for adding binary data.
Syntaxpublic interface BinaryDataDestination
UsageImplementations of this interface will provide access to generic binary data stores.
2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publicationmay be reproduced or transmitted in any form or for any purpose without the expresspermission of SAP AG. The information contained herein may be changed without priornotice.
getType() methodThe type name for this binary data source.
SyntaxString getType ()
Returnsthe name
Usage
This should be unique for each data source.
the name
storeData(final Map< String, String >, final BinaryData, final CallerInformation)methodUpload the binary data as requested by the caller.
SyntaxLong storeData ( final Map< String, String > parameters , finalBinaryData data , final CallerInformation caller ) throwsBinaryDataUploadException
Parameters
• parameters – the parameters for the binary data.• caller – the id of the caller accessing the binary data• data – the binary data to update
com.sybase365.mobiliser.money package
86 Sybase Mobiliser Platform
-
Returnsthe id of the newly created data
Exceptions
• BinaryDataUploadException class – the if data cannot be uploaded for any reason
Usage
the id of the newly created data
BinaryDataDownloadException classException used when data is being uploaded.
Syntaxpublic class BinaryDataDownloadException
UsageThe Reason will give the exact cause of failure.
2013 SAP AG or an SAP affilia