org.openfact.models

Interface DocumentModel

public interface DocumentModel

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentModel.DocumentCreationEvent Events interfaces
static interface	DocumentModel.DocumentPostCreateEvent
static interface	DocumentModel.DocumentRemovedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATED_TIMESTAMP
static String	CUSTOMER_ASSIGNED_ACCOUNT_ID
static String	CUSTOMER_ELECTRONIC_MAIL
static String	CUSTOMER_REGISTRATION_NAME
static String	DOCUMENT_CURRENCY_CODE
static String	DOCUMENT_ID
static String	DOCUMENT_TYPE
static String	ENABLED
static String	REQUIRED_ACTIONS Required Actions
static String	SEND_EVENT_DESTINY Send events
static String	SEND_EVENT_STATUS

Method Summary

Modifier and Type	Method and Description
void	addAttachedDocument(DocumentModel document)
DocumentLineModel	addDocumentLine()
void	addRequiredAction(DocumentRequiredAction action)
void	addRequiredAction(String action)
SendEventModel	addSendEvent(DestinyType destinyType)
void	attachXmlFile(FileModel file)
void	disable()
List<DocumentModel>	getAttachedDocumentsAsDestiny()
List<DocumentModel>	getAttachedDocumentsAsOrigin() Attatched documents
List<String>	getAttribute(String name)
Map<String,List<String>>	getAttributes()
java.time.LocalDateTime	getCreatedTimestamp()
String	getCustomerAssignedAccountId()
String	getCustomerElectronicMail()
String	getCustomerRegistrationName()
int	getCustomerSendEventFailures()
String	getDocumentCurrencyCode() Document information
String	getDocumentId()
List<DocumentLineModel>	getDocumentLines() Document Line
String	getDocumentType()
String	getFirstAttribute(String name)
String	getId()
OrganizationModel	getOrganization() Organization
Set<String>	getRequiredActions()
SendEventModel	getSendEventById(String id)
List<SendEventModel>	getSendEvents()
List<SendEventModel>	getSendEvents(Integer firstResult, Integer maxResults)
int	getThirdPartySendEventFailures()
Document	getXmlAsDocument()
FileModel	getXmlAsFile() Xml
org.json.JSONObject	getXmlAsJSONObject()
void	incrementCustomerSendEventFailures()
void	incrementThirdPartySendEventFailures()
boolean	isEnabled()
boolean	removeAttachedDocument(DocumentModel document)
void	removeAttribute(String name)
boolean	removeDocumentLine(DocumentLineModel documentLine)
void	removeRequiredAction(DocumentRequiredAction action)
void	removeRequiredAction(String action)
boolean	removeSendEvent(SendEventModel sendEvent)
List<SendEventModel>	searchForSendEvent(Map<String,String> params)
List<SendEventModel>	searchForSendEvent(Map<String,String> params, int firstResult, int maxResults)
void	setAttribute(String name, List<String> values)
void	setCustomerAssignedAccountId(String customerAssignedAccountId)
void	setCustomerElectronicMail(String customerElectronicMail)
void	setCustomerRegistrationName(String customerRegistrationName)
void	setDocumentCurrencyCode(String currencyCode)
void	setSingleAttribute(String name, String value) attributes

Field Detail

DOCUMENT_TYPE

static final String DOCUMENT_TYPE

See Also:

Constant Field Values

DOCUMENT_ID

static final String DOCUMENT_ID

See Also:

Constant Field Values

DOCUMENT_CURRENCY_CODE

static final String DOCUMENT_CURRENCY_CODE

See Also:

Constant Field Values

CUSTOMER_REGISTRATION_NAME

static final String CUSTOMER_REGISTRATION_NAME

See Also:

Constant Field Values

CUSTOMER_ASSIGNED_ACCOUNT_ID

static final String CUSTOMER_ASSIGNED_ACCOUNT_ID

See Also:

Constant Field Values

CUSTOMER_ELECTRONIC_MAIL

static final String CUSTOMER_ELECTRONIC_MAIL

See Also:

Constant Field Values

