ProjectServiceInterface (csbase-common BRS-4.0.0 API)

All Superinterfaces:

Remote, RemoteObservable, ServiceInterface
```
public interface ProjectServiceInterface
extends ServiceInterface, RemoteObservable
```
Define a interface remota do serviço de projetos do Server.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CURRENT_PROJECT_SESSION_PROPERTY` Nome da propriedade da sessão do usuário no servidor que indica o projeto corrente (na árvore) do usuário.
`static int`	`INFINITE_TIMEOUT` Constante que representa a espera, sem timeout, por um lock de arquivo.
`static String`	`SERVICE_NAME` Nome do serviço para o `ServiceManager`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`acquireExclusiveLock(Object projectId, String[] path)` Obtém lock de escrita exclusivo para um arquivo.
`Object`	`acquireExclusiveLock(Object projectId, String[] path, FileLockListenerInterface listener, long timeout)` Tenta obter um lock de escrita exclusivo para um arquivo.
`Object`	`acquireSharedLock(Object projectId, String[] path)` Obtém lock de escrita compartilhado para um arquivo.
`Object`	`acquireSharedLock(Object projectId, String[] path, FileLockListenerInterface listener, long timeout)` Tenta obter lock de escrita compartilhado para um arquivo.
`void`	`addObserver(RemoteObserver observer, Object arg)` Registra um observador interessado nas mudanças que ocorrerem em um projeto.
`void`	`appendFileDescription(Object projectId, String[] path, String text)` Anexa um texto à descrição atual deste arquivo.
`void`	`changeFileType(Object projectId, String[] path, String type)` Muda o tipo de um arquivo de um projeto.
`void`	`closeProject(Object projectId, boolean notify)` Fecha um projeto.
`void`	`copyFile(Object sourceProjectId, String[] filePathSource, Object targetProjectId, String[] dirPathTarget)` Copia um arquivo de um projeto para um diretório de outro projeto.
`void`	`copyFile(Object projectId, String[] filePath, String[] dirPath)` Copia um arquivo de um projeto para outro diretório.
`void`	`createDirectory(Object projectId, String[] path)` Cria um novo diretório, ou uma nova árvore de diretórios, dentro de um projeto.
`void`	`createFile(Object projectId, String[] path, String name, String type)` Cria um novo arquivo em um projeto.
`void`	`createFiles(Object projectId, String[] parentPath, List<ProjectFileInfo> fileInfoList)` Cria simultaneamente vários arquivos dentro de um mesmo diretório.
`CommonClientProject`	`createProject(CommonProjectInfo info)` Cria, abre e retorna um novo projeto.
`void`	`createProjectWithAllocation(CommonProjectInfo info, long size)` Cria um novo projeto solicitando alocação de área em disco.
`boolean`	`deleteObserver(RemoteObserver observer, Object arg)` Remove um observador registrado em um projeto.
`boolean`	`existsFile(Object projectId, String[] path)` Verifica se um arquivo existe no servidor.
`boolean`	`existsProject(Object projectId)` Informa se um dado projeto existe.
`long`	`fileSize(Object projectId, String[] path)` Retorna o tamanho de um arquivo.
`int`	`forceReleaseLock(Object projectId, String[] path)` Força a remoção do lock do arquivo.
`void`	`freeAreaForProjects(ProjectAdminInfo[] infos)` Informa que um ou mais projetos tiveram sua área liberada.
`List<FileInfoSearchResult>`	`getAllFileInfoSearchResult(Object projectId, String text, boolean isCaseInsensitive, boolean isRegex)` Obtém a lista de resultados de uma busca de arquivos em um projeto, de acordo com as condições solicitadas (nome do arquivo, se deve ignorar maíusculas/minúsculas, se usa ou não uma expressão regular).
`Map<String,ProjectFileTypeInfo>`	`getAllFileTypes(Locale loc)` Obtém as propriedades de todos os tipos de arquivos cadastrados.
`ClientProjectFile`	`getChild(Object projectId, String[] path)` Retorna um arquivo.
`ClientProjectFile`	`getChild(Object projectId, String[] path, String name)` Retorna um arquivo.
`ClientProjectFile[]`	`getChildren(Object projectId, String[] path)` Retorna a lista de filhos imediatos de um diretório (ou `null` se o arquivo não for um diretório).
`ClientProjectFile[]`	`getChildren(Object projectId, String[] path, boolean recursive)` Retorna a lista de filhos imediatos de um diretório (ou `null` se o arquivo não for um diretório).
`String`	`getFileDescription(Object projectId, String[] path)` Obtém a descrição atual deste arquivo.
`ProjectFileTypeInfo`	`getFileType(String type)` Obtem todas as propriedades de um tipo de arquivo.
`String`	`getLocalProjectPath()`
`ProjectAdminInfo[]`	`getLockedProjectAdminInfo()` Obtém as informações de todos os projetos dos usuários.
`Set<Object>`	`getManageableProjectsId()` Obtém um conjunto com o identificador de todos os projetos gerenciáveis pelo usuário corrente.
`String`	`getMimeType(String type)` Obtem o mimeType a partir do tipo do arquivo.
`long`	`getModificationDate(Object projectId, String[] path)` Retorna a data de modificação de um arquivo.
`ClientOptimizationMode`	`getOptimizationMode()`
`ProjectAdminInfo`	`getProjectAdminInfo(Object projectId)` Obtém as informações administrativas de um projeto de um usuário.
`String`	`getProjectLocationInServer(Object projectId)` Informa onde o diretório do projeto está instalado no servidor.
`List<UserProjectInfo>`	`getProjectsFromUser(Object userId)` Retorna os nomes de todos os projetos de um usuário.
`List<UserProjectInfo>`	`getProjectsSharedWithUser(Object userId)` Obtém todos os projetos que um usuário participa, mas não é o administrador do projeto.
`ClientProjectFileInfo`	`getUpdatedFileInfo(Object projectId, String[] path)` Atualiza as informações de um arquivo.
`boolean`	`isAreaReserved()` Indica se o serviço de projetos utiliza reserva de área.
`boolean`	`isUnlockedWithAreaAllocated(Object projectId)` Verifica se um projeto está desbloqueado utilizando área reservada.
`CommonProjectInfo`	`modifyProject(Object projectId, CommonProjectInfo info)` Modifica as informações de um projeto.
`void`	`moveFile(Object sourceProjectId, String[] filePathSource, Object targetProjectId, String[] dirPathTarget)` Move um arquivo de um projeto para um diretório de outro projeto.
`void`	`moveFile(Object projectId, String[] filePath, String[] dirPath)` Move um arquivo de um projeto para outro diretório.
`tecgraf.ftc.common.logic.RemoteFileChannelInfo`	`openFileChannel(Object projectId, String[] path, boolean readOnly)` Abre um arquivo para leitura e escrita.
`CommonClientProject`	`openProject(Object projectId, boolean notify)` Abre um projeto de um usuário.
`void`	`rebuildDir(Object projectId, String[] path)` Reconstrói a árvore do diretório especificado a partir do sistema de arquivos do servidor.
`void`	`rebuildTree(Object projectId)` Reconstrói a árvore do projeto a partir do sistema de arquivos do servidor.
`void`	`refreshDir(Object projectId, String[] path)` Atualiza a árvore, a partir do diretório especificado.
`void`	`refreshTree(Object projectId)` Atualiza a árvore, a partir da sua raiz.
`int`	`releaseLock(Object projectId, String[] path, Object lockId)` Libera lock de um arquivo.
`void`	`removeFile(Object projectId, String[] path)` Remove um arquivo de um projeto.
`void`	`removeFiles(Object projectId, String[][] paths)` Remove vários arquivos de um projeto.
`void`	`removeProject(Object projectId)` Remove um projeto.
`boolean`	`removeUser(Object projectId, Object userId)` Remove um usuário das listas de acesso.
`boolean`	`removeUserProjects(Object userId)` Remove todos os projetos de um usuário e seu diretório-base
`void`	`removeUsers(Object projectId, Set<Object> usersId)` Remove um conjunto de usuários de ambas as listas de acesso (RO e RW).
`void`	`renameFile(Object projectId, String[] path, String name)` Troca o nome de um arquivo de um projeto.
`void`	`setAllocatedProjectAsUnallocated(Object projectId)` Converte um projeto com alocação de área em um projeto sem alocação.
`void`	`setFileDescription(Object projectId, String[] path, String text)` Muda a descrição atual deste arquivo.
`void`	`setFileModificationDate(Object projectId, String[] path, long date)` Muda a data de alteração de um arquivo.
`void`	`setUnallocatedProjectAsAllocated(Object projectId, int areaSize)` Converte um projeto sem alocação de área em um projeto com alocação.
`void`	`setUnallocatedProjectAsLocked(Object projectId, int areaSize)` Converte um projeto sem alocação de área em um projeto que aguarda alocação.
`void`	`setUnderConstruction(Object projectId, String[] path, boolean underConstruction)` Altera o estado do arquivo para o valor dado no parâmetro `underConstruction`.
`void`	`startUpdate(Object projectId, String[] path, long interval, boolean notification)` Inicia ou altera o intervalo de atualização de um arquivo.
`void`	`startUpdate(Object projectId, String[] path, long interval, boolean notification, Serializable extraInfo)` Inicia ou altera o intervalo de atualização de um arquivo.
`void`	`stopUpdate(Object projectId, String[] path)` Pára a atualização de um arquivo.
`void`	`unlockProjectsWithAllocation(ProjectAdminInfo[] infos)` Informa que um ou mais projetos tiveram sua área concedida.
`void`	`updateUsers(Object projectId, ProjectPermissions.SharingType sharingType, Set<Object> usersRO, Set<Object> usersRW)` Configura as permissões de acesso ao projeto.
`List<Boolean>`	`userCanWrite(List<Object> projects, Object userId)` Verifica se um usuário possui permissão de escrita em diferentes projetos.
`boolean`	`userCanWrite(Object projectId, Object userId)` Verifica se um usuário possui acesso de escrita a um projeto.
`boolean`	`userHasHisOwnProjects(Object userId)` Verifica se o usuário possui algum projeto.
`boolean`	`userOwnsLock(Object projectId, String[] path)` Verifica se o usuário corrente é o dono do lock de um arquivo.
`boolean`	`userParticipatesOnSharedProjects(Object userId)` Verifica se um usuário participa de projetos de outros usuários.

Methods inherited from interface csbase.remote.ServiceInterface
getName, isActive

Methods inherited from interface csbase.remote.RemoteObservable
countObservers, deleteObservers, notifyObservers

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    Nome do serviço para o ServiceManager
    
    See Also:
    Constant Field Values
  - CURRENT_PROJECT_SESSION_PROPERTY
```
static final String CURRENT_PROJECT_SESSION_PROPERTY
```
    Nome da propriedade da sessão do usuário no servidor que indica o projeto corrente (na árvore) do usuário.
    
    See Also:
    Constant Field Values
  - INFINITE_TIMEOUT
```
static final int INFINITE_TIMEOUT
```
    Constante que representa a espera, sem timeout, por um lock de arquivo.
    
    See Also:
    Constant Field Values
- Method Detail
  - userHasHisOwnProjects
```
boolean userHasHisOwnProjects(Object userId)
                              throws RemoteException
