Package de.xima.fc.mdl.enums
Enum EAttachmentSource
- java.lang.Object
-
- java.lang.Enum<EAttachmentSource>
-
- de.xima.fc.mdl.enums.EAttachmentSource
-
- All Implemented Interfaces:
INamedUiElement,Serializable,Comparable<EAttachmentSource>
public enum EAttachmentSource extends Enum<EAttachmentSource> implements INamedUiElement
- Author:
- XIMA MEDIA GmbH
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ARCHIVED_FORM_UPLOADAn attachment that was uploaded via a form submission, seeFORM_UPLOADand is now archived.CHAT_MESSAGEThis attachment was uploaded as an attachment for a chat message.FORM_UPLOADThis attachment was uploaded via a form.FORM_UPLOAD_PRESERVED_ORIGINALThis attachment was uploaded via a form and immediately converted into another document format.INBOXThis attachment was uploaded via the inbox.REST_APIThis attachment was uploaded via the REST API.UNKNOWNThe source of this attachment is unknown.WORKFLOWThis attachment was created by a workflow.
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDisplayName(Locale l)The display name of this element in the given locale.booleanin(EAttachmentSource... elements)static EAttachmentSourcevalueOf(String name)Returns the enum constant of this type with the specified name.static EAttachmentSource[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ARCHIVED_FORM_UPLOAD
public static final EAttachmentSource ARCHIVED_FORM_UPLOAD
An attachment that was uploaded via a form submission, seeFORM_UPLOADand is now archived. Normally, when a file is removed from an uploaded element and the form is submitted again, old attachments are deleted. Sometimes the old attachment should be preserved for archiving purposes. In this case, the attachment source is set to this value.
-
FORM_UPLOAD
public static final EAttachmentSource FORM_UPLOAD
This attachment was uploaded via a form.
-
FORM_UPLOAD_PRESERVED_ORIGINAL
public static final EAttachmentSource FORM_UPLOAD_PRESERVED_ORIGINAL
This attachment was uploaded via a form and immediately converted into another document format. If the original upload shall be preserved, itssourceproperty must be set to this value (while the conversion result will haveFORM_UPLOADset as itssourceto make it ready for further processing).
-
WORKFLOW
public static final EAttachmentSource WORKFLOW
This attachment was created by a workflow.
-
INBOX
public static final EAttachmentSource INBOX
This attachment was uploaded via the inbox.
-
CHAT_MESSAGE
public static final EAttachmentSource CHAT_MESSAGE
This attachment was uploaded as an attachment for a chat message.
-
REST_API
public static final EAttachmentSource REST_API
This attachment was uploaded via the REST API.
-
UNKNOWN
public static final EAttachmentSource UNKNOWN
The source of this attachment is unknown.
-
-
Method Detail
-
values
public static EAttachmentSource[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (EAttachmentSource c : EAttachmentSource.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EAttachmentSource valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getDisplayName
public String getDisplayName(Locale l)
The display name of this element in the given locale.- Specified by:
getDisplayNamein interfaceINamedUiElement- Parameters:
l- The locale to get the display name for.- Returns:
- The display name of this element in the given locale.
-
in
public boolean in(EAttachmentSource... elements)
- Parameters:
elements- the enum elements to check this element against- Returns:
- true if this element is contained in the set of the provided elements, otherwise false
-
-