de.innovationgate.webgate.api

Interface WGFileAnnotations

All Known Implementing Classes:

WGFileDerivateMetaData, WGFileMetaData

public interface WGFileAnnotations

Shared annotation data of file attachments and derivates

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USAGE_ICON An image representation representing the file type of the original file
static java.lang.String	USAGE_POSTER An image representation of any file displaying the files contents in graphical form

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCustomFieldNames() Returns the names of custom fields annotated for this file
java.lang.Object	getCustomFieldValue(java.lang.String fieldName) Returns the value of a custom field annotated for this file
int	getDisplayHeight() Returns the display height in pixels for images or videos
int	getDisplayWidth() Returns the display width in pixels for images or videos
java.lang.String	getMimeType() Returns the mime type
WGDocument	getParentDocument() Returns the parent document to which the file, described by these file annotations, belong
BinaryFieldData	getPlainText() returns a plain text representation of the file
long	getSize() Returns the size of the file in bytes
java.lang.String	getUsage() Returns the usage of a file derivate, using constants #USAGE_...
void	removeCustomField(java.lang.String fieldName) Removes a custom field annotated for this file
void	setCustomFieldValue(java.lang.String fieldName, java.lang.Object value) Sets the value of a custom field annotated for this file
void	setDisplayHeight(int displayHeight) Sets the display height in pixels for images or videos
void	setDisplayWidth(int displayWidth) Sets the display width in pixels for images or videos
void	setMimeType(java.lang.String mimeType) Sets the mime type
void	setPlainText(BinaryFieldData data) sets the plain text representation of this file

Field Detail

USAGE_ICON

static final java.lang.String USAGE_ICON

An image representation representing the file type of the original file

See Also:

Constant Field Values

USAGE_POSTER

static final java.lang.String USAGE_POSTER

An image representation of any file displaying the files contents in graphical form

See Also:

Constant Field Values

Method Detail

getMimeType

java.lang.String getMimeType()
                             throws WGAPIException

Returns the mime type

Throws:

WGAPIException

setMimeType

void setMimeType(java.lang.String mimeType)
                 throws WGAPIException

Sets the mime type

Parameters:

mimeType -

Throws:

WGAPIException

getDisplayHeight

int getDisplayHeight()
                     throws WGAPIException

Returns the display height in pixels for images or videos

Throws:

WGAPIException

setDisplayHeight

void setDisplayHeight(int displayHeight)
                      throws WGAPIException

Sets the display height in pixels for images or videos

Parameters:

displayHeight -

Throws:

WGAPIException

getDisplayWidth

int getDisplayWidth()
                    throws WGAPIException

Returns the display width in pixels for images or videos

Throws:

WGAPIException

setDisplayWidth

void setDisplayWidth(int displayWidth)
                     throws WGAPIException

Sets the display width in pixels for images or videos

Parameters:

displayWidth -

Throws:

WGAPIException

getUsage

java.lang.String getUsage()
                          throws WGAPIException

Returns the usage of a file derivate, using constants #USAGE_... This is readonly and determined by the derivate creator.

Throws:

WGAPIException

getCustomFieldNames

java.util.List<java.lang.String> getCustomFieldNames()
                                                     throws WGAPIException

Returns the names of custom fields annotated for this file

Throws:

WGAPIException

getCustomFieldValue

java.lang.Object getCustomFieldValue(java.lang.String fieldName)
                                     throws WGAPIException

Returns the value of a custom field annotated for this file

Parameters:

fieldName - Name of the field

Returns:

Value of the field

Throws:

WGAPIException

setCustomFieldValue

void setCustomFieldValue(java.lang.String fieldName,
                       java.lang.Object value)
                         throws WGAPIException

Sets the value of a custom field annotated for this file

Parameters:

fieldName - Name of the field

value - Value of the field

Throws:

WGAPIException

removeCustomField

void removeCustomField(java.lang.String fieldName)
                       throws WGAPIException

Removes a custom field annotated for this file

Parameters:

fieldName - Name of the field

Throws:

WGAPIException

getSize

long getSize()
             throws WGAPIException

Returns the size of the file in bytes

Throws:

WGAPIException

getParentDocument

WGDocument getParentDocument()
                             throws WGAPIException

Returns the parent document to which the file, described by these file annotations, belong

Throws:

WGAPIException

getPlainText

BinaryFieldData getPlainText()
                             throws WGAPIException

returns a plain text representation of the file

Throws:

WGAPIException

setPlainText

void setPlainText(BinaryFieldData data)
                  throws WGAPIException

sets the plain text representation of this file

Parameters:

data - plain text data

Throws:

WGAPIException