```
    Verifica se o usuário possui algum projeto.
    
    Parameters:
    userId - identificador do usuário
    
    Returns:
    true se o usuário possui algum projeto próprio
    
    Throws:
    
    RemoteException
    See Also:
    userParticipatesOnSharedProjects(Object), getProjectsFromUser(Object)
  - userCanWrite
```
boolean userCanWrite(Object projectId,
                   Object userId)
                     throws RemoteException
```
    Verifica se um usuário possui acesso de escrita a um projeto.
    
    Parameters:
    projectId - identificador do projeto
    userId - identificador do usuário
    
    Returns:
    true se o usuário tem permissão de escrita no projeto
    
    Throws:
    
    RemoteException
  - userCanWrite
```
List<Boolean> userCanWrite(List<Object> projects,
                         Object userId)
                           throws RemoteException
```
    Verifica se um usuário possui permissão de escrita em diferentes projetos.
    
    Parameters:
    projects - lista com identificadores dos projetos
    userId - identificador do usuário
    
    Returns:
    lista com booleanos indicando com true aqueles para os quais o usuário tem permissão de escrita. Os índices correspondem aos índices dos projetos na lista recebida como parâmetro
    
    Throws:
    
    RemoteException
  - getProjectsFromUser
```
List<UserProjectInfo> getProjectsFromUser(Object userId)
                                          throws RemoteException
