Documentale |
- Description:
- Documentale service
|
Operation Summary
|
Returns |
Method |
List<DataSourceLibraryFDT>
|
getDataSourceLibraryNames()
Estrae la lista delle librerie che sono registrate tramite il metodo getDataSourceLibraryNames
|
DataSourceLibraryFDT
|
getDataSourceLibrary(String library)
Questo metodo permette di avere a disposizione la struttura dello strato fisico relativo ad una particolare libreria
|
List<PropertyFDT>
|
getLibraryProperties(String library)
|
List<CustomObjectClassFDT>
|
getCustomObjectClasses(String library)
Questo metodo permette di reperire la collezione di CustomObject mappate nel file di configurazione .xml delle classi custom
|
CustomObjectClassFDT
|
getCustomObjectClass(String library, String classId)
Questo metodo permette di estrarre una CustomObject particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
|
List<DocumentClassFDT>
|
getDocumentClasses(String library)
Questo metodo permette di reperire la collezione di DocumentClass mappate nel file di configurazione .xml delle classi documentali
|
DocumentClassFDT
|
getDocumentClass(String library, String classId)
Questo metodo permette di estrarre una DocumentClass particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
|
DocumentFDT
|
getDocumentDraft(String library, String classId)
Questo metodo restituisce la bozza di un documento ovvero il documento non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
|
DocumentFDT
|
getDocument(String library, String documentId)
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
|
DocumentFDT
|
getDocumentEx(String library, String documentId, GetDocumentLoadOptionsFDT loadOptions)
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
|
VersionFDT
|
getDocumentVersion(String library, String documentId, Integer versionNumber)
Con questo metodo e' possibile estrarre i dati di una versione
|
byte[]
|
getDocumentContent(String library, String documentId, Integer versionNumber, Boolean checkOut)
Con questo metodo e' possibile estrarre il contenuto relativo ad una particolare versione di un documento esistente
|
void
|
setDocumentContent(String library, String documentId, Integer versionNumber, byte[] content, String fileName, String checkInOperation)
Con questo metodo e' possibile aggiornare il contenuto relativo ad una particolare versione di un documento esistente
|
List<DocumentFDT>
|
listDocuments(String library, String folderId)
|
List<StorageObjectFDT>
|
listDocumentNames(String library, String folderId)
|
String
|
saveDocument(String library, DocumentFDT document, Integer versionNumber, String targetFolderId)
Questo metodo permette il salvataggio dei dati di un nuovo documento o l'aggiornamento dei dati di un documento esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
|
String
|
createDocument(String library, String classId, List<PropertyFDT> properties, byte[] content, String fileName, String targetFolderId)
Creazione di un nuovo documento senza richiedere a priori la bozza.
|
Integer
|
saveDocumentVersion(String library, String documentId, Integer versionNumber, List<PropertyFDT> properties, byte[] content, String fileName)
Creazione o aggiornamento dei dati di una versione.
|
void
|
deleteDocument(String library, String documentId, Integer versionNumber)
Con questo metodo e' possibile eliminare un documento o una versione esistente. Pertanto tutti gli oggetti collegati saranno eliminati. Se 'versionNumber' vale NULL o 0 verra' eliminata ogni versione del documento con le relative immagini; in caso contrario verranno eliminati i dati della singola versione
|
List<FolderClassFDT>
|
getFolderClasses(String library)
Questo metodo permette di reperire la collezione di DocumentClass mappate nel file di configurazione .xml delle classi documentali
|
FolderClassFDT
|
getFolderClass(String library, String classId)
Questo metodo permette di estrarre una FolderClass particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
|
FolderFDT
|
getFolderDraft(String library, String classId)
Questo metodo restituisce la bozza di un documento ovvero il documento non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
|
FolderFDT
|
getFolder(String library, String folderId)
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
|
List<FolderFDT>
|
listFolders(String library, String folderId, Boolean recourseSubDir)
|
List<StorageObjectFDT>
|
listFolderNames(String library, String folderId, Boolean recourseSubDir)
|
String
|
saveFolder(String library, FolderFDT folder, String targetFolderId)
Questo metodo permette il salvataggio dei dati di un nuovo folder o l'aggiornamento dei dati di un folder esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
|
String
|
createFolder(String library, String classId, List<PropertyFDT> properties, String targetFolderId, List<SecurityFDT> securities)
Creazione di un nuovo folder senza richiedere a priori la bozza
|
void
|
deleteFolder(String library, String folderId)
Con questo metodo e' possibile eliminare un folder esistente. Pertanto tutti gli oggetti collegati al folder saranno eliminati
|
FolderFDT
|
getParentFolder(String library, String objectType, String objectId, Integer objectVersion)
|
void
|
moveToFolder(String library, String objectType, String objectId, Integer objectVersion, String fromFolderId, String toFolderId)
Sposta, elimina o inserisce un documento o folder. Se 'fromFolderId' e' diverso da NULL l'oggetto viene rimosso dal folder proprietario. Se 'toFolderId' e' diverso da NULL l'oggetto viene inserito nel nuovo folder.
|
UserFDT
|
getUser(String library)
Restituisce i dati relativi all'utente loggato
|
void
|
setDocumentSecurities(String library, String documentId, List<SecurityFDT> securities)
Definisce i criteri di sicurezza per il documento
|
List<SecurityFDT>
|
getDocumentSecurities(String library, String documentId)
Restituisce i criteri di sicurezza applicati al documento
|
void
|
setFolderSecurities(String library, String folderId, List<SecurityFDT> securities)
Definisce i criteri di sicurezza per il folder
|
List<SecurityFDT>
|
getFolderSecurities(String library, String folderId)
Restituisce i criteri di sicurezza applicati al folder
|
CustomObjectFDT
|
getCustomObjectDraft(String library, String classId)
Questo metodo restituisce la bozza di un customObject ovvero l'oggetto non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
|
CustomObjectFDT
|
getCustomObject(String library, String classId, String customObjectId)
Con questo metodo e' possibile ottenere i dati di un CustomObject
|
String
|
saveCustomObject(String library, CustomObjectFDT customObject)
Questo metodo permette il salvataggio dei dati di un nuovo customObject o l'aggiornamento dei dati di un customObject esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
|
void
|
deleteCustomObject(String library, String classId, String customObjectId)
Con questo metodo e' possibile eliminare un CustomObject
|
SearchResultFDT
|
lookupByName(String library, String lookupName)
Con questo metodo e' possibile eseguire una ricerca personalizzata sul documentale
|
List<SearchDefinitionFDT>
|
getSearches(String library)
Con questo metodo e' possibile estrarre l'elenco delle ricerche salvate relative ad un utente.
|
SearchDefinitionFDT
|
getSearch(String library, String searchDefinitionId)
Con questo metodo e' possibile estrarre i dati di una ricerca salvata
|
SearchResultFDT
|
executeSearch(String library, String searchDefinitionId, Integer page)
|
SearchResultFDT
|
executeCustomSearch(String library, SearchDefinitionFDT searchDefinition, Integer page)
Con questo metodo e' possibile eseguire una ricerca personalizzata sul documentale
|
SearchDefinitionFDT
|
saveSearch(String library, SearchDefinitionFDT searchDefinition)
Attraverso questo metodo e' possibile creare e memorizzare (in modo privato) le informazioni relative ad una ricerca
|
void
|
deleteSearch(String library, String searchDefinitionId)
Metodo che consente l'eliminazione di una ricerca
|
void
|
changeClass(String library, String objectId, String objectType, String classId, boolean copyProperties)
Questo metodo permette di effettuare il cambio di classe di documenti/folder
|
void
|
undoCheckOut(String library, String documentId)
Operazione per l'annullamento di una operazione di checkout
|
UserFDT
|
getCheckedOutBy(String library, String documentId)
Richiesta delle informazioni sull'utente che ha effettuato un checkout del documento. Quando il valore restituito vale NULL nessuna operazione di checkout e' stata effettuata sul documento in esame.
|
void
|
markAsOnline(String library, String objectId, String objectType)
|
void
|
markAsDeleted(String library, String objectId, String objectType)
|
CheckInTypeEnumFDT
|
enumCheckInType()
Enumerazione che definisce la tipologia di checkIn da effettuare.
|
ContaineeTypeEnumFDT
|
enumConteineeType()
Enumerazione che definisce la tipologia di oggetti da estrarre da DPA.
|
ObjectTypeEnumFDT
|
enumObjectType()
Enumerazione che definisce il tipo di oggetto in esame, se Document, Folder o CustomObject.
|
Integer
|
getDocumentCount(String library, String folderId, String loadOption)
|
Integer
|
getFolderCount(String library, String folderId, String loadOption)
|
Integer
|
getChildrenCount(String library, String folderId, String containeeType, String loadOption)
Questo metodo permette di estrarre il numero dei figli di un fascicolo in base ai parametri containeeType e loadOptions
|
List<StorageObjectFDT>
|
getChildren(String library, String folderId, String containeeType)
Questo metodo permette di estrarre i figli di un particolare folder.
|
List<StorageObjectFDT>
|
getChildrenEx(String library, String folderId, String containeeType, GetDocumentLoadOptionsFDT documentLoadOption, GetFolderLoadOptionsFDT folderLoadOption)
Questo medoto permette di estrarre i figli di un particolare folder ed inoltre permette di specificare cosa estrarre per categoria di figli (documenti o folder).
|
Operation Detail
|
getDataSourceLibraryNames
-
public List<DataSourceLibraryFDT> getDataSourceLibraryNames()
-
Estrae la lista delle librerie che sono registrate tramite il metodo getDataSourceLibraryNames
-
Parameters:
- Nothing
-
Returns:
- List<DataSourceLibraryFDT> - Lista delle librerie registrate in DPA
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDataSourceLibrary
-
public DataSourceLibraryFDT getDataSourceLibrary()
-
Questo metodo permette di avere a disposizione la struttura dello strato fisico relativo ad una particolare libreria
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- DataSourceLibraryFDT - Istanza della libreria
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getLibraryProperties
-
public List<PropertyFDT> getLibraryProperties()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- List<PropertyFDT> - Lista delle proprietà della libreria
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getCustomObjectClasses
-
public List<CustomObjectClassFDT> getCustomObjectClasses()
-
Questo metodo permette di reperire la collezione di CustomObject mappate nel file di configurazione .xml delle classi custom
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- List<CustomObjectClassFDT> - Lista delle classi CustomObject relative alla libreria
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getCustomObjectClass
-
public CustomObjectClassFDT getCustomObjectClass()
-
Questo metodo permette di estrarre una CustomObject particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Guid della DocumentClass da estrarre
-
Returns:
- CustomObjectClassFDT - Istanza dell'oggetto richiesto
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentClasses
-
public List<DocumentClassFDT> getDocumentClasses()
-
Questo metodo permette di reperire la collezione di DocumentClass mappate nel file di configurazione .xml delle classi documentali
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- List<DocumentClassFDT> - Lista delle classi Document relative alla libreria
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentClass
-
public DocumentClassFDT getDocumentClass()
-
Questo metodo permette di estrarre una DocumentClass particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Guid della DocumentClass da estrarre
-
Returns:
- DocumentClassFDT - Istanza dell'oggetto DocumentClass
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentDraft
-
public DocumentFDT getDocumentDraft()
-
Questo metodo restituisce la bozza di un documento ovvero il documento non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Identificativo univoco documentale.
-
Returns:
- DocumentFDT - Istanza dell'oggetto Document
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocument
-
public DocumentFDT getDocument()
-
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
-
Returns:
- DocumentFDT - Istanza dell'oggetto Document
-
Throws:
- ObjectNotFoundException
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentEx
-
public DocumentFDT getDocumentEx()
-
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
- GetDocumentLoadOptionsFDT loadOptions - Informazione sulle parti del documento da estrarre
-
Returns:
- DocumentFDT - Istanza dell'oggetto Document
-
Throws:
- ObjectNotFoundException
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentVersion
-
public VersionFDT getDocumentVersion()
-
Con questo metodo e' possibile estrarre i dati di una versione
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
- Integer versionNumber - Numero di versione
-
Returns:
- VersionFDT - Dati relativi alla versione del documento
-
Throws:
- ObjectNotFoundException
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentContent
-
public byte[] getDocumentContent()
-
Con questo metodo e' possibile estrarre il contenuto relativo ad una particolare versione di un documento esistente
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
- Integer versionNumber - Identificativo del numero di versione del Document da cui estrarre il content
- Boolean checkOut - Marcatura del documento in stato di checkout. Se NULL nessuna marcatura viene effettuata.
-
Returns:
- byte[] - Array di byte dell’immagine legata alla versione specificata del documento.
-
Throws:
- ObjectNotFoundException
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
setDocumentContent
-
public void setDocumentContent()
-
Con questo metodo e' possibile aggiornare il contenuto relativo ad una particolare versione di un documento esistente
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
- Integer versionNumber - Identificativo del numero di versione del Document da cui estrarre il content
- byte[] content - Contenuto del file del documento
- String fileName - Indica il nome del file del documento
- String checkInOperation - Operazione di checkin da effettuare. Se NULL nessuna operazione di checkin viene effettuata.
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listDocuments
-
public List<DocumentFDT> listDocuments()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
-
Returns:
- List<DocumentFDT> - Lista di documenti (con relativi dati)
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listDocumentNames
-
public List<StorageObjectFDT> listDocumentNames()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
-
Returns:
- List<StorageObjectFDT> - Lista dei documenti (nomi e tipologie)
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
saveDocument
-
public String saveDocument()
-
Questo metodo permette il salvataggio dei dati di un nuovo documento o l'aggiornamento dei dati di un documento esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- DocumentFDT document - Dati del documento
- Integer versionNumber - Numero di versione: se NULL o 0 viene aggiunta una nuova versione; in caso contrario vengono aggiornati i dati della versione indicata. Per i nuovi documenti questo valore viene sempre ignorato. Si ricorda che una versione verra creata o aggiornata solamente se content != NULL.
- String targetFolderId - Indica il folder nel quale inserire il documento
-
Returns:
- String - ID del documento.
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
createDocument
-
public String createDocument()
-
Creazione di un nuovo documento senza richiedere a priori la bozza.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Classe del documento
- List<PropertyFDT> properties - Proprieta' del documento e della versione
- byte[] content - Contenuto del file del documento. Una versione con il file viene creatao aggiornata solamente se questo valore e' diverso da NULL.
- String fileName - Indica il nome del file del documento
- String targetFolderId - Indica il folder nel quale inserire il documento
-
Returns:
- String - ID del documento.
-
Throws:
- TechnicalErrorException
- IllegalParameterException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
saveDocumentVersion
-
public Integer saveDocumentVersion()
-
Creazione o aggiornamento dei dati di una versione.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Classe del documento
- Integer versionNumber - Numero di versione: se in diverso da NULL viene effettuato l'aggiornamento dei dati, in caso contrario viene creata una nuova versione.
- List<PropertyFDT> properties - Proprieta' del documento
- byte[] content - Contenuto del file del documento
- String fileName - Indica il nome del file del documento
-
Returns:
- Integer - Numero di versione.
-
Throws:
- TechnicalErrorException
- IllegalParameterException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
deleteDocument
-
public void deleteDocument()
-
Con questo metodo e' possibile eliminare un documento o una versione esistente. Pertanto tutti gli oggetti collegati saranno eliminati. Se 'versionNumber' vale NULL o 0 verra' eliminata ogni versione del documento con le relative immagini; in caso contrario verranno eliminati i dati della singola versione
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
- Integer versionNumber - Numero di versione del documento
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolderClasses
-
public List<FolderClassFDT> getFolderClasses()
-
Questo metodo permette di reperire la collezione di DocumentClass mappate nel file di configurazione .xml delle classi documentali
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- List<FolderClassFDT> - Lista delle FolderClass registrate nel sistema
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolderClass
-
public FolderClassFDT getFolderClass()
-
Questo metodo permette di estrarre una FolderClass particolare identificata grazie al suo classId che, essendo di tipo Guid, e' univoco in tutto il sistema
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Guid della FolderClass da estrarre
-
Returns:
- FolderClassFDT - Istanza dell'oggetto FolderClass
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolderDraft
-
public FolderFDT getFolderDraft()
-
Questo metodo restituisce la bozza di un documento ovvero il documento non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Identificativo univoco documentale.
-
Returns:
- FolderFDT - Istanza dell'oggetto Folder
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolder
-
public FolderFDT getFolder()
-
Questo metodo permette di estrarre dal sistema il documento che fa riferimento al parametro documentId passato in ingresso
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
-
Returns:
- FolderFDT - Istanza dell'oggetto Folder
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listFolders
-
public List<FolderFDT> listFolders()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- Boolean recourseSubDir - Indica se estrarre l'elenco dei folder in modo ricorsivo
-
Returns:
- List<FolderFDT> - Lista di folders (con relativi dati)
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
listFolderNames
-
public List<StorageObjectFDT> listFolderNames()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- Boolean recourseSubDir - Indica se estrarre l'elenco dei folder in modo ricorsivo
-
Returns:
- List<StorageObjectFDT> - Lista di documenti (nome e tipologia)
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
saveFolder
-
public String saveFolder()
-
Questo metodo permette il salvataggio dei dati di un nuovo folder o l'aggiornamento dei dati di un folder esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- FolderFDT folder - Dati del documento
- String targetFolderId - Indica il folder nel quale inserire il nuovo elemento
-
Returns:
- String - ID del folder.
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
createFolder
-
public String createFolder()
-
Creazione di un nuovo folder senza richiedere a priori la bozza
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId - Classe del documento
- List<PropertyFDT> properties - Proprieta' del documento
- String targetFolderId - Indica il folder nel quale inserire il documento
- List<SecurityFDT> securities - Diritti di accesso alla cartella. Se null vengono ignorati
-
Returns:
- String - ID del folder.
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
deleteFolder
-
public void deleteFolder()
-
Con questo metodo e' possibile eliminare un folder esistente. Pertanto tutti gli oggetti collegati al folder saranno eliminati
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getParentFolder
-
public FolderFDT getParentFolder()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String objectType - Tipo dell'oggetto da gestire. Si veda ObjectTypeEnumFDT
- String objectId - Identificativo univoco dell'oggetto da gestire
- Integer objectVersion - Numero di versione dell'oggetto da gestire
-
Returns:
- FolderFDT - Il folder padre dell'oggetto in questione
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
moveToFolder
-
public void moveToFolder()
-
Sposta, elimina o inserisce un documento o folder. Se 'fromFolderId' e' diverso da NULL l'oggetto viene rimosso dal folder proprietario. Se 'toFolderId' e' diverso da NULL l'oggetto viene inserito nel nuovo folder.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String objectType - Tipo dell'oggetto da gestire. Si veda ObjectTypeEnumFDT
- String objectId - Identificativo univoco dell'oggetto da gestire
- Integer objectVersion - Numero di versione dell'oggetto da gestire
- String fromFolderId - Identificativo univoco del folder dal quale slegare l'oggetto
- String toFolderId - Identificativo univoco del folder dove trasferire l'oggetto
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getUser
-
public UserFDT getUser()
-
Restituisce i dati relativi all'utente loggato
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- UserFDT - Dati utente collegato
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
setDocumentSecurities
-
public void setDocumentSecurities()
-
Definisce i criteri di sicurezza per il documento
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco dell'oggetto al quale applicare le securities
- List<SecurityFDT> securities -
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentSecurities
-
public List<SecurityFDT> getDocumentSecurities()
-
Restituisce i criteri di sicurezza applicati al documento
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco dell'oggetto al quale applicare le securities
-
Returns:
- List<SecurityFDT> - Lista delle collection di Security relative al documento con Id specificato
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
setFolderSecurities
-
public void setFolderSecurities()
-
Definisce i criteri di sicurezza per il folder
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco dell'oggetto al quale applicare le securities
- List<SecurityFDT> securities -
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolderSecurities
-
public List<SecurityFDT> getFolderSecurities()
-
Restituisce i criteri di sicurezza applicati al folder
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco dell'oggetto al quale applicare le securities
-
Returns:
- List<SecurityFDT> - Lista delle collection di Security relative al folder con Id specificato
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getCustomObjectDraft
-
public CustomObjectFDT getCustomObjectDraft()
-
Questo metodo restituisce la bozza di un customObject ovvero l'oggetto non e' ancora registrato nella libreria ma deve essere compilato in tutti i sui campi obbligatori per poi essere salvato.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId -
-
Returns:
- CustomObjectFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getCustomObject
-
public CustomObjectFDT getCustomObject()
-
Con questo metodo e' possibile ottenere i dati di un CustomObject
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId -
- String customObjectId -
-
Returns:
- CustomObjectFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
saveCustomObject
-
public String saveCustomObject()
-
Questo metodo permette il salvataggio dei dati di un nuovo customObject o l'aggiornamento dei dati di un customObject esistente, a seconda del fatto che l'id sia NULL (primo caso) o diverso da NULL (secondo caso).
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- CustomObjectFDT customObject - Dati del customObject
-
Returns:
- String -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
deleteCustomObject
-
public void deleteCustomObject()
-
Con questo metodo e' possibile eliminare un CustomObject
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String classId -
- String customObjectId -
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
lookupByName
-
public SearchResultFDT lookupByName()
-
Con questo metodo e' possibile eseguire una ricerca personalizzata sul documentale
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String lookupName - Id della tabella di lookup
-
Returns:
- SearchResultFDT -
-
Throws:
- TechnicalErrorException
- ObjectNotFoundException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getSearches
-
public List<SearchDefinitionFDT> getSearches()
-
Con questo metodo e' possibile estrarre l'elenco delle ricerche salvate relative ad un utente.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
-
Returns:
- List<SearchDefinitionFDT> -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getSearch
-
public SearchDefinitionFDT getSearch()
-
Con questo metodo e' possibile estrarre i dati di una ricerca salvata
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String searchDefinitionId - Identificativo dell'oggetto SearchDefinition
-
Returns:
- SearchDefinitionFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
executeSearch
-
public SearchResultFDT executeSearch()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String searchDefinitionId - Identificativo dell'oggetto SearchDefinition
- Integer page - Numero di pagina da estrarre. Se valorizzato a 0 (zero) la paginazione viene ignorata
-
Returns:
- SearchResultFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
executeCustomSearch
-
public SearchResultFDT executeCustomSearch()
-
Con questo metodo e' possibile eseguire una ricerca personalizzata sul documentale
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- SearchDefinitionFDT searchDefinition - Oggetto SearchDefinition con i valori della ricerca
- Integer page - Numero di pagina da estrarre. Se valorizzato a 0 (zero) la paginazione viene ignorata
-
Returns:
- SearchResultFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
saveSearch
-
public SearchDefinitionFDT saveSearch()
-
Attraverso questo metodo e' possibile creare e memorizzare (in modo privato) le informazioni relative ad una ricerca
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- SearchDefinitionFDT searchDefinition - Dati della ricerca
-
Returns:
- SearchDefinitionFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
deleteSearch
-
public void deleteSearch()
-
Metodo che consente l'eliminazione di una ricerca
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String searchDefinitionId - Id della ricerca da eliminare
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
changeClass
-
public void changeClass()
-
Questo metodo permette di effettuare il cambio di classe di documenti/folder
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String objectId - Id del documento o folder da elaborare
- String objectType - Tipo dell'oggetto da elaborare: FOLDER o DOCUMENT
- String classId - Indica la classe nella quale si vuole convertire l'oggetto
- boolean copyProperties - Indica se e' necessario copiare i valori delle properties dalla classe sorgente alla classe di destinazione, relativamente alle proprieta' comuni
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
- IllegalParameterException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
undoCheckOut
-
public void undoCheckOut()
-
Operazione per l'annullamento di una operazione di checkout
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getCheckedOutBy
-
public UserFDT getCheckedOutBy()
-
Richiesta delle informazioni sull'utente che ha effettuato un checkout del documento. Quando il valore restituito vale NULL nessuna operazione di checkout e' stata effettuata sul documento in esame.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String documentId - Identificativo univoco del documento
-
Returns:
- UserFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
markAsOnline
-
public void markAsOnline()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String objectId - Identificativo univoco del documento/folder
- String objectType - Tipo oggetto: document o folder
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
- IllegalParameterException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
markAsDeleted
-
public void markAsDeleted()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String objectId - Identificativo univoco del documento/folder
- String objectType - Tipo oggetto: document o folder
-
Returns:
- Nothing
-
Throws:
- TechnicalErrorException
- IllegalParameterException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
enumCheckInType
-
public CheckInTypeEnumFDT enumCheckInType()
-
Enumerazione che definisce la tipologia di checkIn da effettuare.
-
Parameters:
- Nothing
-
Returns:
- CheckInTypeEnumFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
enumConteineeType
-
public ContaineeTypeEnumFDT enumConteineeType()
-
Enumerazione che definisce la tipologia di oggetti da estrarre da DPA.
-
Parameters:
- Nothing
-
Returns:
- ContaineeTypeEnumFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
enumObjectType
-
public ObjectTypeEnumFDT enumObjectType()
-
Enumerazione che definisce il tipo di oggetto in esame, se Document, Folder o CustomObject.
-
Parameters:
- Nothing
-
Returns:
- ObjectTypeEnumFDT -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getDocumentCount
-
public Integer getDocumentCount()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- String loadOption - Stato dei documenti da elencare (si veda StorageTypeLoadOptionEnumFDT)
-
Returns:
- Integer -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getFolderCount
-
public Integer getFolderCount()
-
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- String loadOption - Stato delle cartelle da elencare (si veda StorageTypeLoadOptionEnumFDT)
-
Returns:
- Integer -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getChildrenCount
-
public Integer getChildrenCount()
-
Questo metodo permette di estrarre il numero dei figli di un fascicolo in base ai parametri containeeType e loadOptions
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- String containeeType - Tipologia figli da elencare (si veda ContaineeTypeEnumFDT)
- String loadOption - Stato dei figli da elencare (si veda StorageTypeLoadOptionEnumFDT)
-
Returns:
- Integer -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getChildren
-
public List<StorageObjectFDT> getChildren()
-
Questo metodo permette di estrarre i figli di un particolare folder.
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- String containeeType - Tipologia figli da elencare (si veda ContaineeTypeEnumFDT)
-
Returns:
- List<StorageObjectFDT> -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|
getChildrenEx
-
public List<StorageObjectFDT> getChildrenEx()
-
Questo medoto permette di estrarre i figli di un particolare folder ed inoltre permette di specificare cosa estrarre per categoria di figli (documenti o folder).
-
Parameters:
- String library - Codice della libreria che si intente utilizzare
- String folderId - Identificativo univoco del folder
- String containeeType - Tipologia figli da elencare (si veda ContaineeTypeEnumFDT)
- GetDocumentLoadOptionsFDT documentLoadOption - Indica cosa estrarre per i figli di tipo Document
- GetFolderLoadOptionsFDT folderLoadOption - Indica cosa estrarre per i figli di tipo Folder
-
Returns:
- List<StorageObjectFDT> -
-
Throws:
- TechnicalErrorException
-
Associated Role:
- Nothing
-
Other features:
- Transactional Type: REQUIRED
|