Package org.openbravo.client.application.attachment

Class AttachmentUtils

java.lang.Object

org.openbravo.client.application.attachment.AttachmentUtils

public class AttachmentUtils
extends Object

Utility class to manage Attachments. It includes a cached map of the attachment configuration of each client in the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttachmentUtils.AttachmentType	The supported types of attachments

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_METHOD
static String	DEFAULT_METHOD_ID

Constructor Summary

Constructors

Constructor	Description
AttachmentUtils()

Method Summary

Modifier and Type	Method	Description
static AttachmentConfig	getAttachmentConfig()	Gets the Attachment Configuration for standard attachments associated to the client active in OBContext
static AttachmentConfig	getAttachmentConfig(String clientId)	Gets the Attachment Configuration for standard attachments associated to the given client
static AttachmentConfig	getAttachmentConfig(String clientId, AttachmentUtils.AttachmentType attachmentType)	Gets the Attachment Configuration for the given attachment type and associated to the given client
static AttachmentConfig	getAttachmentConfig(AttachmentUtils.AttachmentType attachmentType)	Gets the Attachment Configuration for the given attachment type and associated to the client active in OBContext
static AttachmentMethod	getAttachmentMethod()	Gets the Attachment Method related to the active Attachment Configuration of the current client.
static AttachmentMethod	getDefaultAttachmentMethod()	Gets the default Attachment Method
static Object	getPropertyPathValue(Parameter parameter, String tabId, String recordId)	Get the String value of a parameter with a property path
static List<org.codehaus.jettison.json.JSONObject>	getTabAttachmentsForRows(Tab tab, String[] recordIds)	Get JSONObject list with data of the attachments in given tab and records
static void	setAttachmentConfig(String strClient, String strAttConfig)	Updates the current active attachment configuration of standard attachments for the client.
static void	setAttachmentConfig(String strClient, AttachmentUtils.AttachmentType attachmentType, String strAttConfig)	Updates the current active attachment configuration of the given attachment type for the client.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METHOD

public static final String DEFAULT_METHOD

See Also:

Constant Field Values

DEFAULT_METHOD_ID

public static final String DEFAULT_METHOD_ID

See Also:

Constant Field Values

Constructor Detail

AttachmentUtils

public AttachmentUtils()

Method Detail

getAttachmentConfig

public static AttachmentConfig getAttachmentConfig()

Gets the Attachment Configuration for standard attachments associated to the client active in OBContext

Returns:

Activate Attachment Configuration for the current OBContext client

getAttachmentConfig

public static AttachmentConfig getAttachmentConfig(String clientId)

Gets the Attachment Configuration for standard attachments associated to the given client

Parameters:

clientId - Client using openbravo

Returns:

Activated Attachment Configuration for this client

getAttachmentConfig

public static AttachmentConfig getAttachmentConfig(AttachmentUtils.AttachmentType attachmentType)

Gets the Attachment Configuration for the given attachment type and associated to the client active in OBContext

Parameters:

attachmentType - The type of attachment

Returns:

Activated Attachment Configuration for the given attachment and associated to the current OBContext client

getAttachmentConfig

public static AttachmentConfig getAttachmentConfig(String clientId,
                                                   AttachmentUtils.AttachmentType attachmentType)

Gets the Attachment Configuration for the given attachment type and associated to the given client

Parameters:

clientId - Client using openbravo

attachmentType - The type of attachment

Returns:

Activated Attachment Configuration for the given attachment type and client

setAttachmentConfig

public static void setAttachmentConfig(String strClient,
                                       String strAttConfig)

Updates the current active attachment configuration of standard attachments for the client.

Parameters:

strClient - The Client whose attachment configuration has changed.

strAttConfig - The new Attachment Configuration.

setAttachmentConfig

public static void setAttachmentConfig(String strClient,
                                       AttachmentUtils.AttachmentType attachmentType,
                                       String strAttConfig)

Updates the current active attachment configuration of the given attachment type for the client.

Parameters:

strClient - The Client whose attachment configuration has changed.

attachmentType - The attachment type

strAttConfig - The new Attachment Configuration.

getAttachmentMethod

public static AttachmentMethod getAttachmentMethod()

Gets the Attachment Method related to the active Attachment Configuration of the current client. In case the client does not have any attachment configuration the default Attachment Method is returned.

Returns:

The AttachmentMethod to use for the current client.

getDefaultAttachmentMethod

public static AttachmentMethod getDefaultAttachmentMethod()

Gets the default Attachment Method

Returns:

Default Attachment Method

getTabAttachmentsForRows

public static List<org.codehaus.jettison.json.JSONObject> getTabAttachmentsForRows(Tab tab,
                                                                                   String[] recordIds)

Get JSONObject list with data of the attachments in given tab and records

Parameters:

tab - tab to take attachments

recordIds - list of record IDs where taken attachments

Returns:

List of JSONOject with attachments information values

getPropertyPathValue

public static Object getPropertyPathValue(Parameter parameter,
                                          String tabId,
                                          String recordId)
                                   throws OBException

Get the String value of a parameter with a property path

Parameters:

parameter - parameter in which is defined the property path

tabId - table which stores the record with the desired value

recordId - record which has the column with the value to search

Returns:

the String value of the column indicated in the property path

Throws:

OBException - generated if there is distinct than one record to search