```
    Retorna os nomes de todos os projetos de um usuário. A lista retornada inclui apenas os projetos dos quais o usuário especificado é dono, não incluindo os projetos de outros usuários aos quais ele tem acesso.
    
    Parameters:
    userId - Identificador do usuário.
    
    Returns:
    Lista de UserProjectInfo contendo informações dos projetos dos quais o usuário indicado é o dono. Retorna null se o usuário ainda não possui "home".
    
    Throws:
    
    RemoteException
  - getProjectsSharedWithUser
```
List<UserProjectInfo> getProjectsSharedWithUser(Object userId)
                                                throws RemoteException
```
    Obtém todos os projetos que um usuário participa, mas não é o administrador do projeto.
    
    Parameters:
    userId - Identificador do usuário.
    
    Returns:
    Lista de UserProjectInfo contendo informações dos projetos aos quais o usuário indicado tem acesso.
    
    Throws:
    
    RemoteException
  - userParticipatesOnSharedProjects
```
boolean userParticipatesOnSharedProjects(Object userId)
                                         throws RemoteException
```
    Verifica se um usuário participa de projetos de outros usuários.
    
    Parameters:
    userId - identificador do usuário
    
    Returns:
    true se o usuário participa de projetos de outros usuários
    
    Throws:
    
    RemoteException
    See Also:
    userHasHisOwnProjects(Object), getProjectsSharedWithUser(Object)
  - updateUsers
```
void updateUsers(Object projectId,
               ProjectPermissions.SharingType sharingType,
               Set<Object> usersRO,
               Set<Object> usersRW)
                 throws RemoteException
```
    Configura as permissões de acesso ao projeto.
    
    Parameters:
    projectId - - identificador do projeto
    sharingType - - tipo do compartilhamento
    usersRO - - conjunto de usuários com acesso RO. O valor null indica que a lista não foi alterada
    usersRW - - conjunto de usuários com acesso RW. O valor null indica que a lista não foi alterada
    
    Throws:
    
    RemoteException
  - removeUser
```
boolean removeUser(Object projectId,
                 Object userId)
                   throws RemoteException
```
    Remove um usuário das listas de acesso. Cada usuário por construção pode pertencer a apenas uma das listas; este método tenta a remoção em ambas as listas antes de falhar.
    
    Parameters:
    projectId - - identificador do projeto
    userId - - identificador do usuário
    
    Returns:
    flag indicando se o usuário foi removido de alguma das listas
    
    Throws:
    
    RemoteException
  - removeUsers
```
void removeUsers(Object projectId,
               Set<Object> usersId)
                 throws RemoteException
```
    Remove um conjunto de usuários de ambas as listas de acesso (RO e RW).
    
    Parameters:
    projectId - - identificador do projeto
    usersId - - conjunto de identificadores de usuários a serem removidos
    
    Throws:
    
    RemoteException
  - removeUserProjects
```
boolean removeUserProjects(Object userId)
                           throws RemoteException
```
    Remove todos os projetos de um usuário e seu diretório-base
    
    Parameters:
    userId - Id do usuário
    
    Returns:
    true se removeu os projetos e o diretório-base com sucesso ou se o diretório-base já não existia ou false caso a remoção tenha falhado.
    
    Throws:
    
    RemoteException
  - openProject
```
CommonClientProject openProject(Object projectId,
                              boolean notify)
                                throws RemoteException
```
    Abre um projeto de um usuário.
    
    Parameters:
    projectId - Identificador do projeto a ser aberto.
    notify - indicativo de notificação aos clientes de projeto aberto.
    
    Returns:
    Objeto da classe CommonClientProject que representa o projeto.
    
    Throws:
    
    RemoteException
  - createProject
```
CommonClientProject createProject(CommonProjectInfo info)
                                  throws RemoteException
```
    Cria, abre e retorna um novo projeto.
    
    Parameters:
    info - Informações do projeto.
    
    Returns:
    o projeto criado
    
    Throws:
    
    RemoteException
  - createProjectWithAllocation
```
void createProjectWithAllocation(CommonProjectInfo info,
                               long size)
                                 throws RemoteException
