Module doc | |||||||||||||||
Name: | doc | ||||||||||||||
Title: | Gestor de documents | ||||||||||||||
Namespace: | http://doc.matrix.org/ | ||||||||||||||
Service: | DocumentManagerService | ||||||||||||||
Port: | DocumentManagerPort | ||||||||||||||
Java package: | org.matrix.doc | ||||||||||||||
Version: | 1.0 | ||||||||||||||
Status: | FINAL | ||||||||||||||
Authors: | Abel Blanque, Ricard Real | ||||||||||||||
WSDL: | doc.wsdl | ||||||||||||||
Imports: |
|
||||||||||||||
Documentation: |
El mòdul doc és l'encarregat de gestionar els documents, i és part fonamental del sistema de gestió documental.
Característiques generals
Model conceptual![]() Figura 1: Model conceptual
|
[Types] [Operations]
Entity Content | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | Content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | doc:Content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.doc.Content | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Content és la representació del contingut d'un document.
Un contingut és una seqüència de bits que representa una certa informació expressada en un idioma i un format determinat (text, MSWord, HTML, pdf, etc.).
Els continguts són immutables. Això vol dir que un cop creat, un contingut es pot destruir però no es pot modificar. O dit d’una altra manera, la informació associada a un determinat contentId serà sempre la mateixa.
Un contingut pot formar part de diferents documents, o de diferents versions del mateix document.
El mòdul doc permet emmagatzemar i recuperar continguts. Un contingut es pot emmagatzemar de dues maneres:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Entity Document | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | Document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | doc:Document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.doc.Document | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Un Document és un objecte digital format per:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Attributes: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct RelatedDocument | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | RelatedDocument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | doc:RelatedDocument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.doc.RelatedDocument | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
Struct DocumentMetaData | |||||||||||||||||||
Name: | DocumentMetaData | ||||||||||||||||||
QName: | doc:DocumentMetaData | ||||||||||||||||||
Java class name: | org.matrix.doc.DocumentMetaData | ||||||||||||||||||
Description: |
|
||||||||||||||||||
Properties: |
|
||||||||||||||||||
Related operations: |
Struct DocumentManagerMetaData :: mx:ManagerMetaData | |||||||||||||
Name: | DocumentManagerMetaData | ||||||||||||
QName: | doc:DocumentManagerMetaData | ||||||||||||
Java class name: | org.matrix.doc.DocumentManagerMetaData | ||||||||||||
Super type: | mx:ManagerMetaData | ||||||||||||
Description: |
Conté les propietats que descriuen les característiques de la implementació d'aquest servei.
|
||||||||||||
Properties: |
|
||||||||||||
Related operations: |
Struct DocumentFilter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | DocumentFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | doc:DocumentFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.doc.DocumentFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Un DocumentFilter conté les propietats per les quals es filtraran resultats de fer una crida al mètode findDocuments o countDocuments.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct OrderByProperty | |||||||||||||||||||
Name: | OrderByProperty | ||||||||||||||||||
QName: | doc:OrderByProperty | ||||||||||||||||||
Java class name: | org.matrix.doc.OrderByProperty | ||||||||||||||||||
Description: |
Estructura que descriu una propietat per la qual s'ordenarà la llista de Document resultat de la operació findDocuments.
|
||||||||||||||||||
Properties: |
|
Enumeration ContentInfo | |||||||||
Name: | ContentInfo | ||||||||
QName: | doc:ContentInfo | ||||||||
Java class name: | org.matrix.doc.ContentInfo | ||||||||
Description: |
Classe enumeració que es fa servir dins del contexte d'una operació loadDocument, que indica
quin conjunt d'informació es retornarà dins de l'objecte Content.
|
||||||||
Values: |
|
Enumeration State | |||||||||||
Name: | State | ||||||||||
QName: | doc:State | ||||||||||
Java class name: | org.matrix.doc.State | ||||||||||
Description: |
Descripció dels diferents estats pels que pot passar un document en el seu cicle de vida.
|
||||||||||
Values: |
|
Enumeration RelationType | |||||||||||||||||||||||
Name: | RelationType | ||||||||||||||||||||||
QName: | doc:RelationType | ||||||||||||||||||||||
Java class name: | org.matrix.doc.RelationType | ||||||||||||||||||||||
Description: |
Tipus de relació d'un RelatedDocument amb el document que el relaciona.
Hi han 4 possibles tipus de relació. COMPONENT, TRANSLATION, REDACTION, RELATED. Les relacions amb el prefix REV_ son les relacions inverses.
Per tota relació entre dos documents REL(d1,d2), existeix una relació inversa en sentit contrari REV_REL(d2,d1).
|
||||||||||||||||||||||
Values: |
|
Operation loadContent | |||||||||||||
Name: | loadContent | ||||||||||||
Signature: | loadContent (contentId {xs:string}) => content {doc:Content} | ||||||||||||
Java signature: | org.matrix.doc.Content loadContent(String contentId) | ||||||||||||
Description: |
Recupera íntegrament un contingut a partir del seu identificador.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Errors: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadContent xmlns:ns2="http://doc.matrix.org/"> <contentId>{xs:string}</contentId> </ns2:loadContent> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadContentResponse xmlns:ns2="http://doc.matrix.org/"> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> </ns2:loadContentResponse> </S:Body> </S:Envelope> |
Operation loadDocument | |||||||||||||||||||||||||
Name: | loadDocument | ||||||||||||||||||||||||
Signature: | loadDocument (docId {xs:string}, version {xs:int}, contentInfo {doc:ContentInfo}) => document {doc:Document} | ||||||||||||||||||||||||
Java signature: | org.matrix.doc.Document loadDocument(String docId, int version, org.matrix.doc.ContentInfo contentInfo) | ||||||||||||||||||||||||
Description: |
Recupera un document a partir del seu identificador.
El document retornat serà íntegre amb totes les seves propietats, documents relacionats i controls d'accés, a excepció del contingut, que dependrà
del que s'especifiqui al parámetre contentInfo. Per tant, l'atribut incremental de l'objecte Document retornat, serà false.
|
||||||||||||||||||||||||
Parameters: |
|
||||||||||||||||||||||||
Response: |
|
||||||||||||||||||||||||
Errors: |
|
||||||||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadDocument xmlns:ns2="http://doc.matrix.org/"> <docId>{xs:string}</docId> <version>{xs:int}</version> <contentInfo>{doc:ContentInfo}</contentInfo> </ns2:loadDocument> </S:Body> </S:Envelope> | ||||||||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadDocumentResponse xmlns:ns2="http://doc.matrix.org/"> <document incremental="{xs:boolean}"> <docId>{xs:string}</docId> <version>{xs:int}</version> <title>{xs:string}</title> <docTypeId>{xs:string}</docTypeId> <state>{doc:State}</state> <language>{xs:string}</language> <authorId>{xs:string}</authorId> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> <creationDate>{mx:date}</creationDate> <classId>{xs:string}</classId> <caseId>{xs:string}</caseId> <summary>{xs:string}</summary> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> <lockUserId>{xs:string}</lockUserId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <relatedDocument> <relationType>{doc:RelationType}</relationType> <name>{xs:string}</name> <docId>{xs:string}</docId> <version>{xs:int}</version> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> </relatedDocument> <accessControl> <action>{xs:string}</action> <roleId>{xs:string}</roleId> </accessControl> </document> </ns2:loadDocumentResponse> </S:Body> </S:Envelope> |
Operation removeDocument | |||||||||||||||||||
Name: | removeDocument | ||||||||||||||||||
Signature: | removeDocument (docId {xs:string}, version {xs:int}) => removed {xs:boolean} | ||||||||||||||||||
Java signature: | boolean removeDocument(String docId, int version) | ||||||||||||||||||
Description: |
Elimina un document a partir del seu identificador.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Response: |
|
||||||||||||||||||
Errors: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeDocument xmlns:ns2="http://doc.matrix.org/"> <docId>{xs:string}</docId> <version>{xs:int}</version> </ns2:removeDocument> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeDocumentResponse xmlns:ns2="http://doc.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeDocumentResponse> </S:Body> </S:Envelope> |
Operation removeContent | |||||||||||||
Name: | removeContent | ||||||||||||
Signature: | removeContent (contentId {xs:string}) => removed {xs:boolean} | ||||||||||||
Java signature: | boolean removeContent(String contentId) | ||||||||||||
Description: |
Elimina un contingut a partir del seu identificador.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeContent xmlns:ns2="http://doc.matrix.org/"> <contentId>{xs:string}</contentId> </ns2:removeContent> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeContentResponse xmlns:ns2="http://doc.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeContentResponse> </S:Body> </S:Envelope> |
Operation getDocumentMetaData | |||||||||||||
Name: | getDocumentMetaData | ||||||||||||
Signature: | getDocumentMetaData () => return {doc:DocumentMetaData} | ||||||||||||
Java signature: | org.matrix.doc.DocumentMetaData getDocumentMetaData() | ||||||||||||
Description: |
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getDocumentMetaData xmlns:ns2="http://doc.matrix.org/"> </ns2:getDocumentMetaData> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getDocumentMetaDataResponse xmlns:ns2="http://doc.matrix.org/"> <return> <documentTitleMaxSize>{xs:int}</documentTitleMaxSize> <documentRelationNameMaxSize>{xs:int}</documentRelationNameMaxSize> </return> </ns2:getDocumentMetaDataResponse> </S:Body> </S:Envelope> |
Operation getManagerMetaData | |||||||||||||
Name: | getManagerMetaData | ||||||||||||
Signature: | getManagerMetaData () => documentMetaData {doc:DocumentManagerMetaData} | ||||||||||||
Java signature: | org.matrix.doc.DocumentManagerMetaData getManagerMetaData() | ||||||||||||
Description: |
Recupera les característiques de la implementació del servei.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getManagerMetaData xmlns:ns2="http://doc.matrix.org/"> </ns2:getManagerMetaData> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getManagerMetaDataResponse xmlns:ns2="http://doc.matrix.org/"> <documentMetaData> {mx:ManagerMetaData} <supportVersions>{xs:boolean}</supportVersions> </documentMetaData> </ns2:getManagerMetaDataResponse> </S:Body> </S:Envelope> |
Operation storeDocument | |||||||||||||||||
Name: | storeDocument | ||||||||||||||||
Signature: | storeDocument (document {doc:Document}) => storedDocument {doc:Document} | ||||||||||||||||
Java signature: | org.matrix.doc.Document storeDocument(org.matrix.doc.Document document) | ||||||||||||||||
Description: |
Crea o modifica un document.
Si el docId del document a desar és nul, és farà una creació. Si
pel contrari el docId té valor no nul es farà una modificació.
|
||||||||||||||||
Parameters: |
|
||||||||||||||||
Response: |
|
||||||||||||||||
Errors: |
|
||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeDocument xmlns:ns2="http://doc.matrix.org/"> <document incremental="{xs:boolean}"> <docId>{xs:string}</docId> <version>{xs:int}</version> <title>{xs:string}</title> <docTypeId>{xs:string}</docTypeId> <state>{doc:State}</state> <language>{xs:string}</language> <authorId>{xs:string}</authorId> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> <creationDate>{mx:date}</creationDate> <classId>{xs:string}</classId> <caseId>{xs:string}</caseId> <summary>{xs:string}</summary> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> <lockUserId>{xs:string}</lockUserId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <relatedDocument> <relationType>{doc:RelationType}</relationType> <name>{xs:string}</name> <docId>{xs:string}</docId> <version>{xs:int}</version> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> </relatedDocument> <accessControl> <action>{xs:string}</action> <roleId>{xs:string}</roleId> </accessControl> </document> </ns2:storeDocument> </S:Body> </S:Envelope> | ||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeDocumentResponse xmlns:ns2="http://doc.matrix.org/"> <storedDocument incremental="{xs:boolean}"> <docId>{xs:string}</docId> <version>{xs:int}</version> <title>{xs:string}</title> <docTypeId>{xs:string}</docTypeId> <state>{doc:State}</state> <language>{xs:string}</language> <authorId>{xs:string}</authorId> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> <creationDate>{mx:date}</creationDate> <classId>{xs:string}</classId> <caseId>{xs:string}</caseId> <summary>{xs:string}</summary> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> <lockUserId>{xs:string}</lockUserId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <relatedDocument> <relationType>{doc:RelationType}</relationType> <name>{xs:string}</name> <docId>{xs:string}</docId> <version>{xs:int}</version> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> </relatedDocument> <accessControl> <action>{xs:string}</action> <roleId>{xs:string}</roleId> </accessControl> </storedDocument> </ns2:storeDocumentResponse> </S:Body> </S:Envelope> |
Operation lockDocument | |||||||||||||||||||
Name: | lockDocument | ||||||||||||||||||
Signature: | lockDocument (docId {xs:string}, version {xs:int}) | ||||||||||||||||||
Java signature: | void lockDocument(String docId, int version) | ||||||||||||||||||
Description: |
Bloqueja un document per evitar la modificació del document.
Un document bloquejat només pot ser modificat per l'usuari que el bloqueja o per un
usuari administrador del gestor documental.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:lockDocument xmlns:ns2="http://doc.matrix.org/"> <docId>{xs:string}</docId> <version>{xs:int}</version> </ns2:lockDocument> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:lockDocumentResponse xmlns:ns2="http://doc.matrix.org/"> </ns2:lockDocumentResponse> </S:Body> </S:Envelope> |
Operation unlockDocument | |||||||||||||||||||
Name: | unlockDocument | ||||||||||||||||||
Signature: | unlockDocument (docId {xs:string}, version {xs:int}) | ||||||||||||||||||
Java signature: | void unlockDocument(String docId, int version) | ||||||||||||||||||
Description: |
Desbloqueja la modificació del document a partir del seu identificador.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:unlockDocument xmlns:ns2="http://doc.matrix.org/"> <docId>{xs:string}</docId> <version>{xs:int}</version> </ns2:unlockDocument> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:unlockDocumentResponse xmlns:ns2="http://doc.matrix.org/"> </ns2:unlockDocumentResponse> </S:Body> </S:Envelope> |
Operation findDocuments | |||||||||||||
Name: | findDocuments | ||||||||||||
Signature: | findDocuments (filter {doc:DocumentFilter}) => document {doc:Document}* | ||||||||||||
Java signature: | List<org.matrix.doc.Document> findDocuments(org.matrix.doc.DocumentFilter filter) | ||||||||||||
Description: |
Retorna un conjunt de documents que satisfan les condicions de filter.
Els documents retornats no són íntegres, ja que no contenen els objectes RelatedDocument,
ni els AccessControl. Les dades retornades dins l'objecte Content, dependran
de la propietat includeContentMetadata de DocumentFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findDocuments xmlns:ns2="http://doc.matrix.org/"> <filter> <docId>{xs:string}</docId> <docTypeId>{xs:string}</docTypeId> <version>{xs:int}</version> <language>{xs:string}</language> <title>{xs:string}</title> <dateComparator>{xs:string}</dateComparator> <startDate>{mx:date}</startDate> <endDate>{mx:date}</endDate> <contentSearchExpression>{xs:string}</contentSearchExpression> <metadataSearchExpression>{xs:string}</metadataSearchExpression> <summary>{xs:boolean}</summary> <contentId>{xs:string}</contentId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <outputProperty>{xs:string}</outputProperty> <orderByProperty> <name>{xs:string}</name> <descending>{xs:boolean}</descending> </orderByProperty> <firstResult>{xs:int}</firstResult> <maxResults>{xs:int}</maxResults> <includeContentMetadata>{xs:boolean}</includeContentMetadata> <states>{doc:State}</states> <rolesDisabled>{xs:boolean}</rolesDisabled> <classId>{xs:string}</classId> </filter> </ns2:findDocuments> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findDocumentsResponse xmlns:ns2="http://doc.matrix.org/"> <document incremental="{xs:boolean}"> <docId>{xs:string}</docId> <version>{xs:int}</version> <title>{xs:string}</title> <docTypeId>{xs:string}</docTypeId> <state>{doc:State}</state> <language>{xs:string}</language> <authorId>{xs:string}</authorId> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> <creationDate>{mx:date}</creationDate> <classId>{xs:string}</classId> <caseId>{xs:string}</caseId> <summary>{xs:string}</summary> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> <lockUserId>{xs:string}</lockUserId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <relatedDocument> <relationType>{doc:RelationType}</relationType> <name>{xs:string}</name> <docId>{xs:string}</docId> <version>{xs:int}</version> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <changeDateTime>{mx:dateTime}</changeDateTime> <changeUserId>{xs:string}</changeUserId> </relatedDocument> <accessControl> <action>{xs:string}</action> <roleId>{xs:string}</roleId> </accessControl> </document> </ns2:findDocumentsResponse> </S:Body> </S:Envelope> |
Operation countDocuments | |||||||||||||
Name: | countDocuments | ||||||||||||
Signature: | countDocuments (filter {doc:DocumentFilter}) => documentCount {xs:int} | ||||||||||||
Java signature: | int countDocuments(org.matrix.doc.DocumentFilter filter) | ||||||||||||
Description: |
Cerca el nombre de documents que satisfan les condicions del filtre.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countDocuments xmlns:ns2="http://doc.matrix.org/"> <filter> <docId>{xs:string}</docId> <docTypeId>{xs:string}</docTypeId> <version>{xs:int}</version> <language>{xs:string}</language> <title>{xs:string}</title> <dateComparator>{xs:string}</dateComparator> <startDate>{mx:date}</startDate> <endDate>{mx:date}</endDate> <contentSearchExpression>{xs:string}</contentSearchExpression> <metadataSearchExpression>{xs:string}</metadataSearchExpression> <summary>{xs:boolean}</summary> <contentId>{xs:string}</contentId> <property> <name>{xs:string}</name> <value>{xs:string}</value> </property> <outputProperty>{xs:string}</outputProperty> <orderByProperty> <name>{xs:string}</name> <descending>{xs:boolean}</descending> </orderByProperty> <firstResult>{xs:int}</firstResult> <maxResults>{xs:int}</maxResults> <includeContentMetadata>{xs:boolean}</includeContentMetadata> <states>{doc:State}</states> <rolesDisabled>{xs:boolean}</rolesDisabled> <classId>{xs:string}</classId> </filter> </ns2:countDocuments> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countDocumentsResponse xmlns:ns2="http://doc.matrix.org/"> <documentCount>{xs:int}</documentCount> </ns2:countDocumentsResponse> </S:Body> </S:Envelope> |
Operation storeContent | |||||||||||||
Name: | storeContent | ||||||||||||
Signature: | storeContent (content {doc:Content}) => storedContent {doc:Content} | ||||||||||||
Java signature: | org.matrix.doc.Content storeContent(org.matrix.doc.Content content) | ||||||||||||
Description: |
Desa un contingut al gestor documental.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeContent xmlns:ns2="http://doc.matrix.org/"> <content> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </content> </ns2:storeContent> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeContentResponse xmlns:ns2="http://doc.matrix.org/"> <storedContent> <contentId>{xs:string}</contentId> <contentType>{xs:string}</contentType> <formatId>{xs:string}</formatId> <formatDescription>{xs:string}</formatDescription> <language>{xs:string}</language> <creationDate>{mx:date}</creationDate> <captureDateTime>{mx:dateTime}</captureDateTime> <captureUserId>{xs:string}</captureUserId> <size>{xs:long}</size> <data>{xs:base64Binary}</data> <url>{xs:string}</url> </storedContent> </ns2:storeContentResponse> </S:Body> </S:Envelope> |
Operation markupContent | |||||||||||||||||||
Name: | markupContent | ||||||||||||||||||
Signature: | markupContent (contentId {xs:string}, searchExpression {xs:string}) => return {xs:base64Binary} | ||||||||||||||||||
Java signature: | byte[] markupContent(String contentId, String searchExpression) | ||||||||||||||||||
Description: |
Retorna una representació del contingut identificat per contentId en format HTML, on es resaltaran les paraules clau de l’expressió de cerca searchExpression.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Response: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:markupContent xmlns:ns2="http://doc.matrix.org/"> <contentId>{xs:string}</contentId> <searchExpression>{xs:string}</searchExpression> </ns2:markupContent> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:markupContentResponse xmlns:ns2="http://doc.matrix.org/"> <return>{xs:base64Binary}</return> </ns2:markupContentResponse> </S:Body> </S:Envelope> |