public class RestRepositoryHelper
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
RestRepositoryHelper() |
Modifier and Type | Method and Description |
---|---|
static RestResult |
createItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Creates a repository item.
|
static RestResult |
createItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pItemId,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Creates a repository item with the specified id.
|
static RestResult |
executeRQLQuery(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pRQL,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Returns references to all the items of the given type that satisfy the RQL query.
|
static RestResult |
getItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pItemId,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Returns a representation of the given repository item.
|
static RestResult |
getItems(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Returns references to all the items of the given type.
|
static RestResult |
getPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pItemId,
java.lang.String pProperty,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Gets the specified property or sub-property for the desired repository item.
|
static RestResult |
removeItem(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pItemId,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Removes the specified repository item
|
static RestResult |
setPropertyValue(java.lang.String pRepositoryPath,
java.lang.String pItemDescriptorName,
java.lang.String pItemId,
java.lang.String pProperty,
java.lang.Object pValue,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Sets the specified value on the given property or sub-property for the desired repository item
|
public static RestResult getItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pItemId, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpItemId
- the item idpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult getItems(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult executeRQLQuery(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pRQL, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpRQL
- the RQL query stringpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult getPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pItemId, java.lang.String pProperty, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpItemId
- the item idpProperty
- the name of the desired property or sub-property to get formatted as follows: "property/sub-property/sub-property"pParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult setPropertyValue(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pItemId, java.lang.String pProperty, java.lang.Object pValue, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpItemId
- the item idpProperty
- the name of the desired property or sub-property to get formatted as follows: "property/sub-property/sub-property"pValue
- the value to setpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult createItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult createItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pItemId, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpItemId
- an optional parameter to specify the id to use when creating the itempParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult removeItem(java.lang.String pRepositoryPath, java.lang.String pItemDescriptorName, java.lang.String pItemId, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pRepositoryPath
- the path of the desired repositorypItemDescriptorName
- the name of the item descriptorpItemId
- the item idpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the request