```
    Cria um novo projeto solicitando alocação de área em disco.
    
    Parameters:
    info - Informações do projeto.
    size - O tamanho da área de alocação.
    
    Throws:
    
    RemoteException
  - unlockProjectsWithAllocation
```
void unlockProjectsWithAllocation(ProjectAdminInfo[] infos)
                                  throws RemoteException
```
    Informa que um ou mais projetos tiveram sua área concedida. Os projetos passam a estar bloqueados. Esse método somente pode ser chamado pelo administrador do sistema.
    
    Parameters:
    infos - Um array com os objetos ProjectAdminInfo com as informações de desbloqueio de projetos devido a alocação de área pelo administrador.
    
    Throws:
    
    RemoteException
  - freeAreaForProjects
```
void freeAreaForProjects(ProjectAdminInfo[] infos)
                         throws RemoteException
```
    Informa que um ou mais projetos tiveram sua área liberada. Esse método somente pode ser chamado pelo administrador do sistema.
    
    Parameters:
    infos - Um array com os objetos ProjectAdminInfo com as informações de liberação da área.
    
    Throws:
    
    RemoteException
  - modifyProject
```
CommonProjectInfo modifyProject(Object projectId,
                              CommonProjectInfo info)
                                throws RemoteException
```
    Modifica as informações de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    info - Novas informações do projeto.
    
    Returns:
    As novas informações do projeto. Caso alguma informação não possa ser alterada, o valor anterior é retornado.
    
    Throws:
    
    RemoteException
  - removeProject
```
void removeProject(Object projectId)
                   throws RemoteException
```
    Remove um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    
    Throws:
    
    RemoteException
  - closeProject
```
void closeProject(Object projectId,
                boolean notify)
                  throws RemoteException
```
    Fecha um projeto.
    
    Parameters:
    projectId - Identificador do projeto a ser fechado.
    notify - indicativo de notificação ao cliente.
    
    Throws:
    
    RemoteException
  - existsProject
```
boolean existsProject(Object projectId)
                      throws RemoteException
```
    Informa se um dado projeto existe.
    
    Parameters:
    projectId - Identificador do projeto.
    
    Returns:
    Verdadeiro caso exista, falso caso contrário.
    
    Throws:
    
    RemoteException
  - rebuildTree
```
void rebuildTree(Object projectId)
                 throws RemoteException
```
    Reconstrói a árvore do projeto a partir do sistema de arquivos do servidor.
    IMPORTANTE: toda a árvore é obtida recursivamente a partir da raiz; portanto, esta é uma operação potencialmente custosa.
    
    Parameters:
    projectId - Identificador do projeto.
    
    Throws:
    
    RemoteException
    See Also:
    refreshTree(Object)
  - refreshTree
```
void refreshTree(Object projectId)
                 throws RemoteException
```
    Atualiza a árvore, a partir da sua raiz. Ao contrário de rebuildTree(Object), não obtém toda a árvore a priori, deixando que isto seja feito por demanda pelos handlers do evento correspondente.
    
    Parameters:
    projectId - identificador do projeto
    
    Throws:
    
    RemoteException
    See Also:
    rebuildTree(Object)
  - rebuildDir
```
void rebuildDir(Object projectId,
              String[] path)
                throws RemoteException
```
    Reconstrói a árvore do diretório especificado a partir do sistema de arquivos do servidor.
    IMPORTANTE: toda a árvore é obtida recursivamente a partir do diretório especificado; portanto, esta é uma operação potencialmente custosa.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório a ser atualizado. Se o array tiver tamanho zero, significa que a atualização será feita a partir da raiz.
    
    Throws:
    
    RemoteException
  - refreshDir
```
void refreshDir(Object projectId,
              String[] path)
                throws RemoteException
```
    Atualiza a árvore, a partir do diretório especificado. Ao contrário de rebuildDir(Object, String[]), não obtém toda a árvore a priori, deixando que isto seja feito por demanda pelos handlers do evento correspondente.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório a ser atualizado. Se o array tiver tamanho zero, significa que a atualização será feita a partir da raiz.
    
    Throws:
    
    RemoteException
  - createDirectory
```
void createDirectory(Object projectId,
                   String[] path)
                     throws RemoteException
```
    Cria um novo diretório, ou uma nova árvore de diretórios, dentro de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório a ser criado. Todos os elementos do array que ainda não existam serão criados no projeto como diretórios, a partir da raiz.
    
    Throws:
    
    RemoteException
  - getChildren
```
ClientProjectFile[] getChildren(Object projectId,
                              String[] path)
                                throws RemoteException
```
    Retorna a lista de filhos imediatos de um diretório (ou null se o arquivo não for um diretório). Não percorre a subárvore recursivamente.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório, a partir da raiz.
    
    Returns:
    Lista de filhos imediatos do diretório, ou null se arquivo indicado não for um diretório.
    
    Throws:
    
    RemoteException
    See Also:
    getChildren(Object, String[], boolean)
  - getChildren
```
ClientProjectFile[] getChildren(Object projectId,
                              String[] path,
                              boolean recursive)
                                throws RemoteException
```
    Retorna a lista de filhos imediatos de um diretório (ou null se o arquivo não for um diretório).
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório, a partir da raiz.
    recursive - Indica se a sub-árvore deve ser obtida recursivamente.
    
    Returns:
    Lista de filhos imediatos do diretório, ou null se arquivo indicado não for um diretório.
    
    Throws:
    
    RemoteException
    See Also:
    getChildren(Object, String[])
  - getChild
```
ClientProjectFile getChild(Object projectId,
                         String[] path,
                         String name)
                           throws RemoteException
