Oracle Repository API and Model Reference Guide


Contents


API Methods


Element Definitions


Index  


oracle.repos.services.file
Class ReposFolderMapping

java.lang.Object
  |
  +--oracle.repos.services.file.ReposFolderMapping

public class ReposFolderMapping
extends Object

Constructor Summary
ReposFolderMapping()
           

 

Method Summary
(package private) static void ()
          Initializer -- loads native dll ready to fetch relevant system information.
static oracle.repos.services.GID[] getAllFolderMappings(String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Gets a list of all the folder mappings available on the client
static String getDownloadMapping(oracle.repos.services.GID gidFolderIRID, String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Gets the FileSystem folder path associated with the folder mapping key.
static String getFolderName(oracle.repos.services.GID gidFolderIRID, String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Gets the repository folder name associated with the folder mapping.
static FileServiceNfo getMapping(oracle.repos.services.GID gidFolderIRID, String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Gets the repository folder nfo associated with the folder mapping (the folder IRID).
static RID getUploadMapping(oracle.repos.services.GID gidFolderIRID, String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Gets the repository folder ref associated with the folder mapping key.
static boolean removeAllMappingKeys(String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Removes all mapping keys for a specified repository workarea
static boolean removeAllMappingKeysImpl(String strReposUUID, String strWorkareaID)
           
static boolean removeAllWorkareaMappings(String strReposUUID)
          Removes all mapped workareas for a specified repository
static boolean removeMappingKey(oracle.repos.services.GID gidFolderIRID, String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Removes a mapping key for a specified repository workarea
static boolean removeWorkareaMapping(String strReposUUID, oracle.repos.services.GID gidWorkareaID)
          Removes a workarea mapping for a specified repository
static boolean setMapping(oracle.repos.services.GID gidFolderIRID, String strPath, String strReposUUID, oracle.repos.services.GID gidWorkareaID, boolean bForceDefault)
          Deprecated.  
static boolean setMapping(oracle.repos.services.GID gidFolderIRID, String strPath, String strReposUUID, oracle.repos.services.GID gidWorkareaID, String strFolderName, boolean bForceDefault)
          Deprecated.  
static boolean setMapping(oracle.repos.services.GID gidFolderIRID, String strPath, String strReposUUID, oracle.repos.services.GID gidWorkareaID, String strFolderName, int flags)
          Creates a mapping between a repository folder (gidFolderRef) and a FileSystem path (strPath) using a string key-value (strFolderIRID).

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

ReposFolderMapping

public ReposFolderMapping()
Method Detail

static void ()
Initializer -- loads native dll ready to fetch relevant system information.

getMapping

public static FileServiceNfo getMapping(oracle.repos.services.GID gidFolderIRID,
                                        String strReposUUID,
                                        oracle.repos.services.GID gidWorkareaID)
Gets the repository folder nfo associated with the folder mapping (the folder IRID). The folder must be a repository root folder. If the folder is mapped, a FileServiceNfo object is returned with the strName, strOSPath and rid parameters set. IMPORTANT NOTE: Only the IRID of the returned rid is set, the IVID will be set to "0", as a mapped folders IVID is not stored. IMPORTANT NOTE2: The text conversion status, if held in the mapping, is returned in the FileServiceNfo.strStatus variable. strStatus == "W" --> DOS-->UNIX text conversion strStatus == "U" --> UNIX-->DOS text conversion strStatus == "" OR strStatus == null --> no text conversion
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID (the root folder is in)
Returns:
The folder nfo if successful (with only the IRID of the rid being valid), null otherwise.

getUploadMapping

public static RID getUploadMapping(oracle.repos.services.GID gidFolderIRID,
                                   String strReposUUID,
                                   oracle.repos.services.GID gidWorkareaID)
Gets the repository folder ref associated with the folder mapping key. IMPORTANT NOTE: Only the IRID of the returned rid is set, the IVID will be set to "0", as a mapped folders IVID is not stored.
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
Returns:
the folder IRID (in a RID, with the IVID set to 0) if successful, null otherwise.

getFolderName

public static String getFolderName(oracle.repos.services.GID gidFolderIRID,
                                   String strReposUUID,
                                   oracle.repos.services.GID gidWorkareaID)
Gets the repository folder name associated with the folder mapping.
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
Returns:
the folder name (String) if successful, null otherwise.

getDownloadMapping

public static String getDownloadMapping(oracle.repos.services.GID gidFolderIRID,
                                        String strReposUUID,
                                        oracle.repos.services.GID gidWorkareaID)
Gets the FileSystem folder path associated with the folder mapping key.
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
Returns:
the FileSystem path as a string if successful, null otherwise.

setMapping

public static boolean setMapping(oracle.repos.services.GID gidFolderIRID,
                                 String strPath,
                                 String strReposUUID,
                                 oracle.repos.services.GID gidWorkareaID,
                                 boolean bForceDefault)
Deprecated.  
Creates a mapping between a repository folder (gidFolderRef) and a FileSystem path (strPath) using a string key-value (strFolderIRID).
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strPath - IN the FileSystem path as a string
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
bForceDefault - IN overwrite RON registry settings
Returns:
true if successful, false otherwise

setMapping

public static boolean setMapping(oracle.repos.services.GID gidFolderIRID,
                                 String strPath,
                                 String strReposUUID,
                                 oracle.repos.services.GID gidWorkareaID,
                                 String strFolderName,
                                 boolean bForceDefault)
Deprecated.  
Creates a mapping between a repository folder (gidFolderRef) and a FileSystem path (strPath) using a string key-value (strFolderIRID).
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strPath - IN the FileSystem path as a string
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
strFolderName - IN the folder name
bForceDefault - IN overwrite RON registry settings
Returns:
true if successful, false otherwise

setMapping

public static boolean setMapping(oracle.repos.services.GID gidFolderIRID,
                                 String strPath,
                                 String strReposUUID,
                                 oracle.repos.services.GID gidWorkareaID,
                                 String strFolderName,
                                 int flags)
Creates a mapping between a repository folder (gidFolderRef) and a FileSystem path (strPath) using a string key-value (strFolderIRID).
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strPath - IN the FileSystem path as a string
strReposUUID - IN the repository UUID
gidWorkareaID - IN the workarea ID
strFolderName - IN the folder name
flags - IN flags to indicate what (if any) text conversion options to set. Valid flags are: FileService.FS_WIN_TXT_FORMAT (Unix-->DOS) FileService.FS_UNX_TXT_FORMAT (Dos-->Unix) FileService.FS_NO_TXT_FORMAT (no conversion = 0)
Returns:
true if successful, false otherwise

getAllFolderMappings

public static oracle.repos.services.GID[] getAllFolderMappings(String strReposUUID,
                                                               oracle.repos.services.GID gidWorkareaID)
Gets a list of all the folder mappings available on the client
Parameters:
strReposUUID - IN the Repos UUID
gidWorkareaID - IN the workarea ID
Returns:
a GID array of mapped folder IRIDs if successful, null (or empty array) otherwise

removeMappingKey

public static boolean removeMappingKey(oracle.repos.services.GID gidFolderIRID,
                                       String strReposUUID,
                                       oracle.repos.services.GID gidWorkareaID)
Removes a mapping key for a specified repository workarea
Parameters:
gidFolderIRID - IN the IRID of a repository root folder
strReposUUID - IN the Repos UUID
gidWorkareaID - IN the workarea ID
Returns:
true if successful, false otherwise

removeAllMappingKeys

public static boolean removeAllMappingKeys(String strReposUUID,
                                           oracle.repos.services.GID gidWorkareaID)
Removes all mapping keys for a specified repository workarea
Parameters:
strReposUUID - IN the Repos UUID
gidWorkareaID - IN the workarea ID
Returns:
true if successful, false otherwise

removeAllMappingKeysImpl

public static boolean removeAllMappingKeysImpl(String strReposUUID,
                                               String strWorkareaID)

removeWorkareaMapping

public static boolean removeWorkareaMapping(String strReposUUID,
                                            oracle.repos.services.GID gidWorkareaID)
Removes a workarea mapping for a specified repository
Parameters:
strReposUUID - IN the Repos UUID
gidWorkareaID - IN the workarea ID
Returns:
true if successful, false otherwise

removeAllWorkareaMappings

public static boolean removeAllWorkareaMappings(String strReposUUID)
Removes all mapped workareas for a specified repository
Parameters:
strReposUUID - IN the Repos UUID
Returns:
true if successful, false otherwise

BM0463 - JR0670 - JDev446