CREATED_TIMESTAMP

static final String CREATED_TIMESTAMP

See Also:

Constant Field Values

ENABLED

static final String ENABLED

See Also:

Constant Field Values

REQUIRED_ACTIONS

static final String REQUIRED_ACTIONS

Required Actions

See Also:

Constant Field Values

SEND_EVENT_DESTINY

static final String SEND_EVENT_DESTINY

Send events

See Also:

Constant Field Values

SEND_EVENT_STATUS

static final String SEND_EVENT_STATUS

See Also:

Constant Field Values

Method Detail

getId

String getId()

getDocumentId

String getDocumentId()

getDocumentType

String getDocumentType()

getCreatedTimestamp

java.time.LocalDateTime getCreatedTimestamp()

isEnabled

boolean isEnabled()

disable

void disable()

getDocumentLines

List<DocumentLineModel> getDocumentLines()

Document Line

addDocumentLine

DocumentLineModel addDocumentLine()

removeDocumentLine

boolean removeDocumentLine(DocumentLineModel documentLine)

getOrganization

OrganizationModel getOrganization()

Organization

getDocumentCurrencyCode

String getDocumentCurrencyCode()

Document information

setDocumentCurrencyCode

void setDocumentCurrencyCode(String currencyCode)

getCustomerRegistrationName

String getCustomerRegistrationName()

setCustomerRegistrationName

void setCustomerRegistrationName(String customerRegistrationName)

getCustomerAssignedAccountId

String getCustomerAssignedAccountId()

setCustomerAssignedAccountId

void setCustomerAssignedAccountId(String customerAssignedAccountId)

getCustomerElectronicMail

String getCustomerElectronicMail()

setCustomerElectronicMail

void setCustomerElectronicMail(String customerElectronicMail)

getXmlAsFile

FileModel getXmlAsFile()

Xml

attachXmlFile

void attachXmlFile(FileModel file)

getXmlAsDocument

Document getXmlAsDocument()

getXmlAsJSONObject

org.json.JSONObject getXmlAsJSONObject()

setSingleAttribute

void setSingleAttribute(String name,
                        String value)

attributes

setAttribute

void setAttribute(String name,
                  List<String> values)

removeAttribute

void removeAttribute(String name)

getFirstAttribute

String getFirstAttribute(String name)

getAttribute

List<String> getAttribute(String name)

getAttributes

Map<String,List<String>> getAttributes()

getRequiredActions

Set<String> getRequiredActions()

addRequiredAction

void addRequiredAction(String action)

removeRequiredAction

void removeRequiredAction(String action)

addRequiredAction

void addRequiredAction(DocumentRequiredAction action)

removeRequiredAction

void removeRequiredAction(DocumentRequiredAction action)

getCustomerSendEventFailures

int getCustomerSendEventFailures()

incrementCustomerSendEventFailures

void incrementCustomerSendEventFailures()

getThirdPartySendEventFailures

int getThirdPartySendEventFailures()

incrementThirdPartySendEventFailures

void incrementThirdPartySendEventFailures()

addSendEvent

SendEventModel addSendEvent(DestinyType destinyType)

getSendEventById

SendEventModel getSendEventById(String id)

removeSendEvent

boolean removeSendEvent(SendEventModel sendEvent)

getSendEvents

List<SendEventModel> getSendEvents()

getSendEvents

List<SendEventModel> getSendEvents(Integer firstResult,
                                   Integer maxResults)

searchForSendEvent

List<SendEventModel> searchForSendEvent(Map<String,String> params)

searchForSendEvent

List<SendEventModel> searchForSendEvent(Map<String,String> params,
                                        int firstResult,
                                        int maxResults)

getAttachedDocumentsAsOrigin

List<DocumentModel> getAttachedDocumentsAsOrigin()

Attatched documents

getAttachedDocumentsAsDestiny

List<DocumentModel> getAttachedDocumentsAsDestiny()

addAttachedDocument

void addAttachedDocument(DocumentModel document)

removeAttachedDocument

boolean removeAttachedDocument(DocumentModel document)