```
    Retorna um arquivo.
    
    Parameters:
    projectId - identificador do projeto.
    path - caminho para o diretório que contém o arquivo, a partir da raiz. Não inclui o nome do projeto, nem o nome do arquivo.
    name - nome do arquivo.
    
    Returns:
    o arquivo
    
    Throws:
    
    RemoteException
    See Also:
    getChild(Object, String[])
  - getChild
```
ClientProjectFile getChild(Object projectId,
                         String[] path)
                           throws RemoteException
```
    Retorna um arquivo.
    
    Parameters:
    projectId - identificador do projeto
    path - path para o arquivo, a partir da raiz. Não inclui o nome do projeto
    
    Returns:
    o arquivo
    
    Throws:
    
    RemoteException
    See Also:
    getChild(Object, String[], String)
  - createFile
```
void createFile(Object projectId,
              String[] path,
              String name,
              String type)
                throws RemoteException
```
    Cria um novo arquivo em um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do diretório pai, a partir da raiz.
    name - Nome do arquivo a ser criado.
    type - Tipo do arquivo a ser criado.
    
    Throws:
    
    RemoteException
  - createFiles
```
void createFiles(Object projectId,
               String[] parentPath,
               List<ProjectFileInfo> fileInfoList)
                 throws RemoteException
```
    Cria simultaneamente vários arquivos dentro de um mesmo diretório. Os caminhos dos arquivos devem ser passados relativamente ao diretório-base, que atua como raiz da árvore de arquivos.
    
    Parameters:
    projectId - Identificador do projeto.
    parentPath - Caminho do diretório-base, a partir da raiz, ancestral de todos os arquivos a serem criados.
    fileInfoList - Lista de dados dos arquivos a serem criados.
    
    Throws:
    
    RemoteException
  - renameFile
```
void renameFile(Object projectId,
              String[] path,
              String name)
                throws RemoteException
```
    Troca o nome de um arquivo de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo a ser renomeado, a partir da raiz.
    name - Novo nome do arquivo.
    
    Throws:
    
    RemoteException
  - changeFileType
```
void changeFileType(Object projectId,
                  String[] path,
                  String type)
                    throws RemoteException
```
    Muda o tipo de um arquivo de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz, cujo tipo será alterado.
    type - Novo tipo do arquivo.
    
    Throws:
    
    RemoteException
  - copyFile
```
void copyFile(Object projectId,
            String[] filePath,
            String[] dirPath)
              throws RemoteException
```
    Copia um arquivo de um projeto para outro diretório.
    
    Parameters:
    projectId - Identificador do projeto.
    filePath - Caminho do arquivo a ser copiado, a partir da raiz.
    dirPath - Caminho do diretório destino, a partir da raiz.
    
    Throws:
    
    RemoteException
  - copyFile
```
void copyFile(Object sourceProjectId,
            String[] filePathSource,
            Object targetProjectId,
            String[] dirPathTarget)
              throws RemoteException
```
    Copia um arquivo de um projeto para um diretório de outro projeto.
    
    Parameters:
    sourceProjectId - Identificador do projeto Origem.
    filePathSource - Caminho do arquivo a ser copiado, a partir da raiz.
    targetProjectId - Identificador do projeto Destino.
    dirPathTarget - Caminho do diretório destino, a partir da raiz.
    
    Throws:
    
    RemoteException
  - moveFile
```
void moveFile(Object projectId,
            String[] filePath,
            String[] dirPath)
              throws RemoteException
```
    Move um arquivo de um projeto para outro diretório.
    
    Parameters:
    projectId - Identificador do projeto.
    filePath - Caminho do arquivo a ser movido, a partir da raiz.
    dirPath - Caminho do diretório destino, a partir da raiz.
    
    Throws:
    
    RemoteException
  - moveFile
```
void moveFile(Object sourceProjectId,
            String[] filePathSource,
            Object targetProjectId,
            String[] dirPathTarget)
              throws RemoteException
```
    Move um arquivo de um projeto para um diretório de outro projeto.
    
    Parameters:
    sourceProjectId - Identificador do projeto Origem.
    filePathSource - Caminho do arquivo a ser copiado, a partir da raiz.
    targetProjectId - Identificador do projeto Destino.
    dirPathTarget - Caminho do diretório destino, a partir da raiz.
    
    Throws:
    
    RemoteException
  - removeFile
```
void removeFile(Object projectId,
              String[] path)
                throws RemoteException
```
    Remove um arquivo de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo a ser removido, a partir da raiz.
    
    Throws:
    
    RemoteException
  - getUpdatedFileInfo
```
ClientProjectFileInfo getUpdatedFileInfo(Object projectId,
                                       String[] path)
                                         throws RemoteException
```
    Atualiza as informações de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo a ser atualizado, a partir da raiz.
    
    Returns:
    A nova representação do arquivo.
    
    Throws:
    
    RemoteException
  - removeFiles
```
void removeFiles(Object projectId,
               String[][] paths)
                 throws RemoteException
```
    Remove vários arquivos de um projeto.
    
    Parameters:
    projectId - Identificador do projeto.
    paths - Lista de caminhos, a partir da raiz, especificando os arquivos a serem removidos.
    
    Throws:
    
    RemoteException
  - getFileDescription
```
String getFileDescription(Object projectId,
                        String[] path)
                          throws RemoteException
```
    Obtém a descrição atual deste arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    O texto com a descrição do arquivo.
    
    Throws:
    
    RemoteException
  - setFileDescription
```
void setFileDescription(Object projectId,
                      String[] path,
                      String text)
                        throws RemoteException
