public interface QueryService
Modifier and Type | Method and Description |
---|---|
DataHandler |
downloadDocument(String documentId)
Returns the binary content from a specific document.
|
DataHandler |
downloadReport(String documentId,
String requestId,
Boolean scale,
Boolean rotate,
Boolean a4)
Returns the binary content from a specific document, indicating the type.
|
DataHandler |
downloadSign(String documentId)
Returns the binary content from a document sign.
|
es.juntadeandalucia.cice.pfirma.ws.bean.CommentList |
queryComments(String requestId)
Returns comments from request hash received parameter.
|
String |
queryCsv(String documentId)
Returns the CSV registered in Portafirmas.
|
es.juntadeandalucia.cice.pfirma.ws.bean.DocumentTypeList |
queryDocumentTypes(String query)
Returns a document types list object containing document types which
match with received filter in query parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.HistoricList |
queryHistoric(String requestId)
Returns historic from request hash received parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.HistoricListList |
queryHistoricList(RequestIdList requestIdList)
Returns historic list from request hash list received parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.JobList |
queryJobs(String query)
Obtains a job list containing jobs which match with received filter in
query parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.Request |
queryRequest(String requestId)
Obtains a request from request hash received parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.RequestList |
queryRequestList(RequestIdList requestIdList)
Obtains a request list from request hash list received parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.StateList |
queryStates(String query)
Obtains a state list containing states which match with received filter
in query parameter.
|
es.juntadeandalucia.cice.pfirma.ws.bean.UserList |
queryUsers(String query)
Returns a user list containing users who match with received filter in
query parameter.
|
@ResponseWrapper(localName="downloadDocumentResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadDocumentResponse") @RequestWrapper(localName="downloadDocument", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadDocument") DataHandler downloadDocument(String documentId) throws PfirmaException
documentId
- Document hash.DataHandler
object with document binary content.PfirmaException
- If an error occurs during process. Possible errors are that
document hash is null or document is not found.@ResponseWrapper(localName="downloadReportResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadReportResponse") @RequestWrapper(localName="downloadReport", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadReport") DataHandler downloadReport(String documentId, String requestId, Boolean scale, Boolean rotate, Boolean a4) throws PfirmaException
documentId
- Document hash o CSV code.DataHandler
object with document binary content.PfirmaException
- If an error occurs during process. Possible errors are that
document hash is null or document is not found.@ResponseWrapper(localName="queryUsersResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryUsersResponse") @RequestWrapper(localName="queryUsers", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryUsers") es.juntadeandalucia.cice.pfirma.ws.bean.UserList queryUsers(String query) throws PfirmaException
query
- Filter string which will be applied to name, first surname,
second surname and identifier. If no filter is passed, will
return all users existing in application.UserList
containing users who match with filter received.PfirmaException
- If an error occurs during process. Possible error is that
there are no users which match with filter.@ResponseWrapper(localName="downloadSignResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadSignResponse") @RequestWrapper(localName="downloadSign", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.DownloadSign") DataHandler downloadSign(String documentId) throws PfirmaException
documentId
- Document hash.DataHandler
object with sign binary content.PfirmaException
- If an error occurs during process. Possible errors are that
document hash is null, document is not found or not signed.@ResponseWrapper(localName="queryDocumentTypesResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryDocumentTypesResponse") @RequestWrapper(localName="queryDocumentTypes", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryDocumentTypes") es.juntadeandalucia.cice.pfirma.ws.bean.DocumentTypeList queryDocumentTypes(String query) throws PfirmaException
query
- Filter string which will be applied to document type code and
associated (if exists) application code.DocumentTypeList
containing document types which match
with filter received.PfirmaException
- If an error occurs during process. Possible error is that
there is not document types which match with received filter.@ResponseWrapper(localName="queryJobsResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryJobsResponse") @RequestWrapper(localName="queryJobs", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryJobs") es.juntadeandalucia.cice.pfirma.ws.bean.JobList queryJobs(String query) throws PfirmaException
query
- Filter string which will be applied to identifier. If no
filter is passed, will return all users existing in
application.JobList
containing jobs whichF match with filter
received.PfirmaException
- If an error occurs during process. Possible error is that
there are no jobs which match with filter.@ResponseWrapper(localName="queryRequestResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryRequestResponse") @RequestWrapper(localName="queryRequest", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryRequest") es.juntadeandalucia.cice.pfirma.ws.bean.Request queryRequest(String requestId) throws PfirmaException
requestId
- Request hash;Request
object with request data.PfirmaException
- If an error occurs during process. Possible error are that
request hash filter is not received or that there is no
request with hash received.@ResponseWrapper(localName="queryRequestListResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryRequestListResponse") @RequestWrapper(localName="queryRequestList", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryRequestList") es.juntadeandalucia.cice.pfirma.ws.bean.RequestList queryRequestList(RequestIdList requestIdList) throws PfirmaException
requestIdList
- Request hash list;RequestList
object with request list data.PfirmaException
- If an error occurs during process. Possible error are that
request hash filter is not received or that there is no
request with hash received.@ResponseWrapper(localName="queryStatesResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryStatesResponse") @RequestWrapper(localName="queryStates", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryStates") es.juntadeandalucia.cice.pfirma.ws.bean.StateList queryStates(String query) throws PfirmaException
query
- Filter string which will be applied to state code. If no
filter is passed, will return all states existing in
application.StateList
containing states which match with filter.
received.PfirmaException
- If an error occurs during process. Possible error is that
there is not states which match with received filter.@ResponseWrapper(localName="queryCommentsResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryCommentsResponse") @RequestWrapper(localName="queryComments", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryComments") es.juntadeandalucia.cice.pfirma.ws.bean.CommentList queryComments(String requestId) throws PfirmaException
requestId
- Request hash;CommentList
comment list of request, null if no comments
found.PfirmaException
- If an error occurs during process.@ResponseWrapper(localName="queryHistoricResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryHistoricResponse") @RequestWrapper(localName="queryHistoric", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryHistoric") es.juntadeandalucia.cice.pfirma.ws.bean.HistoricList queryHistoric(String requestId) throws PfirmaException
requestId
- Request hash;HistoricList
historic list of request, null if no
historic found.PfirmaException
- If an error occurs during process.@ResponseWrapper(localName="queryHistoricListResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryHistoricListResponse") @RequestWrapper(localName="queryHistoricList", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryHistoricList") es.juntadeandalucia.cice.pfirma.ws.bean.HistoricListList queryHistoricList(RequestIdList requestIdList) throws PfirmaException
requestIdList
- Request hash list;HistoricListLis
historic list list of request list, null if no
historic found.PfirmaException
- If an error occurs during process.@ResponseWrapper(localName="queryCsvResponse", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryCsvResponse") @RequestWrapper(localName="queryCsv", targetNamespace="urn:juntadeandalucia:cice:pfirma:query:request:v2.0", className="es.juntadeandalucia.cice.pfirma.ws.query.request.QueryCsv") String queryCsv(String documentId) throws PfirmaException
documentId
- Document hash.String
String with the csv.PfirmaException
- If an error occurs during process. Possible errors are that
document hash is null, document is not found or not signed.Copyright © 2017. All rights reserved.