|
<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug ExternalDocument > CreateFolderByParentFolderPath |
Crea una cartella in una destinazione individuata tramite configurazione e percorso della cartella padre, con composizione opzionale del nome nella Configurazione di JamioPlug ExternalDocument.
Metodo
PlugExternalDocument/CreateFolderByParentFolderPath
Input |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
token |
Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto). |
String |
Y |
folderName |
Nome base della cartella. |
String |
|
configurationReference |
Collegamento alla risorsa di tipo configurazione del Plug ExternalDocument che determina la root operativa. E' possibile specificare un collegamento in cui è valorizzata solo la proprietà Name con il Nickname di una configurazione esistente. |
Reference |
|
folderPath |
Percorso relativo della cartella padre. Il carattere "/" deve essere utilizzato come separatore tra i nodi della gerarchia. |
String |
Y |
separator |
Separatore utilizzato nella composizione. Non può essere il carattere "/" né un carattere non ammesso. |
String |
Y |
insertCounter |
True se deve essere inserito un contatore nel nome. |
Boolean |
|
auto |
Se true, il metodo determina il progressivo successivo. Ignorato se insertCounter è False. |
Boolean |
|
digitNumber |
Numero di digit del contatore. Ignorato se insertCounter è False |
Integer |
Y |
counter |
Progressivo manuale. Ignorato se insertCounter è False. |
Integer |
Y |
counterPosition |
Posizione del counter, assume i valori: •0 = PrePrefix •1 = PostPrefix •2 = PreSuffix •3 = PostSuffix. Necessario quando il counter viene inserito. |
Integer |
Condizionale |
prefix |
Prefisso opzionale. |
String |
Y |
suffix |
Suffisso opzionale. |
String |
Y |
Output |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
returnValue |
Dato strutturato che contiene i seguenti campi: WebUrl: testo che riporta l'URL della cartella creata o esistente. FolderReference: collegamento alla cartella. FolderAlreadyExists: booleano che assume il valore True se la cartella finale esisteva già e non è stata creata. |
DataSet |
|
Commenti
Se il parametro folderPath non è valorizzato, la root operativa viene considerata la destinazione. Con folderPath valorizzato la destinazione è configurationRoot/ folderPath.
Se non sono applicati valori ai parametri prefix, suffix o counter, viene utilizzato folderName.
Se i parametri prefix e suffix sono valorizzati e insertCounter è False, il nome viene composto applicando i valori definiti in prefix, folderName e suffix.
Se i parametri insertCounter è True, auto è False e counter è valorizzato, il counter viene inserito nella posizione definita in counterPosition e digitNumber viene applicato se valorizzato.
Se i parametri insertCounter e auto sono True, viene creato il progressivo successivo rispetto al massimo esistente, oppure 1 in assenza di progressivi.
Il separatore viene applicato esclusivamente tra componenti effettivamente presenti e non può essere il carattere "/" né un carattere non ammesso.
Con counter automatico viene individuato il massimo progressivo esistente secondo il pattern e utilizzato il successivo; in assenza di progressivi esistenti il counter parte da 1.
Il parametro digitNumber, se valorizzato, applica padding al counter. Se il progressivo supera la capacità indicata in digitNumber, viene restituito un errore specifico.
Il metodo non applica metadati. Il nome finale viene normalizzato secondo le regole Jamio.
Il metodo si comporta come segue:
Restituisce |
Condizione |
FolderAlreadyExists False |
Se i parametri prefix, suffix e counter non sono applicati e la cartella non esiste. |
FolderAlreadyExists True e valorizza FolderReference e WebUrl |
Se il nome finale identifica una cartella esistente (la cartella non viene ricreata). |
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla Configurazione del Plug ExternalDocument.