```
    Muda a descrição atual deste arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    text - O novo texto da descrição do arquivo.
    
    Throws:
    
    RemoteException
  - appendFileDescription
```
void appendFileDescription(Object projectId,
                         String[] path,
                         String text)
                           throws RemoteException
```
    Anexa um texto à descrição atual deste arquivo. Permite a geração de históricos de modificação.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    text - O texto a ser anexado.
    
    Throws:
    
    RemoteException
  - existsFile
```
boolean existsFile(Object projectId,
                 String[] path)
                   throws RemoteException
```
    Verifica se um arquivo existe no servidor.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho para o arquivo, a partir da raiz.
    
    Returns:
    Verdadeiro se o arquivo existe no servidor, falso caso contrário.
    
    Throws:
    
    RemoteException
  - openFileChannel
```
tecgraf.ftc.common.logic.RemoteFileChannelInfo openFileChannel(Object projectId,
                                                             String[] path,
                                                             boolean readOnly)
                                                               throws RemoteException
```
    Abre um arquivo para leitura e escrita.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo a ser aberto, a partir da raiz.
    readOnly - Indica se o arquivo deve ser aberto apenas para leitura ou para leitura e escrita.
    
    Returns:
    O channel que conecta ao arquivo no servidor.
    
    Throws:
    
    RemoteException
  - getProjectLocationInServer
```
String getProjectLocationInServer(Object projectId)
                                  throws RemoteException
```
    Informa onde o diretório do projeto está instalado no servidor.
    
    Parameters:
    projectId - Identificador do projeto.
    
    Returns:
    O caminho canonico do diretório do projeto no servidor.
    
    Throws:
    
    RemoteException
    See Also:
    File.getCanonicalPath()
  - acquireExclusiveLock
```
Object acquireExclusiveLock(Object projectId,
                          String[] path)
                            throws RemoteException
```
    Obtém lock de escrita exclusivo para um arquivo. Locks exclusivos são obtidos apenas uma vez.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Identificador do lock se o lock foi obtido, ou null caso contrário.
    
    Throws:
    
    RemoteException
  - acquireExclusiveLock
```
Object acquireExclusiveLock(Object projectId,
                          String[] path,
                          FileLockListenerInterface listener,
                          long timeout)
                            throws RemoteException
```
    Tenta obter um lock de escrita exclusivo para um arquivo. Locks exclusivos são obtidos apenas uma vez. Este método cadastra uma solicitação de lock numa fila priorizada pela ordem de chegada dos pedidos de lock. Quando o lock é obtido, o método FileLockListenerInterface.fileLocked é chamado. Quando o tempo máximo de espera do lock é atingido e o lock não foi obtido o método FileLockListenerInterface.fileLockExpired é chamado.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    listener - Observador do lock cadastrado.
    timeout - Tempo máximo de espera pelo lock em milisegundos. A constante INFINITE_TIMOUT existe para especificar timeout infinito.
    
    Returns:
    Identificador do pedido de lock.
    
    Throws:
    
    RemoteException
  - acquireSharedLock
```
Object acquireSharedLock(Object projectId,
                       String[] path)
                         throws RemoteException
```
    Obtém lock de escrita compartilhado para um arquivo. Locks compartilhados podem ser obtidos múltiplas vezes; cada novo lock para o arquivo incrementa o contador de referências para o lock. Locks compartilhados só podem ser removidos se o contador de referências for igual a zero.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Identificador do lock se o lock foi obtido, ou null caso contrário.
    
    Throws:
    
    RemoteException
  - acquireSharedLock
```
Object acquireSharedLock(Object projectId,
                       String[] path,
                       FileLockListenerInterface listener,
                       long timeout)
                         throws RemoteException
```
    Tenta obter lock de escrita compartilhado para um arquivo. Locks compartilhados podem ser obtidos múltiplas vezes; cada novo lock para o arquivo incrementa o contador de referências para o lock. Locks compartilhados só podem ser removidos se o contador de referências for igual a zero. Este método cadastra uma solicitação de lock compartilhado em uma fila priorizada pela ordem de chegada dos pedidos de lock. Quando o lock é obtido, o método FileLockListenerInterface.fileLocked é chamado. Quando o tempo máximo de espera do lock é atingido e o lock não foi obtido o método FileLockListenerInterface.fileLockExpired é chamado.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    listener - Observador do lock cadastrado.
    timeout - Tempo máximo de espera pelo lock em milisegundos. A constante INFINITE_TIMOUT existe para especificar timeout infinito.
    
    Returns:
    Identificador do pedido de lock.
    
    Throws:
    
    RemoteException
  - releaseLock
```
int releaseLock(Object projectId,
              String[] path,
              Object lockId)
                throws RemoteException
```
    Libera lock de um arquivo. O lock só é liberado se o identificador for o mesmo do lock obtido. Se o lock é compartilhado, a contagem de referências para o lock é decrementada. Quando o número de referências chega a zero, o lock é efetivamente removido.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    lockId - Identificador do lock.
    
    Returns:
    Contagem de referências para o lock.
    
    Throws:
    
    RemoteException
  - forceReleaseLock
```
int forceReleaseLock(Object projectId,
                   String[] path)
                     throws RemoteException
```
    Força a remoção do lock do arquivo. Só pode ser usado pelo administrador ou pelo usuário dono do projeto, se acontencer alguma situação de ter um lock "preso". Situações onde as sessão do usuário que foi finalizadas por falha na comunicação, ou usuários que terminam o cliente abruptamente já estão previstas e não devem precisar deste mecanismo de segurança.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Contagem de referências para o lock.
    
    Throws:
    
    RemoteException
  - userOwnsLock
```
boolean userOwnsLock(Object projectId,
                   String[] path)
                     throws RemoteException
