Module news | |||||||||||||
Name: | news | ||||||||||||
Title: | Gestor de notícies | ||||||||||||
Namespace: | http://news.matrix.org/ | ||||||||||||
Service: | NewsManagerService | ||||||||||||
Port: | NewsManagerPort | ||||||||||||
Java package: | org.matrix.news | ||||||||||||
Version: | 1.0 | ||||||||||||
Status: | FINAL | ||||||||||||
Authors: | Jordi López | ||||||||||||
WSDL: | news.wsdl | ||||||||||||
Imports: |
|
||||||||||||
Documentation: |
Característiques generalsEl mòdul news és l'encarregat de:
NotíciaLes notícies es representen en el mòdul news mitjançant objectes New. Una notícia consisteix en una unitat d'informació vigent durant un període de temps determinat creada amb la finalitat de ser llegida per diferents clients. La informació que conté s'estructura en tres parts:
Publicació de notíciesLa publicació d'una notícia es representa en el mòdul news mitjançant objectes NewSection. Una notícia es pot publicar a un o més punts anomenats seccions. Dintre de cada secció, tota notícia té una determinada prioritat, que determina la seva posició respecte a la resta de notícies de la secció. Com més alt sigui aquest valor, més rellevant serà la seva posició a la secció.Documents associats a notíciesUn document associat a una notícia es representa en el mòdul news mitjançant objectes NewDocument. Una notícia pot tenir un o més documents associats, que serveixen per a completar la informació aportada per la notícia. Un document s'associa a una notícia per a complir una funció determinada, dependent de la implementació.Casos d'ús
|
[Types] [Operations]
Entity New | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | New | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | news:New | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.New | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
New representa una notícia.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Entity NewSection | |||||||||||||||||||||||||||||||||||||||||||
Name: | NewSection | ||||||||||||||||||||||||||||||||||||||||||
QName: | news:NewSection | ||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.NewSection | ||||||||||||||||||||||||||||||||||||||||||
Description: |
Publicació d'una notícia a una secció.
|
||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Entity NewDocument | |||||||||||||||||||||||||||||||||||||||||||||||||
Name: | NewDocument | ||||||||||||||||||||||||||||||||||||||||||||||||
QName: | news:NewDocument | ||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.NewDocument | ||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Associació d'un document a una notícia.
|
||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct NewStoreOptions | |||||||||||||||||||
Name: | NewStoreOptions | ||||||||||||||||||
QName: | news:NewStoreOptions | ||||||||||||||||||
Java class name: | org.matrix.news.NewStoreOptions | ||||||||||||||||||
Description: |
Opcions d'emmagatzemament d'una notícia.
|
||||||||||||||||||
Properties: |
|
||||||||||||||||||
Related operations: |
Struct NewsManagerMetaData :: mx:ManagerMetaData | |||||||
Name: | NewsManagerMetaData | ||||||
QName: | news:NewsManagerMetaData | ||||||
Java class name: | org.matrix.news.NewsManagerMetaData | ||||||
Super type: | mx:ManagerMetaData | ||||||
Description: |
Conté les propietats que descriuen les característiques de la implementació d'aquest servei.
|
||||||
Properties: |
|
||||||
Related operations: |
Struct SectionFilter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | SectionFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | news:SectionFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.SectionFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Filtre per cercar notícies agrupades en seccions a través de les operacions countNewsBySection i findNewsBySection.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct SectionView | |||||||||||||||||||||||||
Name: | SectionView | ||||||||||||||||||||||||
QName: | news:SectionView | ||||||||||||||||||||||||
Java class name: | org.matrix.news.SectionView | ||||||||||||||||||||||||
Description: |
Informació sobre una secció de notícies, amb un conjunt de notícies publicades a la mateixa.
|
||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||
Related operations: |
Struct NewView | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | NewView | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | news:NewView | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.NewView | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: |
Conté informació sobre una notícia dins d'una secció.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct NewsFilter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name: | NewsFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QName: | news:NewsFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.NewsFilter | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Related operations: |
Struct Source | |||||||||||||||||||||||||
Name: | Source | ||||||||||||||||||||||||
QName: | news:Source | ||||||||||||||||||||||||
Java class name: | org.matrix.news.Source | ||||||||||||||||||||||||
Description: |
Font d'una notícia.
|
||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||
Related operations: |
Struct SourceFilter | |||||||||||||||||||||||||||||||||||||
Name: | SourceFilter | ||||||||||||||||||||||||||||||||||||
QName: | news:SourceFilter | ||||||||||||||||||||||||||||||||||||
Java class name: | org.matrix.news.SourceFilter | ||||||||||||||||||||||||||||||||||||
Description: |
Filtre per cercar fonts a través de les operacions
countSources i
findSources.
|
||||||||||||||||||||||||||||||||||||
Properties: |
|
||||||||||||||||||||||||||||||||||||
Related operations: |
Operation storeNew | |||||||||||||||||||
Name: | storeNew | ||||||||||||||||||
Signature: | storeNew (new {news:New}, storeOptions {news:NewStoreOptions}) => storedNew {news:New} | ||||||||||||||||||
Java signature: | org.matrix.news.New storeNew(org.matrix.news.New new, org.matrix.news.NewStoreOptions storeOptions) | ||||||||||||||||||
Description: |
Crea o modifica una notícia.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Response: |
|
||||||||||||||||||
Errors: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNew xmlns:ns2="http://news.matrix.org/"> <new> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <text>{xs:string}</text> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <userId>{xs:string}</userId> <source>{xs:string}</source> <draft>{xs:boolean}</draft> <totalReadingCount>{xs:int}</totalReadingCount> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> </new> <storeOptions> <cleanSummary>{xs:boolean}</cleanSummary> <cleanText>{xs:boolean}</cleanText> </storeOptions> </ns2:storeNew> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNewResponse xmlns:ns2="http://news.matrix.org/"> <storedNew> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <text>{xs:string}</text> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <userId>{xs:string}</userId> <source>{xs:string}</source> <draft>{xs:boolean}</draft> <totalReadingCount>{xs:int}</totalReadingCount> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> </storedNew> </ns2:storeNewResponse> </S:Body> </S:Envelope> |
Operation getManagerMetaData | |||||||||||||
Name: | getManagerMetaData | ||||||||||||
Signature: | getManagerMetaData () => managerMetaData {news:NewsManagerMetaData} | ||||||||||||
Java signature: | org.matrix.news.NewsManagerMetaData 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://news.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://news.matrix.org/"> <managerMetaData> {mx:ManagerMetaData} </managerMetaData> </ns2:getManagerMetaDataResponse> </S:Body> </S:Envelope> |
Operation loadNew | |||||||||||||
Name: | loadNew | ||||||||||||
Signature: | loadNew (newId {xs:string}) => new {news:New} | ||||||||||||
Java signature: | org.matrix.news.New loadNew(String newId) | ||||||||||||
Description: |
Recupera una notícia 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:loadNew xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> </ns2:loadNew> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadNewResponse xmlns:ns2="http://news.matrix.org/"> <new> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <text>{xs:string}</text> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <userId>{xs:string}</userId> <source>{xs:string}</source> <draft>{xs:boolean}</draft> <totalReadingCount>{xs:int}</totalReadingCount> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> </new> </ns2:loadNewResponse> </S:Body> </S:Envelope> |
Operation incrementNewCounter | |||||||||||||||||||
Name: | incrementNewCounter | ||||||||||||||||||
Signature: | incrementNewCounter (newId {xs:string}, sectionId {xs:string}) => counter {xs:int} | ||||||||||||||||||
Java signature: | int incrementNewCounter(String newId, String sectionId) | ||||||||||||||||||
Description: |
Incrementa el comptador total de visites d'una notícia, i el comptador parcial per a una secció determinada.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Response: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:incrementNewCounter xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> <sectionId>{xs:string}</sectionId> </ns2:incrementNewCounter> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:incrementNewCounterResponse xmlns:ns2="http://news.matrix.org/"> <counter>{xs:int}</counter> </ns2:incrementNewCounterResponse> </S:Body> </S:Envelope> |
Operation getTotalNewCounter | |||||||||||||
Name: | getTotalNewCounter | ||||||||||||
Signature: | getTotalNewCounter (newId {xs:string}) => counter {xs:int} | ||||||||||||
Java signature: | int getTotalNewCounter(String newId) | ||||||||||||
Description: |
Recupera el valor del comptador total de visites a una notícia.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getTotalNewCounter xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> </ns2:getTotalNewCounter> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getTotalNewCounterResponse xmlns:ns2="http://news.matrix.org/"> <counter>{xs:int}</counter> </ns2:getTotalNewCounterResponse> </S:Body> </S:Envelope> |
Operation removeNew | |||||||||||||
Name: | removeNew | ||||||||||||
Signature: | removeNew (newId {xs:string}) => removed {xs:boolean} | ||||||||||||
Java signature: | boolean removeNew(String newId) | ||||||||||||
Description: |
Elimina una notícia.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNew xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> </ns2:removeNew> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNewResponse xmlns:ns2="http://news.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeNewResponse> </S:Body> </S:Envelope> |
Operation countNewsBySection | |||||||||||||
Name: | countNewsBySection | ||||||||||||
Signature: | countNewsBySection (filter {news:SectionFilter}) => newCount {xs:int} | ||||||||||||
Java signature: | int countNewsBySection(org.matrix.news.SectionFilter filter) | ||||||||||||
Description: |
Recupera el nombre de notícies que satisfan unes determinades condicions expressades per mitjà d'un filtre SectionFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countNewsBySection xmlns:ns2="http://news.matrix.org/"> <filter> <newId>{xs:string}</newId> <content>{xs:string}</content> <startDateTime>{mx:dateTime}</startDateTime> <endDateTime>{mx:dateTime}</endDateTime> <sectionId>{xs:string}</sectionId> <maxResults>{xs:int}</maxResults> <minPubDateTime>{mx:dateTime}</minPubDateTime> <firstResult>{xs:int}</firstResult> <excludeDrafts>{xs:boolean}</excludeDrafts> <userId>{xs:string}</userId> </filter> </ns2:countNewsBySection> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countNewsBySectionResponse xmlns:ns2="http://news.matrix.org/"> <newCount>{xs:int}</newCount> </ns2:countNewsBySectionResponse> </S:Body> </S:Envelope> |
Operation findNewsBySection | |||||||||||||
Name: | findNewsBySection | ||||||||||||
Signature: | findNewsBySection (filter {news:SectionFilter}) => sectionView {news:SectionView}* | ||||||||||||
Java signature: | List<org.matrix.news.SectionView> findNewsBySection(org.matrix.news.SectionFilter filter) | ||||||||||||
Description: |
Cerca objectes SectionView que satisfan unes determinades condicions expressades per mitjà d'un filtre SectionFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewsBySection xmlns:ns2="http://news.matrix.org/"> <filter> <newId>{xs:string}</newId> <content>{xs:string}</content> <startDateTime>{mx:dateTime}</startDateTime> <endDateTime>{mx:dateTime}</endDateTime> <sectionId>{xs:string}</sectionId> <maxResults>{xs:int}</maxResults> <minPubDateTime>{mx:dateTime}</minPubDateTime> <firstResult>{xs:int}</firstResult> <excludeDrafts>{xs:boolean}</excludeDrafts> <userId>{xs:string}</userId> </filter> </ns2:findNewsBySection> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewsBySectionResponse xmlns:ns2="http://news.matrix.org/"> <sectionView> <sectionId>{xs:string}</sectionId> <desc>{xs:string}</desc> <newView> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> <newDocument> <newDocumentId>{xs:string}</newDocumentId> <newId>{xs:string}</newId> <documentId>{xs:string}</documentId> <title>{xs:string}</title> <mimeType>{xs:string}</mimeType> <contentId>{xs:string}</contentId> <newDocTypeId>{xs:string}</newDocTypeId> </newDocument> <draft>{xs:boolean}</draft> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> <newSource> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </newSource> </newView> </sectionView> </ns2:findNewsBySectionResponse> </S:Body> </S:Envelope> |
Operation countNews | |||||||||||||
Name: | countNews | ||||||||||||
Signature: | countNews (filter {news:NewsFilter}) => newCount {xs:int} | ||||||||||||
Java signature: | int countNews(org.matrix.news.NewsFilter filter) | ||||||||||||
Description: |
Recupera el nombre de notícies que satisfan unes determinades condicions expressades per mitjà d'un filtre NewsFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countNews xmlns:ns2="http://news.matrix.org/"> <filter> <newId>{xs:string}</newId> <content>{xs:string}</content> <startDateTime>{mx:dateTime}</startDateTime> <endDateTime>{mx:dateTime}</endDateTime> <sectionId>{xs:string}</sectionId> <excludeDrafts>{xs:boolean}</excludeDrafts> <excludeNotPublished>{xs:boolean}</excludeNotPublished> <maxResults>{xs:int}</maxResults> <firstResult>{xs:int}</firstResult> <minPubDateTime>{mx:dateTime}</minPubDateTime> <userId>{xs:string}</userId> </filter> </ns2:countNews> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countNewsResponse xmlns:ns2="http://news.matrix.org/"> <newCount>{xs:int}</newCount> </ns2:countNewsResponse> </S:Body> </S:Envelope> |
Operation findNews | |||||||||||||
Name: | findNews | ||||||||||||
Signature: | findNews (filter {news:NewsFilter}) => new {news:New}* | ||||||||||||
Java signature: | List<org.matrix.news.New> findNews(org.matrix.news.NewsFilter filter) | ||||||||||||
Description: |
Cerca notícies que satisfacin unes determinades condicions expressades mitjançant un filtre NewsFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNews xmlns:ns2="http://news.matrix.org/"> <filter> <newId>{xs:string}</newId> <content>{xs:string}</content> <startDateTime>{mx:dateTime}</startDateTime> <endDateTime>{mx:dateTime}</endDateTime> <sectionId>{xs:string}</sectionId> <excludeDrafts>{xs:boolean}</excludeDrafts> <excludeNotPublished>{xs:boolean}</excludeNotPublished> <maxResults>{xs:int}</maxResults> <firstResult>{xs:int}</firstResult> <minPubDateTime>{mx:dateTime}</minPubDateTime> <userId>{xs:string}</userId> </filter> </ns2:findNews> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewsResponse xmlns:ns2="http://news.matrix.org/"> <new> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <text>{xs:string}</text> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <userId>{xs:string}</userId> <source>{xs:string}</source> <draft>{xs:boolean}</draft> <totalReadingCount>{xs:int}</totalReadingCount> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> </new> </ns2:findNewsResponse> </S:Body> </S:Envelope> |
Operation findNewViews | |||||||||||||
Name: | findNewViews | ||||||||||||
Signature: | findNewViews (filter {news:NewsFilter}) => newView {news:NewView}* | ||||||||||||
Java signature: | List<org.matrix.news.NewView> findNewViews(org.matrix.news.NewsFilter filter) | ||||||||||||
Description: |
Cerca notícies que satisfacin unes determinades condicions expressades per mitjà d'un filtre NewsFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewViews xmlns:ns2="http://news.matrix.org/"> <filter> <newId>{xs:string}</newId> <content>{xs:string}</content> <startDateTime>{mx:dateTime}</startDateTime> <endDateTime>{mx:dateTime}</endDateTime> <sectionId>{xs:string}</sectionId> <excludeDrafts>{xs:boolean}</excludeDrafts> <excludeNotPublished>{xs:boolean}</excludeNotPublished> <maxResults>{xs:int}</maxResults> <firstResult>{xs:int}</firstResult> <minPubDateTime>{mx:dateTime}</minPubDateTime> <userId>{xs:string}</userId> </filter> </ns2:findNewViews> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewViewsResponse xmlns:ns2="http://news.matrix.org/"> <newView> <newId>{xs:string}</newId> <headline>{xs:string}</headline> <summary>{xs:string}</summary> <registerDate>{mx:date}</registerDate> <registerTime>{mx:time}</registerTime> <startDate>{mx:date}</startDate> <startTime>{mx:time}</startTime> <endDate>{mx:date}</endDate> <endTime>{mx:time}</endTime> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> <newDocument> <newDocumentId>{xs:string}</newDocumentId> <newId>{xs:string}</newId> <documentId>{xs:string}</documentId> <title>{xs:string}</title> <mimeType>{xs:string}</mimeType> <contentId>{xs:string}</contentId> <newDocTypeId>{xs:string}</newDocTypeId> </newDocument> <draft>{xs:boolean}</draft> <keywords>{xs:string}</keywords> <customUrl>{xs:string}</customUrl> <customUrlTarget>{xs:string}</customUrlTarget> <hash>{xs:string}</hash> <iconUrl>{xs:string}</iconUrl> <newSource> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </newSource> </newView> </ns2:findNewViewsResponse> </S:Body> </S:Envelope> |
Operation loadNewSection | |||||||||||||
Name: | loadNewSection | ||||||||||||
Signature: | loadNewSection (newSectionId {xs:string}) => newSection {news:NewSection} | ||||||||||||
Java signature: | org.matrix.news.NewSection loadNewSection(String newSectionId) | ||||||||||||
Description: |
Recupera una publicació d'una notícia a una secció.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Errors: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadNewSection xmlns:ns2="http://news.matrix.org/"> <newSectionId>{xs:string}</newSectionId> </ns2:loadNewSection> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadNewSectionResponse xmlns:ns2="http://news.matrix.org/"> <newSection> <newSectionId>{xs:string}</newSectionId> <newId>{xs:string}</newId> <sectionId>{xs:string}</sectionId> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> </newSection> </ns2:loadNewSectionResponse> </S:Body> </S:Envelope> |
Operation storeNewSection | |||||||||||||
Name: | storeNewSection | ||||||||||||
Signature: | storeNewSection (newSection {news:NewSection}) => storedNewSection {news:NewSection} | ||||||||||||
Java signature: | org.matrix.news.NewSection storeNewSection(org.matrix.news.NewSection newSection) | ||||||||||||
Description: |
Crea o modifica una publicació d'una notícia a una secció.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Errors: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNewSection xmlns:ns2="http://news.matrix.org/"> <newSection> <newSectionId>{xs:string}</newSectionId> <newId>{xs:string}</newId> <sectionId>{xs:string}</sectionId> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> </newSection> </ns2:storeNewSection> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNewSectionResponse xmlns:ns2="http://news.matrix.org/"> <storedNewSection> <newSectionId>{xs:string}</newSectionId> <newId>{xs:string}</newId> <sectionId>{xs:string}</sectionId> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> </storedNewSection> </ns2:storeNewSectionResponse> </S:Body> </S:Envelope> |
Operation removeNewSection | |||||||||||||
Name: | removeNewSection | ||||||||||||
Signature: | removeNewSection (newSectionId {xs:string}) => removed {xs:boolean} | ||||||||||||
Java signature: | boolean removeNewSection(String newSectionId) | ||||||||||||
Description: |
Elimina la publicació d'una notícia a una secció.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNewSection xmlns:ns2="http://news.matrix.org/"> <newSectionId>{xs:string}</newSectionId> </ns2:removeNewSection> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNewSectionResponse xmlns:ns2="http://news.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeNewSectionResponse> </S:Body> </S:Envelope> |
Operation findNewSections | |||||||||||||
Name: | findNewSections | ||||||||||||
Signature: | findNewSections (newId {xs:string}) => newSection {news:NewSection}* | ||||||||||||
Java signature: | List<org.matrix.news.NewSection> findNewSections(String newId) | ||||||||||||
Description: |
Retorna la llista de seccions en les quals està publicada la notícia indicada mitjançant el parámetre newId.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewSections xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> </ns2:findNewSections> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewSectionsResponse xmlns:ns2="http://news.matrix.org/"> <newSection> <newSectionId>{xs:string}</newSectionId> <newId>{xs:string}</newId> <sectionId>{xs:string}</sectionId> <priority>{xs:int}</priority> <readingCount>{xs:int}</readingCount> <sticky>{xs:boolean}</sticky> </newSection> </ns2:findNewSectionsResponse> </S:Body> </S:Envelope> |
Operation storeNewDocument | |||||||||||||
Name: | storeNewDocument | ||||||||||||
Signature: | storeNewDocument (newDocument {news:NewDocument}) => storedNewDocument {news:NewDocument} | ||||||||||||
Java signature: | org.matrix.news.NewDocument storeNewDocument(org.matrix.news.NewDocument newDocument) | ||||||||||||
Description: |
Crea o modifica una associació entre un document i una notícia.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Errors: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNewDocument xmlns:ns2="http://news.matrix.org/"> <newDocument> <newDocumentId>{xs:string}</newDocumentId> <newId>{xs:string}</newId> <documentId>{xs:string}</documentId> <title>{xs:string}</title> <mimeType>{xs:string}</mimeType> <contentId>{xs:string}</contentId> <newDocTypeId>{xs:string}</newDocTypeId> </newDocument> </ns2:storeNewDocument> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeNewDocumentResponse xmlns:ns2="http://news.matrix.org/"> <storedNewDocument> <newDocumentId>{xs:string}</newDocumentId> <newId>{xs:string}</newId> <documentId>{xs:string}</documentId> <title>{xs:string}</title> <mimeType>{xs:string}</mimeType> <contentId>{xs:string}</contentId> <newDocTypeId>{xs:string}</newDocTypeId> </storedNewDocument> </ns2:storeNewDocumentResponse> </S:Body> </S:Envelope> |
Operation removeNewDocument | |||||||||||||
Name: | removeNewDocument | ||||||||||||
Signature: | removeNewDocument (newDocumentId {xs:string}) => removed {xs:boolean} | ||||||||||||
Java signature: | boolean removeNewDocument(String newDocumentId) | ||||||||||||
Description: |
Elimina una associació entre un document i una notícia.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNewDocument xmlns:ns2="http://news.matrix.org/"> <newDocumentId>{xs:string}</newDocumentId> </ns2:removeNewDocument> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeNewDocumentResponse xmlns:ns2="http://news.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeNewDocumentResponse> </S:Body> </S:Envelope> |
Operation findNewDocuments | |||||||||||||||||||
Name: | findNewDocuments | ||||||||||||||||||
Signature: | findNewDocuments (newId {xs:string}, docType {xs:string}) => newDocument {news:NewDocument}* | ||||||||||||||||||
Java signature: | List<org.matrix.news.NewDocument> findNewDocuments(String newId, String docType) | ||||||||||||||||||
Description: |
Retorna els documents associats a la notícia indicada pel paràmetre newId.
|
||||||||||||||||||
Parameters: |
|
||||||||||||||||||
Response: |
|
||||||||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewDocuments xmlns:ns2="http://news.matrix.org/"> <newId>{xs:string}</newId> <docType>{xs:string}</docType> </ns2:findNewDocuments> </S:Body> </S:Envelope> | ||||||||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findNewDocumentsResponse xmlns:ns2="http://news.matrix.org/"> <newDocument> <newDocumentId>{xs:string}</newDocumentId> <newId>{xs:string}</newId> <documentId>{xs:string}</documentId> <title>{xs:string}</title> <mimeType>{xs:string}</mimeType> <contentId>{xs:string}</contentId> <newDocTypeId>{xs:string}</newDocTypeId> </newDocument> </ns2:findNewDocumentsResponse> </S:Body> </S:Envelope> |
Operation loadSource | |||||||||||||
Name: | loadSource | ||||||||||||
Signature: | loadSource (sourceId {xs:string}) => source {news:Source} | ||||||||||||
Java signature: | org.matrix.news.Source loadSource(String sourceId) | ||||||||||||
Description: |
Recupera una font 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:loadSource xmlns:ns2="http://news.matrix.org/"> <sourceId>{xs:string}</sourceId> </ns2:loadSource> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loadSourceResponse xmlns:ns2="http://news.matrix.org/"> <source> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </source> </ns2:loadSourceResponse> </S:Body> </S:Envelope> |
Operation storeSource | |||||||||||||
Name: | storeSource | ||||||||||||
Signature: | storeSource (source {news:Source}) => storedSource {news:Source} | ||||||||||||
Java signature: | org.matrix.news.Source storeSource(org.matrix.news.Source source) | ||||||||||||
Description: |
Crea o modifica una font.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Errors: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeSource xmlns:ns2="http://news.matrix.org/"> <source> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </source> </ns2:storeSource> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeSourceResponse xmlns:ns2="http://news.matrix.org/"> <storedSource> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </storedSource> </ns2:storeSourceResponse> </S:Body> </S:Envelope> |
Operation removeSource | |||||||||||||
Name: | removeSource | ||||||||||||
Signature: | removeSource (sourceId {xs:string}) => removed {xs:boolean} | ||||||||||||
Java signature: | boolean removeSource(String sourceId) | ||||||||||||
Description: |
Elimina una font.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeSource xmlns:ns2="http://news.matrix.org/"> <sourceId>{xs:string}</sourceId> </ns2:removeSource> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeSourceResponse xmlns:ns2="http://news.matrix.org/"> <removed>{xs:boolean}</removed> </ns2:removeSourceResponse> </S:Body> </S:Envelope> |
Operation countSources | |||||||||||||
Name: | countSources | ||||||||||||
Signature: | countSources (filter {news:SourceFilter}) => sourceCount {xs:int} | ||||||||||||
Java signature: | int countSources(org.matrix.news.SourceFilter filter) | ||||||||||||
Description: |
Recupera el nombre de fonts que satisfan unes determinades condicions
expressades mitjançant un filtre
SourceFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countSources xmlns:ns2="http://news.matrix.org/"> <filter> <sourceId>{xs:string}</sourceId> <name>{xs:string}</name> <url>{xs:string}</url> <firstResult>{xs:int}</firstResult> <maxResults>{xs:int}</maxResults> </filter> </ns2:countSources> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:countSourcesResponse xmlns:ns2="http://news.matrix.org/"> <sourceCount>{xs:int}</sourceCount> </ns2:countSourcesResponse> </S:Body> </S:Envelope> |
Operation findSources | |||||||||||||
Name: | findSources | ||||||||||||
Signature: | findSources (filter {news:SourceFilter}) => source {news:Source}* | ||||||||||||
Java signature: | List<org.matrix.news.Source> findSources(org.matrix.news.SourceFilter filter) | ||||||||||||
Description: |
Cerca fonts que satisfacin unes determinades condicions expressades
mitjançant un filtre SourceFilter.
|
||||||||||||
Parameters: |
|
||||||||||||
Response: |
|
||||||||||||
Sample input message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findSources xmlns:ns2="http://news.matrix.org/"> <filter> <sourceId>{xs:string}</sourceId> <name>{xs:string}</name> <url>{xs:string}</url> <firstResult>{xs:int}</firstResult> <maxResults>{xs:int}</maxResults> </filter> </ns2:findSources> </S:Body> </S:Envelope> | ||||||||||||
Sample output message: | <?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:findSourcesResponse xmlns:ns2="http://news.matrix.org/"> <source> <id>{xs:string}</id> <name>{xs:string}</name> <url>{xs:string}</url> </source> </ns2:findSourcesResponse> </S:Body> </S:Envelope> |