Interface IIntegrationDataAppSoap
- All Known Implementing Classes:
IntegrationDataAppSoap
,IntegrationDataAppSoapMockStub
,IntegrationDataAppSoapStub
public interface IIntegrationDataAppSoap
-
Method Summary
Modifier and TypeMethodDescriptionGets data for an object from the integration data servicegetDataByKey
(String sessionId, String namespaceId, String objectId, String key) Gets data for an object from the integration data servicegetNamespaceId
(String sessionId, String name) Gets the key to an existing namespace.void
putData
(String sessionId, String namespaceId, String objectId, SoapNamedValues namedValues) Adds or replaces a set of integration data values for the specified object.void
Adds or replaces a single integration data value for the specified object.registerNamespace
(String sessionId, String name) Registers a new namespacevoid
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.
-
Method Details
-
registerNamespace
Registers a new namespace- Parameters:
sessionId
- SOAP session id.name
- The name of the namespace to register- Returns:
- Integration data namespace id
- Throws:
InvalidSessionFault
- when the sessionId is invalid.ObjectAlreadyExistsFault
- when the specified name already existsSystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
getNamespaceId
Gets the key to an existing namespace.- Parameters:
sessionId
- SOAP session id.name
- The name of the namespace to get- Returns:
- Integration data namespace id
- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the specified name doesn't exist.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.1
-
putData
void putData(String sessionId, String namespaceId, String objectId, SoapNamedValues namedValues) throws RemoteException Adds or replaces a set of integration data values for the specified object.- Parameters:
sessionId
- SOAP session id.namespaceId
- The namespace to store data underobjectId
- The object to associate the data withnamedValues
- Key value pairs of data to associate- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
- Since:
- 4.3-HOTFIX1
-
putDataByKey
void putDataByKey(String sessionId, String namespaceId, String objectId, String key, String value) throws RemoteException Adds or replaces a single integration data value for the specified object.- Parameters:
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 store- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
- Since:
- 4.3-HOTFIX1
-
removeData
void removeData(String sessionId, String namespaceId, String objectId, String[] keys) throws RemoteException Removes a set of integration data values from the specified object.- Parameters:
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.- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
- Since:
- 4.3-HOTFIX1
-
removeDataByKey
void removeDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException Removes a single integration data value from the specified object.- Parameters:
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.- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to store data on the objectRemoteException
- Since:
- 4.3-HOTFIX1
-
getData
SoapNamedValues getData(String sessionId, String namespaceId, String objectId) throws RemoteException Gets data for an object from the integration data service- Parameters:
sessionId
- SOAP session id.namespaceId
- The namespace to get data underobjectId
- The object to get the data for- Returns:
- A SoapNamedValues collection of key/value pair stored data
- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to get data on the objectRemoteException
- Since:
- 4.1
-
getDataByKey
String getDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException Gets data for an object from the integration data service- Parameters:
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 retrieve- Returns:
- The value of the stored piece of data
- Throws:
InvalidSessionFault
- when the sessionId is invalid.NoSuchObjectFault
- when the object id doesn't existSystemFault
- when an unexpected system error occurs.PermissionDeniedFault
- when the user doesn't have permission to get data on the objectRemoteException
- Since:
- 4.3
-