com.stdnet.moveit.api

Class MOVEitMessageInfo.MOVEitMessageAttachment

java.lang.Object

com.stdnet.moveit.api.MOVEitMessageInfo.MOVEitMessageAttachment

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

MOVEitMessageInfo

public class MOVEitMessageInfo.MOVEitMessageAttachment
extends java.lang.Object
implements java.io.Serializable

Object describing a message attachment.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
MOVEitFileInfo	getFileInfo() File information object describing an attachment on the MOVEit Transfer server.
java.lang.String	getID() Tracking ID of attachment file, if it is currently on the MOVEit Transfer server.
byte[]	getLocalData() Data contents of attachment file, if object describes a locally provided file.
java.lang.String	getLocalPath() Local path of attachment file, if object describes a locally available file.
java.lang.String	getName() Name of attachment file.
int	getRemainingDownloads() Number of downloads remaining for an attachment, if a limit has been set.
boolean	hasData() Determines whether the object describes a local attachment file for which the data content has been provided.
boolean	isLocal() Determines whether the attachment file described by the object is local.

Methods inherited from class java.lang.Object

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

Method Detail

getID

public java.lang.String getID()

Tracking ID of attachment file, if it is currently on the MOVEit Transfer server.

Returns:

Attachment file ID if present; otherwise, null

getName

public java.lang.String getName()

Name of attachment file.

Returns:

Attachment file name

getLocalPath

public java.lang.String getLocalPath()

Local path of attachment file, if object describes a locally available file.

Returns:

Attachment file local path if present; otherwise, null

getLocalData

public byte[] getLocalData()

Data contents of attachment file, if object describes a locally provided file.

Note: Data of an attachment file on the MOVEit Transfer server will not be available via this property. A file download must be executed to access server data.

Returns:

Attachment file local data contents if present; otherwise, null

getFileInfo

public MOVEitFileInfo getFileInfo()

File information object describing an attachment on the MOVEit Transfer server. The object will only contain ID, original filename, size, and integrity status.

Returns:

File information object describing attachment if on server; otherwise, null

getRemainingDownloads

public int getRemainingDownloads()

Number of downloads remaining for an attachment, if a limit has been set. A value of 9999 indicates there is no download limit being imposed.

Returns:

Remaining download count if available; otherwise, -1

isLocal

public boolean isLocal()

Determines whether the attachment file described by the object is local. Local attachment files are those which have not yet been uploaded to the MOVEit Transfer server.

Returns:

true if attachment file is local; otherwise, false

hasData

public boolean hasData()

Determines whether the object describes a local attachment file for which the data content has been provided. If so, the local data will be available via the getLocalData() method.

Returns:

true if attachment file is local and data content is available; otherwise, false