public interface IIntegrationDataAppSoap
Modifier and Type | Method and Description |
---|---|
com.collabnet.ce.soap60.types.SoapNamedValues |
getData(String sessionId,
String namespaceId,
String objectId)
Gets data for an object from the integration data service
|
String |
getDataByKey(String sessionId,
String namespaceId,
String objectId,
String key)
Gets data for an object from the integration data service
|
String |
getNamespaceId(String sessionId,
String name)
Gets the key to an existing namespace.
|
void |
putData(String sessionId,
String namespaceId,
String objectId,
com.collabnet.ce.soap60.types.SoapNamedValues namedValues)
Adds or replaces a set of integration data values for the specified object.
|
void |
putDataByKey(String sessionId,
String namespaceId,
String objectId,
String key,
String value)
Adds or replaces a single integration data value for the specified object.
|
String |
registerNamespace(String sessionId,
String name)
Registers a new namespace
|
void |
removeData(String sessionId,
String namespaceId,
String objectId,
String[] keys)
Removes a set of integration data values from the specified object.
|
void |
removeDataByKey(String sessionId,
String namespaceId,
String objectId,
String key)
Removes a single integration data value from the specified object.
|
String registerNamespace(String sessionId, String name) throws RemoteException
sessionId
- SOAP session id.name
- The name of the namespace to registercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the specified name already existscom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String getNamespaceId(String sessionId, String name) throws RemoteException
sessionId
- SOAP session id.name
- The name of the namespace to getcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified name doesn't exist.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void putData(String sessionId, String namespaceId, String objectId, com.collabnet.ce.soap60.types.SoapNamedValues namedValues) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to store data underobjectId
- The object to associate the data withnamedValues
- Key value pairs of data to associatecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
void putDataByKey(String sessionId, String namespaceId, String objectId, String key, String value) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to store data underobjectId
- The object to associate the data withkey
- The key of the piece of data to storevalue
- The value to storecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
void removeData(String sessionId, String namespaceId, String objectId, String[] keys) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to store data underobjectId
- The object to associate the data withkeys
- Integration data keys (and associated values) to remove.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
void removeDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to store data underobjectId
- The object to associate the data withkey
- Integration data key (and associated value) to remove.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
com.collabnet.ce.soap60.types.SoapNamedValues getData(String sessionId, String namespaceId, String objectId) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to get data underobjectId
- The object to get the data forcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to get data on the objectRemoteException
String getDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException
sessionId
- SOAP session id.namespaceId
- The namespace to get data underobjectId
- The object to get the data forkey
- The key of the piece of data to retrievecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the object id doesn't existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user doesn't have permission to get data on the objectRemoteException
Copyright © 2016 CollabNet. All Rights Reserved.