Console Webservice API

Archive

Other API in Package

Console

Console System

Internal Console

List of Classes

ConsoleWebServiceController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsolePacket

ConsoleWebServiceRequest

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

WebServiceResponse

Wizard

XMLReader

ZoneAccess

Provides information about a transaction archive.

Method Summary
File getArchive(boolean decrypt)

Returns the content of the archive.

Data getData()

Returns information about the archive.

String getId()

Returns the ID of this archive (which is also the key on the remote system).

boolean isSoftArchive()

Returns true if this archive is a soft archive, meaning it is associated with an active transaction.

TransactionPacket restoreTransaction(String palId, boolean includeWizards)
⚠Deprecated since 09-04-2014. Use method that specifies retain create date.

Restores the transaction and associates it with the specified Pal and imports transaction data from XML packet. The target Pal must have an activation key that permits an access period.

TransactionPacket restoreTransaction(String palId, boolean retainCreateDate, boolean includeWizards)

Restores the transaction and associates it with the specified Pal and imports transaction data from XML packet. The target Pal must have an activation key that permits an access period.

String toString()

Returns a description of this object.

Method Detail


File getArchive(boolean decrypt)

Returns the content of the archive.

Parameters:

  • boolean   decrypt

Returns:  File

Since: 03-01-2012

top

Data getData()

Returns information about the archive.

Returns:  Data

Since: 03-01-2012

top

String getId()

Returns the ID of this archive (which is also the key on the remote system).

Returns:  String

Since: 03-01-2012

top

boolean isSoftArchive()

Returns true if this archive is a soft archive, meaning it is associated with an active transaction.

Returns:  boolean

Since: 08-19-2015

top

TransactionPacket restoreTransaction(String palId, boolean includeWizards)

Restores the transaction and associates it with the specified Pal and imports transaction data from XML packet. The target Pal must have an activation key that permits an access period.

Parameters:

  • String   palId  - ID of the Pal to associate the transaction with. Required parameter.
  • boolean   includeWizards  - whether to import wizards from XML packet. If true, corresponding wizards must exist or must be available via chain in target Pal.

Returns:  TransactionPacket

Since: 03-02-2012

This method has been deprecated since 09-04-2014. Use method that specifies retain create date.

top

TransactionPacket restoreTransaction(String palId, boolean retainCreateDate, boolean includeWizards)

Restores the transaction and associates it with the specified Pal and imports transaction data from XML packet. The target Pal must have an activation key that permits an access period.

Parameters:

  • String   palId  - ID of the Pal to associate the transaction with. Required parameter.
  • boolean   retainCreateDate  - True means the transaction will be created with the original creation date. Required parameter.
  • boolean   includeWizards  - whether to import wizards from XML packet. If true, corresponding wizards must exist or must be available via chain in target Pal.

Returns:  TransactionPacket

Since: 09-04-2014

top

String toString()

Returns a description of this object.

Returns:  String

Since: 03-01-2012

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM