com.technia.tvc.core.db

Class VaultUtils

java.lang.Object

com.technia.tvc.core.db.VaultUtils

public class VaultUtils
extends java.lang.Object

Since:

6.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultUtils.VaultInfo Encapsulates the vault information.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	composeOid(int vaultMXOID, int lxOid) Composes the object-id, for an object with the specified LXOID.
static java.lang.String	composeOid(java.lang.String vaultSuffix, int lxOid) Composes the object-id, for an object with the specified LXOID.
static java.lang.String	composeOid(VaultUtils.VaultInfo vi, int lxOid) Composes the object-id, for an object with the specified LXOID.
static int[]	decomposeOid(java.lang.String oid) De-composes the object-id, into an integer array consist of: The MXOID for the vault The LXOID for the object
static boolean	exists(java.lang.String vaultName) Returns true if the vault with the specified name exists in the database.
static java.lang.String[]	getTableSuffixAndLXOID(java.lang.String oid) Returns an array of length 2, where the first item is the table suffix for the vault and the second item is the LXOID for the object itself.
static VaultUtils.VaultInfo[]	getVaultInfo() Returns the vault information for all the vaults in the database
static VaultUtils.VaultInfo	getVaultInfo(java.lang.String name) Returns the vault information for the given vault
static java.lang.String[]	getVaultNames() Returns a string array, containing the names of the vaults within the database

Methods inherited from class java.lang.Object

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

Method Detail

exists

public static boolean exists(java.lang.String vaultName)
                      throws TVCException

Returns true if the vault with the specified name exists in the database.

This method will call the DB using an MQL Command to list the vaults.

Parameters:

vaultName - The name of the vault

Returns:

True if the vault exists

Throws:

TVCException - If unable to list the vaults in the database.

Since:

2010.3.1

getVaultNames

public static java.lang.String[] getVaultNames()
                                        throws TVCException

Returns a string array, containing the names of the vaults within the database

Throws:

TVCException

getVaultInfo

public static VaultUtils.VaultInfo getVaultInfo(java.lang.String name)
                                         throws TVCException

Returns the vault information for the given vault

Parameters:

name - The name of the vault

Throws:

TVCException - If unable to retreive the information

getVaultInfo

public static VaultUtils.VaultInfo[] getVaultInfo()
                                           throws TVCException

Returns the vault information for all the vaults in the database

Throws:

TVCException - If unable to retreive the information

composeOid

public static java.lang.String composeOid(VaultUtils.VaultInfo vi,
                                          int lxOid)

Composes the object-id, for an object with the specified LXOID.

Parameters:

vi - The vault

lxOid - the LXOID for the object (from the LXBO_* table)

composeOid

public static java.lang.String composeOid(java.lang.String vaultSuffix,
                                          int lxOid)

Composes the object-id, for an object with the specified LXOID.

Parameters:

vaultSuffix - The vault suffix

lxOid - the LXOID for the object (from the LXBO_* table)

composeOid

public static java.lang.String composeOid(int vaultMXOID,
                                          int lxOid)

Composes the object-id, for an object with the specified LXOID.

Parameters:

vaultMXOID - The vault MXOID

lxOid - the LXOID for the object (from the LXBO_* table)

decomposeOid

public static int[] decomposeOid(java.lang.String oid)

De-composes the object-id, into an integer array consist of:

1. The MXOID for the vault
2. The LXOID for the object

Parameters:

oid - The object id. Must be a valid object-id string of format 1234.5678.90123.456

getTableSuffixAndLXOID

public static java.lang.String[] getTableSuffixAndLXOID(java.lang.String oid)

Returns an array of length 2, where the first item is the table suffix for the vault and the second item is the LXOID for the object itself.

Parameters:

oid - The object id.

Returns:

An array of length 2.