Class Plugin

java.lang.Object

ru.bgcrm.plugin.Plugin

org.bgerp.plugin.inventoru.Plugin

public class Plugin
extends Plugin

Inventory plugin for tracking network equipment and materials. Also owns the 1C synchronization admin UI (sync1c sub-package).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final Plugin	INSTANCE
static final String	PATH_JSP_ADMIN_DEVICE
static final String	PATH_JSP_ADMIN_EQUIP
static final String	PATH_JSP_ADMIN_INVENTORU
static final String	PATH_JSP_ADMIN_ITEM
static final String	PATH_JSP_ADMIN_MANUFACTURER
static final String	PATH_JSP_ADMIN_MODEL	Equipment models — the entity is DeviceType, its own types live under this path.
static final String	PATH_JSP_ADMIN_MOVEMENT
static final String	PATH_JSP_ADMIN_QUEUE	Queues are configured for every entity of the plugin, not just for warehouses.
static final String	PATH_JSP_ADMIN_STORE
static final String	PATH_JSP_ADMIN_SYNC1C	sync1c is a sub-package of this plugin, so its JSPs and action paths live under the plugin's own tree: the localizer picks the plugin's l10n by the /plugin/<id>/ segment of the URL, and a top-level /plugin/sync1c/ would resolve to a plugin that does not exist.
static final String	PATH_JSP_USER
static final String	PATH_JSP_USER_DEVICE
static final String	PATH_JSP_USER_ITEM
static final String	PATH_JSP_USER_MOVEMENT
static final String	PATH_JSP_USER_STORE
static final String	PATH_JSP_USER_STORE_QUEUE
static final String	PATH_JSP_USER_SYNC1C

Fields inherited from class Plugin

PATH_CSS, PATH_JS, PATH_JSP_ADMIN_PLUGIN, PATH_JSP_OPEN_PLUGIN, PATH_JSP_USER_PLUGIN, PATH_LIB

Method Summary

Modifier and Type	Method	Description
protected Map<String, List<String>>	endpoints()	Plugin endpoints
Set<String>	getObjectTypes()	Entities the plugin defines parameters for.
String	getObjectTypeTitle(String objectType)	Human readable title of an entity, used where entities of all the plugins are listed together, e.g.
String	getTitle()	Human readable plugin title
void	init(Connection con)	Initialization during server's start

Methods inherited from class Plugin

getActionPackages, getCleaner, getDependencies, getEndpoints, getId, getLocalization, getLocalizer, getMessageTypeClass, getResourcePath, getTables, getTitleWithPrefix, getXml, isEnabled, isSystem, loadEndpoints

Methods inherited from class Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

INSTANCE

public static final Plugin INSTANCE

PATH_JSP_USER

public static final String PATH_JSP_USER

See Also:

• Constant Field Values

PATH_JSP_USER_DEVICE

public static final String PATH_JSP_USER_DEVICE

See Also:

• Constant Field Values

PATH_JSP_USER_ITEM

public static final String PATH_JSP_USER_ITEM

See Also:

• Constant Field Values

PATH_JSP_USER_MOVEMENT

public static final String PATH_JSP_USER_MOVEMENT

See Also:

• Constant Field Values

PATH_JSP_USER_STORE

public static final String PATH_JSP_USER_STORE

See Also:

• Constant Field Values

PATH_JSP_USER_STORE_QUEUE

public static final String PATH_JSP_USER_STORE_QUEUE

See Also:

• Constant Field Values

PATH_JSP_USER_SYNC1C

public static final String PATH_JSP_USER_SYNC1C

See Also:

• Constant Field Values

PATH_JSP_ADMIN_INVENTORU

public static final String PATH_JSP_ADMIN_INVENTORU

See Also:

• Constant Field Values

PATH_JSP_ADMIN_SYNC1C

public static final String PATH_JSP_ADMIN_SYNC1C

sync1c is a sub-package of this plugin, so its JSPs and action paths live under the plugin's own tree: the localizer picks the plugin's l10n by the /plugin/<id>/ segment of the URL, and a top-level /plugin/sync1c/ would resolve to a plugin that does not exist.

See Also:

• Constant Field Values

PATH_JSP_ADMIN_STORE

public static final String PATH_JSP_ADMIN_STORE

See Also:

• Constant Field Values

PATH_JSP_ADMIN_QUEUE

public static final String PATH_JSP_ADMIN_QUEUE

Queues are configured for every entity of the plugin, not just for warehouses.

See Also:

• Constant Field Values

PATH_JSP_ADMIN_ITEM

public static final String PATH_JSP_ADMIN_ITEM

See Also:

• Constant Field Values

PATH_JSP_ADMIN_DEVICE

public static final String PATH_JSP_ADMIN_DEVICE

See Also:

• Constant Field Values

PATH_JSP_ADMIN_EQUIP

public static final String PATH_JSP_ADMIN_EQUIP

See Also:

• Constant Field Values

PATH_JSP_ADMIN_MANUFACTURER

public static final String PATH_JSP_ADMIN_MANUFACTURER

See Also:

• Constant Field Values

PATH_JSP_ADMIN_MODEL

public static final String PATH_JSP_ADMIN_MODEL

Equipment models — the entity is DeviceType, its own types live under this path.

See Also:

• Constant Field Values

PATH_JSP_ADMIN_MOVEMENT

public static final String PATH_JSP_ADMIN_MOVEMENT

See Also:

• Constant Field Values

Method Details

init

public void init(Connection con)
          throws Exception

Description copied from class: Plugin

Initialization during server's start

Overrides:

init in class Plugin

Parameters:

con - the DB connection

Throws:

Exception

getTitle

public String getTitle()

Description copied from class: Plugin

Human readable plugin title

Overrides:

getTitle in class Plugin

Returns:

the title

getObjectTypes

public Set<String> getObjectTypes()

Entities the plugin defines parameters for. Each one gets its own directory in Administration / Parameters; the parameters chosen there are then attached to an entity through the param.ids property of its type — every one of the five has a type hierarchy of its own.

Overrides:

getObjectTypes in class Plugin

Returns:

the object types

getObjectTypeTitle

public String getObjectTypeTitle(String objectType)

Description copied from class: Plugin

Human readable title of an entity, used where entities of all the plugins are listed together, e.g. in the parameters directory selector. Has to be localized by the plugin itself with Plugin.getLocalizer(): the localization of the kernel screen showing the title doesn't include the one of the plugin.

Overrides:

getObjectTypeTitle in class Plugin

Parameters:

objectType - one of Plugin.getObjectTypes()

Returns:

the title, the object type itself by default

endpoints

protected Map<String, List<String>> endpoints()

Description copied from class: Plugin

Plugin endpoints

Overrides:

endpoints in class Plugin

Returns:

the endpoints map