```
    Verifica se o usuário corrente é o dono do lock de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Verdadeiro se o usuário é o dono do lock, falso caso contrário.
    
    Throws:
    
    RemoteException
  - fileSize
```
long fileSize(Object projectId,
            String[] path)
              throws RemoteException
```
    Retorna o tamanho de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Tamanho do arquivo.
    
    Throws:
    
    RemoteException
  - getModificationDate
```
long getModificationDate(Object projectId,
                       String[] path)
                         throws RemoteException
```
    Retorna a data de modificação de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Returns:
    Data de modificação do arquivo.
    
    Throws:
    
    RemoteException
  - addObserver
```
void addObserver(RemoteObserver observer,
               Object arg)
                 throws RemoteException
```
    Registra um observador interessado nas mudanças que ocorrerem em um projeto.
    
    Specified by:
    
    addObserver in interface RemoteObservable
    
    Parameters:
    observer - O observador remoto que registra o interesse nas mudanças sobre um projeto.
    arg - Identificador do projeto no qual o observador está interessado.
    
    Throws:
    
    RemoteException
  - deleteObserver
```
boolean deleteObserver(RemoteObserver observer,
                     Object arg)
                       throws RemoteException
```
    Remove um observador registrado em um projeto.
    
    Specified by:
    
    deleteObserver in interface RemoteObservable
    
    Parameters:
    observer - O observador remoto a ser removido.
    arg - Identificador do projeto.
    
    Returns:
    Verdadeiro se o observador foi removido, falso caso contrário.
    
    Throws:
    
    RemoteException
  - getAllFileTypes
```
Map<String,ProjectFileTypeInfo> getAllFileTypes(Locale loc)
                                                throws RemoteException
```
    Obtém as propriedades de todos os tipos de arquivos cadastrados.
    
    Parameters:
    loc - O locale para tradução dos termos, quando aplicável.
    
    Returns:
    Map com as propriedades de todos os tipos de arquivos.
    
    Throws:
    
    RemoteException
  - getFileType
```
ProjectFileTypeInfo getFileType(String type)
                                throws RemoteException
```
    Obtem todas as propriedades de um tipo de arquivo.
    
    Parameters:
    type - o tipo do arquivo desejado
    
    Returns:
    informações de um tipo de arquivo
    
    Throws:
    
    RemoteException
  - getMimeType
```
String getMimeType(String type)
                   throws RemoteException
```
    Obtem o mimeType a partir do tipo do arquivo.
    
    Parameters:
    type - O tipo de arquivo.
    
    Returns:
    O mime-type correspondente.
    
    Throws:
    
    RemoteException
  - getLockedProjectAdminInfo
```
ProjectAdminInfo[] getLockedProjectAdminInfo()
                                             throws RemoteException
```
    Obtém as informações de todos os projetos dos usuários.
    
    Returns:
    um array de ProjectAdminInfo.
    
    Throws:
    
    RemoteException
  - isUnlockedWithAreaAllocated
```
boolean isUnlockedWithAreaAllocated(Object projectId)
                                    throws RemoteException
```
    Verifica se um projeto está desbloqueado utilizando área reservada.
    
    Parameters:
    projectId - O identificador do projeto.
    
    Returns:
    verdadeiro, se o projeto está desbloqueado utilizando área reservada ou falso, caso contrário.
    
    Throws:
    
    RemoteException
  - setFileModificationDate
```
void setFileModificationDate(Object projectId,
                           String[] path,
                           long date)
                             throws RemoteException
```
    Muda a data de alteração de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    date - Data, como um long.
    
    Throws:
    
    RemoteException
  - setUnderConstruction
```
void setUnderConstruction(Object projectId,
                        String[] path,
                        boolean underConstruction)
                          throws RemoteException
```
    Altera o estado do arquivo para o valor dado no parâmetro underConstruction.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    underConstruction - Indica se o arquivo deve ficar em construção.
    
    Throws:
    
    RemoteException
  - startUpdate
```
void startUpdate(Object projectId,
               String[] path,
               long interval,
               boolean notification)
                 throws RemoteException
```
    Inicia ou altera o intervalo de atualização de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    interval - O intervalo (em segundos) de atualização do arquivo.
    notification - Indica se o usuário deseja ou não receber notificações.
    
    Throws:
    
    RemoteException
  - startUpdate
```
void startUpdate(Object projectId,
               String[] path,
               long interval,
               boolean notification,
               Serializable extraInfo)
                 throws RemoteException
```
    Inicia ou altera o intervalo de atualização de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    interval - O intervalo (em segundos) de atualização do arquivo.
    notification - Indica se o usuário deseja ou não receber notificações.
    extraInfo - informações extras para parametrizar a atualização
    
    Throws:
    
    RemoteException
  - stopUpdate
```
void stopUpdate(Object projectId,
              String[] path)
                throws RemoteException
```
    Pára a atualização de um arquivo.
    
    Parameters:
    projectId - Identificador do projeto.
    path - Caminho do arquivo, a partir da raiz.
    
    Throws:
    
    RemoteException
  - getAllFileInfoSearchResult
```
List<FileInfoSearchResult> getAllFileInfoSearchResult(Object projectId,
                                                    String text,
                                                    boolean isCaseInsensitive,
                                                    boolean isRegex)
                                                      throws RemoteException
