Repository Web Service Version 1.3
From AlfrescoWiki
Back to Repository Web Service.
This service provides read and write operations against a Repository. The operations are not tied to any particular domain model (i.e. it's generic in nature); other higher-level services will provide domain specific support.
Contents |
[edit] Types
[edit] QueryResult
- querySession - string
- resultSet - ResultSet
[edit] Association
- associationType - cms:Name
- direction - string (source, target)
[edit] UpdateResult
[edit] Methods
[edit] createStore
Creates a new store in the repository
Store createStore(StoreEnum scheme, xsd:string address)
Parameters:
- scheme - this indicates the type of store being referenced ths most common being 'workspace'. Other valid store schemes include 'versionStore', 'user', 'search' and 'system'.
- address - this is the name of the store.
Return:
- reference to the newly created store
[edit] getStores
Retrieve list of stores where content resources are held.
Store[] getStores()
Return:
- a list of the stores held in the respoitory
[edit] query
Execute a query against a store (could be a virtual store).
Query results are batched to the number of rows as defined by the SOAP header. Subsequent batches are retrieved using fetchMore.
QueryResult query(Store store, Query query, boolean includeMetaData)
Parameters:
- store - the store
- query - the query details
- includeMetaData - indicates whether the query meta data should be included in the query result
Return:
- the query result
[edit] queryChildren
Execute a query to retrieve the children of the specified resource.
QueryResult queryChildren(Reference node)
Parameters:
- node - the reference
Return:
- a query result containing the children of the specified reference
[edit] queryParents
Execute a query to retrieve the parents of the specified resource.
QueryResult queryParents(Reference node)
Parameters:
- node - the reference
Return:
- a query result containing the parents of the specified reference
[edit] queryAssociated
Execute a query to retrieve associated resources of the specified resource.
QueryResult queryAssociated(Reference node, Association[] association)
Parameters:
- node - the reference
- associatoin - the association
Return:
- a query result containing the references associatied to the specified reference
[edit] fetchMore
Fetch the next batch of query results.
QueryResult fetchMore(string querySession)
Parameters:
- querySession - the query session id
Return:
- a query result containing the next batch of results
[edit] update
Execute a CML script to manipulate the contents of a Repository store.
UpdateResult[] update(CML statements)
Parameters:
- statements - CML statements
Return:
- the results of the CML statements executed
[edit] describe
Describe a content resource.
NodeDefinition[] describe(Predicate items)
Parameters:
- items - the predicate
Return:
- the node defintions of the specified items
[edit] get
Gets the resource identified.
Parameters:
- where - the predicate
Return:
- the node objects of the items referenced
