Package com.logicaldoc.scheme

Class DocumentScheme

java.lang.Object

com.logicaldoc.scheme.DocumentScheme

All Implemented Interfaces:

com.logicaldoc.core.document.DocumentListener

public class DocumentScheme
extends Object
implements com.logicaldoc.core.document.DocumentListener

This listener handles schemes for the document being modified.

Since:

4.0

Author:

Matteo Caruso - LogicalDOC

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTOFOLDING_SCHEME
static final String	AUTONAMING_SCHEME
static final String	AUTOREVISIONING_SCHEME
static final String	CUSTOMID_SCHEME
static final String	DEFAULT

Constructor Summary

Constructors

Constructor	Description
DocumentScheme()

Method Summary

Modifier and Type	Method	Description
void	afterCheckin(com.logicaldoc.core.document.Document document, com.logicaldoc.core.document.DocumentHistory transaction, Map<String,Object> dictionary)
void	afterSaveHistory(com.logicaldoc.core.document.Document document, com.logicaldoc.core.document.DocumentHistory event, Map<String,Object> dictionary)
void	afterStore(com.logicaldoc.core.document.Document document, com.logicaldoc.core.document.DocumentHistory transaction, Map<String,Object> dictionary)
void	beforeCheckin(com.logicaldoc.core.document.Document document, com.logicaldoc.core.document.DocumentHistory transaction, Map<String,Object> dictionary)
void	beforeStore(com.logicaldoc.core.document.Document document, com.logicaldoc.core.document.DocumentHistory transaction, Map<String,Object> dictionary)
static SchemeProcessor	buildSchemeProcessor(String type, com.logicaldoc.core.document.Document document, boolean checkin, boolean update, Map<String,Long> sequenceMap)	Finds the scheme processor of the proper type
static SchemeProcessor	buildSchemeProcessor(String type, com.logicaldoc.core.document.Document document, boolean checkin, boolean update, Map<String,Object> dictionary, Map<String,Long> sequenceMap)	Finds the scheme processor of the proper type

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final String DEFAULT

See Also:

• Constant Field Values

CUSTOMID_SCHEME

public static final String CUSTOMID_SCHEME

See Also:

• Constant Field Values

AUTONAMING_SCHEME

public static final String AUTONAMING_SCHEME

See Also:

• Constant Field Values

AUTOFOLDING_SCHEME

public static final String AUTOFOLDING_SCHEME

See Also:

• Constant Field Values

AUTOREVISIONING_SCHEME

public static final String AUTOREVISIONING_SCHEME

See Also:

• Constant Field Values

Constructor Details

DocumentScheme

public DocumentScheme()

Method Details

afterStore

public void afterStore(com.logicaldoc.core.document.Document document,
 com.logicaldoc.core.document.DocumentHistory transaction,
 Map<String,Object> dictionary)
                throws com.logicaldoc.core.PersistenceException

Specified by:

afterStore in interface com.logicaldoc.core.document.DocumentListener

Throws:

com.logicaldoc.core.PersistenceException

beforeStore

public void beforeStore(com.logicaldoc.core.document.Document document,
 com.logicaldoc.core.document.DocumentHistory transaction,
 Map<String,Object> dictionary)
                 throws com.logicaldoc.core.PersistenceException

Specified by:

beforeStore in interface com.logicaldoc.core.document.DocumentListener

Throws:

com.logicaldoc.core.PersistenceException

afterCheckin

public void afterCheckin(com.logicaldoc.core.document.Document document,
 com.logicaldoc.core.document.DocumentHistory transaction,
 Map<String,Object> dictionary)
                  throws com.logicaldoc.core.PersistenceException

Specified by:

afterCheckin in interface com.logicaldoc.core.document.DocumentListener

Throws:

com.logicaldoc.core.PersistenceException

beforeCheckin

public void beforeCheckin(com.logicaldoc.core.document.Document document,
 com.logicaldoc.core.document.DocumentHistory transaction,
 Map<String,Object> dictionary)
                   throws com.logicaldoc.core.PersistenceException

Specified by:

beforeCheckin in interface com.logicaldoc.core.document.DocumentListener

Throws:

com.logicaldoc.core.PersistenceException

buildSchemeProcessor

public static SchemeProcessor buildSchemeProcessor(String type,
 com.logicaldoc.core.document.Document document,
 boolean checkin,
 boolean update,
 Map<String,Long> sequenceMap)
                                            throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.automation.AutomationException

Finds the scheme processor of the proper type

Parameters:

type - type of scheme

document - the document being processed

checkin - if we are processing a checkin

update - if we are processing an update of the metadata

sequenceMap - the map containing the values to use for the different sequences

Returns:

the matching processor

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.core.automation.AutomationException - the script has been evaluated but produced an error

buildSchemeProcessor

public static SchemeProcessor buildSchemeProcessor(String type,
 com.logicaldoc.core.document.Document document,
 boolean checkin,
 boolean update,
 Map<String,Object> dictionary,
 Map<String,Long> sequenceMap)
                                            throws com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.automation.AutomationException

Finds the scheme processor of the proper type

Parameters:

type - type of scheme

document - the document being processed

checkin - if we are processing a checkin

update - if we are processing an update of the metadata

dictionary - optional dictionary to use in the automation

sequenceMap - the map containing the values to use for the different sequences

Returns:

the matching processor

Throws:

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.core.automation.AutomationException - the script has been evaluated but produced an error

afterSaveHistory

public void afterSaveHistory(com.logicaldoc.core.document.Document document,
 com.logicaldoc.core.document.DocumentHistory event,
 Map<String,Object> dictionary)
                      throws com.logicaldoc.core.PersistenceException

Specified by:

afterSaveHistory in interface com.logicaldoc.core.document.DocumentListener

Throws:

com.logicaldoc.core.PersistenceException