step.repository.alm.otaclient

Interface IExtendedStorage

All Superinterfaces:

com4j.Com4jObject

public interface IExtendedStorage
extends com4j.Com4jObject

Represents a storage structure used to transfer files between the server and client file system and delete files.

Method Summary

Modifier and Type	Method and Description
int	actionFinished() Checks if the load or save action is finished.
void	cancel() Cancels the load or save action.
String	clientPath() The location on the client to which to download or from which to upload.
void	clientPath(String pVal) The location on the client to which to download or from which to upload.
void	delete(String fSysFilter, int nDeleteType) Deletes files locally or from the server.
void	getLastError() Gets the last error that occurred during asynchronous load and save operations.
String	load(String fSysFilter, boolean synchronize) Downloads the storage structure to the client file system.
String	loadEx(String fSysFilter, boolean synchronize, com4j.Holder<IList> pVal, com4j.Holder<Boolean> pNonFatalErrorOccured) Downloads the storage structure to the client file system.
String	progress(com4j.Holder<Integer> total, com4j.Holder<Integer> current) Polls the progress of the last action (Load or Save).
com4j.Com4jObject	root() The storage root.
void	save(String fSysFilter, boolean synchronize) Uploads the storage structure to the server.
boolean	saveEx(String fSysFilter, boolean synchronize, com4j.Holder<IList> pVal) Uploads the storage structure to the server.
String	serverPath() Deprecated.
void	serverPath(String pVal) Deprecated.

Methods inherited from interface com4j.Com4jObject

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

Method Detail

root

com4j.Com4jObject root()

The storage root.

Getter method for the COM property "Root"

Returns:

Returns a value of type com4j.Com4jObject

load

String load(@DefaultValue(value="*.*")
            String fSysFilter,
            @DefaultValue(value="0")
            boolean synchronize)

Downloads the storage structure to the client file system.

Parameters:

fSysFilter - Optional parameter. Default value is "*.*"

synchronize - Optional parameter. Default value is false

Returns:

Returns a value of type java.lang.String

save

void save(@DefaultValue(value="*.*")
          String fSysFilter,
          @DefaultValue(value="0")
          boolean synchronize)

Uploads the storage structure to the server.

Parameters:

fSysFilter - Optional parameter. Default value is "*.*"

synchronize - Optional parameter. Default value is false

delete

void delete(String fSysFilter,
            int nDeleteType)

Deletes files locally or from the server.

Parameters:

fSysFilter - Mandatory java.lang.String parameter.

nDeleteType - Mandatory int parameter.

serverPath

String serverPath()

Deprecated. The location on the server from which to download or to which to upload.

Getter method for the COM property "ServerPath"

Returns:

Returns a value of type java.lang.String

serverPath

void serverPath(String pVal)

Deprecated. The location on the server from which to download or to which to upload.

Setter method for the COM property "ServerPath"

Parameters:

pVal - Mandatory java.lang.String parameter.

clientPath

String clientPath()

The location on the client to which to download or from which to upload.

Getter method for the COM property "ClientPath"

Returns:

Returns a value of type java.lang.String

clientPath

void clientPath(String pVal)

The location on the client to which to download or from which to upload.

Setter method for the COM property "ClientPath"

Parameters:

pVal - Mandatory java.lang.String parameter.

cancel

void cancel()

Cancels the load or save action.

actionFinished

int actionFinished()

Checks if the load or save action is finished.

Getter method for the COM property "ActionFinished"

Returns:

Returns a value of type int

progress

String progress(com4j.Holder<Integer> total,
                com4j.Holder<Integer> current)

Polls the progress of the last action (Load or Save).

Parameters:

total - Mandatory Holder parameter.

current - Mandatory Holder parameter.

Returns:

Returns a value of type java.lang.String

getLastError

void getLastError()

Gets the last error that occurred during asynchronous load and save operations.

saveEx

boolean saveEx(String fSysFilter,
               boolean synchronize,
               com4j.Holder<IList> pVal)

Uploads the storage structure to the server.

Parameters:

fSysFilter - Mandatory java.lang.String parameter.

synchronize - Mandatory boolean parameter.

pVal - Mandatory Holder parameter.

Returns:

Returns a value of type boolean

loadEx

String loadEx(String fSysFilter,
              boolean synchronize,
              com4j.Holder<IList> pVal,
              com4j.Holder<Boolean> pNonFatalErrorOccured)

Downloads the storage structure to the client file system.

Parameters:

fSysFilter - Mandatory java.lang.String parameter.

synchronize - Mandatory boolean parameter.

pVal - Mandatory Holder parameter.

pNonFatalErrorOccured - Mandatory Holder parameter.

Returns:

Returns a value of type java.lang.String