Package step.repository.alm.otaclient

Interface IAttachment

All Superinterfaces:

com4j.Com4jObject, IBaseField, IObjectLockingSupport

public interface IAttachment
extends IBaseField

Represents a single file or Internet address attached to a field object.

Method Summary

Modifier and Type	Method	Description
com4j.Com4jObject	attachmentStorage()	The ExtendedStorage object of this attachment.
Object	data()	If the attachment is a file, an array of bytes.
String	description()	The attachment description.
void	description(String pVal)	The attachment description.
String	directLink()	The link or path to the attachment.
String	fileName()	If a file, the file location.
void	fileName(String pVal)	If a file, the file location.
int	fileSize()	The attachment file size in bytes.
Date	lastModified()	The last modified time.
void	load(boolean synchronize, com4j.Holder<String> rootPath)	Downloads an attachment file to a client machine.
String	name(int viewFormat)	The attachment name.
void	rename(String newName)	Renames the attachment on the server.
void	save(boolean synchronize)	Uploads a file to the server.
String	serverFileName()	The attachment file name on the server machine.
int	type()	The attachment type.
void	type(int pVal)	The attachment type.

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Methods inherited from interface step.repository.alm.otaclient.IBaseField

autoPost, autoPost, field, field, id, modified, post, refresh, undo, virtual

Methods inherited from interface step.repository.alm.otaclient.IObjectLockingSupport

isLocked, lockObject, unLockObject

Method Detail

type

int type()

The attachment type. Either File or URL.

Getter method for the COM property "Type"

Returns:

Returns a value of type int

type

void type(int pVal)

The attachment type. Either File or URL.

Setter method for the COM property "Type"

Parameters:

pVal - Mandatory int parameter.

name

String name(@DefaultValue("0")
            int viewFormat)

The attachment name.

Getter method for the COM property "Name"

Parameters:

viewFormat - Optional parameter. Default value is 0

Returns:

Returns a value of type java.lang.String

description

String description()

The attachment description.

Getter method for the COM property "Description"

Returns:

Returns a value of type java.lang.String

description

void description(String pVal)

The attachment description.

Setter method for the COM property "Description"

Parameters:

pVal - Mandatory java.lang.String parameter.

data

Object data()

If the attachment is a file, an array of bytes. If a reference to file, the path or URL.

Getter method for the COM property "Data"

Returns:

Returns a value of type java.lang.Object

fileName

String fileName()

If a file, the file location. If a virtual file, the location for the attachment before it is uploaded to the server. If a URL, the link address.

Getter method for the COM property "FileName"

Returns:

Returns a value of type java.lang.String

fileName

void fileName(String pVal)

If a file, the file location. If a virtual file, the location for the attachment before it is uploaded to the server. If a URL, the link address.

Setter method for the COM property "FileName"

Parameters:

pVal - Mandatory java.lang.String parameter.

load

void load(boolean synchronize,
          com4j.Holder<String> rootPath)

Downloads an attachment file to a client machine.

Parameters:

synchronize - Mandatory boolean parameter.

rootPath - Mandatory Holder parameter.

save

void save(boolean synchronize)

Uploads a file to the server.

Parameters:

synchronize - Mandatory boolean parameter.

attachmentStorage

com4j.Com4jObject attachmentStorage()

The ExtendedStorage object of this attachment. Applies only to file attachments.

Getter method for the COM property "AttachmentStorage"

Returns:

Returns a value of type com4j.Com4jObject

directLink

String directLink()

The link or path to the attachment.

Getter method for the COM property "DirectLink"

Returns:

Returns a value of type java.lang.String

serverFileName

String serverFileName()

The attachment file name on the server machine.

Getter method for the COM property "ServerFileName"

Returns:

Returns a value of type java.lang.String

fileSize

int fileSize()

The attachment file size in bytes.

Getter method for the COM property "FileSize"

Returns:

Returns a value of type int

lastModified

Date lastModified()

The last modified time.

Getter method for the COM property "LastModified"

Returns:

Returns a value of type java.util.Date

rename

void rename(String newName)

Renames the attachment on the server. The attachment must be uploaded before calling this method.

Parameters:

newName - Mandatory java.lang.String parameter.