```
    Obtém a lista de resultados de uma busca de arquivos em um projeto, de acordo com as condições solicitadas (nome do arquivo, se deve ignorar maíusculas/minúsculas, se usa ou não uma expressão regular).
    
    Parameters:
    projectId - O identificador do projeto.
    text - - Texto sendo pesquisado.
    isCaseInsensitive - - Considerar maiúsculas/minúsculas.
    isRegex - - Indica que o texto é uma expressão regular.
    
    Returns:
    Lista com as informações sobre todos arquivos encontrados. Caso nenhum arquivo tenha sido encontrado, retorna uma lista vazia.
    
    Throws:
    
    RemoteException
  - getManageableProjectsId
```
Set<Object> getManageableProjectsId()
                                    throws RemoteException
```
    Obtém um conjunto com o identificador de todos os projetos gerenciáveis pelo usuário corrente.
    No caso de um usuário comum isso representa todos os projetos daquele usuário, diferente do administrador que pode gerenciar todos os projetos.
    
    Returns:
    Um conjunto com o identificador de todos os projetos gerenciáveis pelo usuário corrente. Caso o usuário não tenha acesso a nenhum projeto, o conjunto terá tamanho zero.
    
    Throws:
    
    RemoteException
  - setUnallocatedProjectAsLocked
```
void setUnallocatedProjectAsLocked(Object projectId,
                                 int areaSize)
                                   throws RemoteException
```
    Converte um projeto sem alocação de área em um projeto que aguarda alocação.
    
    Parameters:
    projectId - Identificador do projeto.
    areaSize - Tamanho (em Gb) da área a ser alocada ao projeto.
    
    Throws:
    
    RemoteException - Exceção no acesso remoto aos dados.
  - setAllocatedProjectAsUnallocated
```
void setAllocatedProjectAsUnallocated(Object projectId)
                                      throws RemoteException
```
    Converte um projeto com alocação de área em um projeto sem alocação. OBS. Este método foi criado para atender uma necessidade específica. Deve ser usado com a mesma cautela exigida pelo método freeAreaForProjects() (ambos descartam informações administrativas).
    
    Parameters:
    projectId - Identificador do projeto.
    
    Throws:
    
    RemoteException - Exceção no acesso remoto aos dados.
  - setUnallocatedProjectAsAllocated
```
void setUnallocatedProjectAsAllocated(Object projectId,
                                    int areaSize)
                                      throws RemoteException
```
    Converte um projeto sem alocação de área em um projeto com alocação. OBS. Este método foi criado para atender uma necessidade específica e deve ser usado com cautela.
    
    Parameters:
    projectId - Identificador do projeto.
    areaSize - Tamanho (em Gb) da área a ser alocada ao projeto.
    
    Throws:
    
    RemoteException - Exceção no acesso remoto aos dados.
  - getProjectAdminInfo
```
ProjectAdminInfo getProjectAdminInfo(Object projectId)
                                     throws RemoteException
```
    Obtém as informações administrativas de um projeto de um usuário.
    
    Parameters:
    projectId - Identificador do projeto.
    
    Returns:
    O ProjectAdminInfo do projeto de um usuário ou nulo caso o projeto não esteja bloqueado.
    
    Throws:
    
    RemoteException - Exceção no acesso remoto aos dados.
  - isAreaReserved
```
boolean isAreaReserved()
                       throws RemoteException
```
    Indica se o serviço de projetos utiliza reserva de área.
    
    Returns:
    Boolean que indica se o serviço de projetos utiliza reserva de área.
    
    Throws:
    
    RemoteException - Exceção no acesso remoto aos dados.
  - getOptimizationMode
```
ClientOptimizationMode getOptimizationMode()
                                           throws RemoteException
```
    Returns:
    O modo de otimização que foi definido neste serviço.
    
    Throws:
    
    RemoteException
  - getLocalProjectPath
```
String getLocalProjectPath()
                           throws RemoteException
```
    Returns:
    O path de acesso local no cliente para a pasta de projetos. É utilizada quando o Modo de Otimização estiver definido como ClientOptimizationMode.GLOBAL
    
    Throws:
    
    RemoteException

Interface ProjectServiceInterface

Field Summary

Method Summary

Methods inherited from interface csbase.remote.ServiceInterface

Methods inherited from interface csbase.remote.RemoteObservable

Field Detail

SERVICE_NAME

CURRENT_PROJECT_SESSION_PROPERTY

INFINITE_TIMEOUT

Method Detail

userHasHisOwnProjects

userCanWrite

userCanWrite

getProjectsFromUser

getProjectsSharedWithUser

userParticipatesOnSharedProjects

updateUsers

removeUser

removeUsers

removeUserProjects

openProject

createProject

createProjectWithAllocation

unlockProjectsWithAllocation

freeAreaForProjects

modifyProject

removeProject

closeProject

existsProject

rebuildTree

refreshTree

rebuildDir

refreshDir

createDirectory

getChildren

getChildren

getChild

getChild

createFile

createFiles

renameFile

changeFileType

copyFile

copyFile

moveFile

moveFile

removeFile

getUpdatedFileInfo

removeFiles

getFileDescription

setFileDescription

appendFileDescription

existsFile

openFileChannel

getProjectLocationInServer

acquireExclusiveLock

acquireExclusiveLock

acquireSharedLock

acquireSharedLock

releaseLock

forceReleaseLock

userOwnsLock

fileSize

getModificationDate

addObserver

deleteObserver

getAllFileTypes

getFileType

getMimeType

getLockedProjectAdminInfo

isUnlockedWithAreaAllocated

setFileModificationDate

setUnderConstruction

startUpdate

startUpdate

stopUpdate

getAllFileInfoSearchResult

getManageableProjectsId

setUnallocatedProjectAsLocked

setAllocatedProjectAsUnallocated