Style Intelligence v12.0

inetsoft.sree.store
Interface ReportArchive


public interface ReportArchive

Report Archive defines the archive interfaces.


Field Summary
static String REMOVE_ARCHIVE_EVENT
          Remove archive event.
static String RENAME_ARCHIVE_EVENT
          Rename archive event.
static String UNREMOVE_FOLDER_EVENT
          Unremove archive folder event.
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Add property change listener.
 boolean changeFile(String opath, String npath)
          Change an archive file.
 boolean changeFolder(String opath, String npath)
          Change an archive folder.
 void cleanHtmlType()
          Clean htmlType.
 boolean fileExists(String path, String version)
          Check if an archive file exists.
 boolean folderExists(String path)
          Check if an archive folder exists.
 ReportData get(String path, String version)
          Get the report data of an archive file.
 ArchiveRule getArchiveRule(String path)
          Get the archive rule of an archive file or folder.
 String[] getFiles(String folder, boolean all)
          List the archive files in an archive folder.
 String[] getFolders(String folder, boolean all)
          List the sub folders in an archive folder.
 int getHtmlType()
          Get htmlType.
 ArchiveIdentity[] getRemovedFiles()
          Get all the removed archive files.
 ArchiveIdentity[] getRemovedFolders()
          Get all the removed archive folders.
 String[] getRulePaths()
          Get all the paths have archive rule.
 String getUser()
          Get the user of the archive.
 VersionInfo[] getVersions(String path, boolean all)
          Get all versions of an archive file in the archive.
 boolean isVersioned()
          Check if the report archive is a versioned report archive.
 boolean mountFile(String path)
          Mount an archive file to the store.
 boolean mountFolder(String path)
          Mount an archive folder to the store.
 boolean removeFile(String path, String version, boolean permanent)
          Remove an archive file from the store.
 boolean removeFolder(String path, boolean permanent)
          Remove an archive folder from the store.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Remove property change listener.
 boolean save(String path, ReportData data, String comment, Principal user)
          Save an archive file at the specified path.
 void setArchiveRule(String path, ArchiveRule rule)
          Set the archive rule of an arhive file or folder.
 void setHtmlType(int htmlType)
          Set htmlType.
 void setUser(String user)
          Set the user of the archive.
 boolean unmountFile(String path)
          Unmount an archive file from the store.
 boolean unmountFolder(String path)
          Unmount an archive folder from the store.
 boolean unremoveFile(String path, String ver)
          Restore a removed archive file version from trashcan.
 boolean unremoveFolder(String path)
          Restore a removed folder from transhcan.
 

Field Detail

RENAME_ARCHIVE_EVENT

static final String RENAME_ARCHIVE_EVENT
Rename archive event.

See Also:
Constant Field Values

REMOVE_ARCHIVE_EVENT

static final String REMOVE_ARCHIVE_EVENT
Remove archive event.

See Also:
Constant Field Values

UNREMOVE_FOLDER_EVENT

static final String UNREMOVE_FOLDER_EVENT
Unremove archive folder event.

See Also:
Constant Field Values
Method Detail

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)
Add property change listener.

Parameters:
listener - the specified listener.

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)
Remove property change listener.

Parameters:
listener - the specified listener.

isVersioned

boolean isVersioned()
Check if the report archive is a versioned report archive.

Returns:
true if is versioned, false otherwise.

setArchiveRule

void setArchiveRule(String path,
                    ArchiveRule rule)
Set the archive rule of an arhive file or folder.

Parameters:
path - the specified archive file or folder path.
rule - the specified archive rule.

getArchiveRule

ArchiveRule getArchiveRule(String path)
Get the archive rule of an archive file or folder.

Parameters:
path - the specified archive file or folder path.
Returns:
the archive rule of the archive file or folder.

getRulePaths

String[] getRulePaths()
Get all the paths have archive rule.

Returns:
all the paths have archive rule.

getFiles

String[] getFiles(String folder,
                  boolean all)
List the archive files in an archive folder.

Parameters:
folder - the specified archive folder path.
all - true to include removed archive files, false otherwise.
Returns:
the archive files in the archive folder.

getFolders

String[] getFolders(String folder,
                    boolean all)
List the sub folders in an archive folder.

Parameters:
folder - the specified archive folder path.
all - true to include removed archive folders, false otherwise.
Returns:
the sub folders in the archive folder.

removeFile

boolean removeFile(String path,
                   String version,
                   boolean permanent)
Remove an archive file from the store. If this is a versioned store, the specific version is removed, else the archive file will be removed.

Parameters:
path - the specified archive file path.
version - the specified version.
permanent - true to remove the archive file permanently, false otherwise.
Returns:
true if the archive file is removed, false otherwise.

unremoveFile

boolean unremoveFile(String path,
                     String ver)
Restore a removed archive file version from trashcan.

Parameters:
path - the specified archive file path.
ver - the specified version.
Returns:
true if the archive file is restored, false otherwise.

getRemovedFiles

ArchiveIdentity[] getRemovedFiles()
Get all the removed archive files.

Returns:
all the removed archive file identities.

removeFolder

boolean removeFolder(String path,
                     boolean permanent)
Remove an archive folder from the store.

Parameters:
path - the specified archive folder path.
permanent - true to remove the archive folder permanently, false otherwise.
Returns:
true if the archive folder is removed, false otherwise.

unremoveFolder

boolean unremoveFolder(String path)
Restore a removed folder from transhcan.

Parameters:
path - the specified archive folder path.
Returns:
true if the archive folder is restored, false otherwise.

getRemovedFolders

ArchiveIdentity[] getRemovedFolders()
Get all the removed archive folders.

Returns:
all the removed archive folder identities.

changeFile

boolean changeFile(String opath,
                   String npath)
Change an archive file.

Parameters:
opath - the specified old archive file path.
npath - the specified new arcive file npath.
Returns:
true if successful, false otherwise.

changeFolder

boolean changeFolder(String opath,
                     String npath)
Change an archive folder.

Parameters:
opath - the specified old archive folder path.
npath - the specified new archive folder path.
Returns:
true if successful, false otherwise.

save

boolean save(String path,
             ReportData data,
             String comment,
             Principal user)
             throws Exception
Save an archive file at the specified path. The report data could be a file or a set of report pages.

Parameters:
path - the specified archive file path.
comment - the specified comment.
user - the user that created the report.
Returns:
true if the report is successfully saved, false otherwise.
Throws:
Exception

getVersions

VersionInfo[] getVersions(String path,
                          boolean all)
Get all versions of an archive file in the archive.

Parameters:
path - the specified archive file path.
all - true to include removed versions, false otherwise.
Returns:
all versions of the archive file.

fileExists

boolean fileExists(String path,
                   String version)
Check if an archive file exists.

Parameters:
path - the specified archive file path.
version - the specified version.
Returns:
true if exists, false otherwise.

folderExists

boolean folderExists(String path)
Check if an archive folder exists.

Parameters:
path - the specified archive folder path.
Returns:
true if exists, false otherwise.

get

ReportData get(String path,
               String version)
Get the report data of an archive file.

Parameters:
path - the specified archive file path.
version - the specified version.
Returns:
the ReportData of the archive file.

mountFile

boolean mountFile(String path)
Mount an archive file to the store.

Parameters:
path - the specified archive file path.
Returns:
true if the file is successfully mounted, false otherwise.

unmountFile

boolean unmountFile(String path)
Unmount an archive file from the store.

Parameters:
path - the specified archive file path.
Returns:
true if the file is successfully unmounted, false otherwise.

mountFolder

boolean mountFolder(String path)
Mount an archive folder to the store.

Parameters:
path - the specified archive folder path.
Returns:
true if the folder is successfully mounted, false otherwise.

unmountFolder

boolean unmountFolder(String path)
Unmount an archive folder from the store.

Parameters:
path - the specified archive folder path.
Returns:
true if the folder is successfully unmounted, false otherwise.

setUser

void setUser(String user)
Set the user of the archive.

Parameters:
user - the user of the archive.

getUser

String getUser()
Get the user of the archive.

Returns:
the user of the archive.

setHtmlType

void setHtmlType(int htmlType)
Set htmlType.


getHtmlType

int getHtmlType()
Get htmlType.

Returns:
the file type of html.

cleanHtmlType

void cleanHtmlType()
Clean htmlType.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.