Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.vasoftware.sf.soap44.webservices.integrationdata
Class IntegrationDataAppSoap

java.lang.Object
  extended by com.vasoftware.sf.soap44.webservices.WebService
      extended by com.vasoftware.sf.soap44.webservices.integrationdata.IntegrationDataAppSoap
All Implemented Interfaces:
IIntegrationDataAppSoap
public class IntegrationDataAppSoap
extends com.vasoftware.sf.soap44.webservices.WebService
implements IIntegrationDataAppSoap

Provides SOAP web service for the integration data application.

Change History
Version 4.4: No changes.

Since:
4.1
Version:
$Revision: 1.3 $ $Date: 2007/05/24 00:53:54 $
Author:
Dominick Bellizzi , Chary Aasuri

Constructor Summary
IntegrationDataAppSoap()
           
 
Method Summary
 SoapNamedValues getData(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId)
          Get data for an object from the integration data service
 java.lang.String getDataByKey(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, java.lang.String key)
          Get data for an object from the integration data service
 java.lang.String getNamespaceId(java.lang.String sessionId, java.lang.String name)
          Get the key to an existing namespace.
 void putData(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, SoapNamedValues namedValues)
          Add or replace a set of integration data values for the specified object.
 void putDataByKey(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, java.lang.String key, java.lang.String value)
          Add or replace a single integration data value for the specified object.
 java.lang.String registerNamespace(java.lang.String sessionId, java.lang.String name)
          Register a new namespace
 void removeData(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, java.lang.String[] keys)
          Remove a set of integration data values from the specified object.
 void removeDataByKey(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, java.lang.String key)
          Remove a single integration data value from the specified object.
 void setData(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, SoapNamedValues namedValues)
          Deprecated. Use putData instead.
 void setDataByKey(java.lang.String sessionId, java.lang.String namespaceId, java.lang.String objectId, java.lang.String key, java.lang.String value)
          Deprecated. Use putDataByKey instead.
 
Methods inherited from class com.vasoftware.sf.soap44.webservices.WebService
checkAndSaveSessionId, checkPermission, checkPermission, downloadFile, generateFolderName, getCategorization, getDiscussion, getDocMan, getDocumentRootFolder, getFolderKey, getFolderPath, getFolderPath, getFolderPath, getFrs, getIntegrationData, getItemPath, getItemPath, getLocale, getNews, getNulledMinSoapDate, getObjectKey, getObjectPath, getProjectId, getProjectPath, getRbac, getScm, getSearch, getSession, getSessionKey, getSfMain, getStoredFileSize, getStoredFileText, getTaskMgr, getTemplate, getTracker, getUserName, getWiki, isFolderResource, isProjectId, isStrEmpty, isSuperUser, makeStoredFileDO, storeFile, storeFile, storeTextFile, validateChoice, validateChoice, validateString, validateWikiPageName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IntegrationDataAppSoap

public IntegrationDataAppSoap()
Method Detail

registerNamespace

public java.lang.String registerNamespace(java.lang.String sessionId,
                                          java.lang.String name)
                                   throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                                          com.vasoftware.sf.soap44.fault.SystemFault,
                                          com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault
Register a new namespace

Specified by:
registerNamespace in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
name - The name of the namespace to register
Returns:
Integration data namespace id
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the specified name already exists
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
Since:
4.1

getNamespaceId

public java.lang.String getNamespaceId(java.lang.String sessionId,
                                       java.lang.String name)
                                throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                                       com.vasoftware.sf.soap44.fault.SystemFault,
                                       com.vasoftware.sf.soap44.fault.NoSuchObjectFault
Get the key to an existing namespace.

Specified by:
getNamespaceId in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
name - The name of the namespace to get
Returns:
Integration data namespace id
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified name doesn't exist.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
Since:
4.1

setData

public void setData(java.lang.String sessionId,
                    java.lang.String namespaceId,
                    java.lang.String objectId,
                    SoapNamedValues namedValues)
             throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                    com.vasoftware.sf.soap44.fault.SystemFault,
                    com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                    com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Deprecated. Use putData instead.

Store data in the integration data service

Specified by:
setData in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
namedValues - Key value pairs of data to associate
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.1

setDataByKey

public void setDataByKey(java.lang.String sessionId,
                         java.lang.String namespaceId,
                         java.lang.String objectId,
                         java.lang.String key,
                         java.lang.String value)
                  throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                         com.vasoftware.sf.soap44.fault.SystemFault,
                         com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                         com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Deprecated. Use putDataByKey instead.

Store data in the integration data service

Specified by:
setDataByKey in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
key - The key of the piece of data to store
value - The value to store
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.3

putData

public void putData(java.lang.String sessionId,
                    java.lang.String namespaceId,
                    java.lang.String objectId,
                    SoapNamedValues namedValues)
             throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                    com.vasoftware.sf.soap44.fault.SystemFault,
                    com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                    com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Add or replace a set of integration data values for the specified object.

Specified by:
putData in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
namedValues - Key value pairs of data to associate
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.3-HOTFIX1

putDataByKey

public void putDataByKey(java.lang.String sessionId,
                         java.lang.String namespaceId,
                         java.lang.String objectId,
                         java.lang.String key,
                         java.lang.String value)
                  throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                         com.vasoftware.sf.soap44.fault.SystemFault,
                         com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                         com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Add or replace a single integration data value for the specified object.

Specified by:
putDataByKey in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
key - The key of the piece of data to store
value - The value to store
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.3-HOTFIX1

removeData

public void removeData(java.lang.String sessionId,
                       java.lang.String namespaceId,
                       java.lang.String objectId,
                       java.lang.String[] keys)
                throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                       com.vasoftware.sf.soap44.fault.SystemFault,
                       com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                       com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Remove a set of integration data values from the specified object.

Specified by:
removeData in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
keys - Integration data keys (and associated values) to remove.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.3-HOTFIX1

removeDataByKey

public void removeDataByKey(java.lang.String sessionId,
                            java.lang.String namespaceId,
                            java.lang.String objectId,
                            java.lang.String key)
                     throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                            com.vasoftware.sf.soap44.fault.SystemFault,
                            com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                            com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Remove a single integration data value from the specified object.

Specified by:
removeDataByKey in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to store data under
objectId - The object to associate the data with
key - Integration data key (and associated value) to remove.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to store data on the object
Since:
4.3-HOTFIX1

getData

public SoapNamedValues getData(java.lang.String sessionId,
                               java.lang.String namespaceId,
                               java.lang.String objectId)
                        throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                               com.vasoftware.sf.soap44.fault.SystemFault,
                               com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                               com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Get data for an object from the integration data service

Specified by:
getData in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to get data under
objectId - The object to get the data for
Returns:
A SoapNamedValues collection of key/value pair stored data
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to get data on the object
Since:
4.1

getDataByKey

public java.lang.String getDataByKey(java.lang.String sessionId,
                                     java.lang.String namespaceId,
                                     java.lang.String objectId,
                                     java.lang.String key)
                              throws com.vasoftware.sf.soap44.fault.InvalidSessionFault,
                                     com.vasoftware.sf.soap44.fault.SystemFault,
                                     com.vasoftware.sf.soap44.fault.NoSuchObjectFault,
                                     com.vasoftware.sf.soap44.fault.PermissionDeniedFault
Get data for an object from the integration data service

Specified by:
getDataByKey in interface IIntegrationDataAppSoap
Parameters:
sessionId - SOAP session id.
namespaceId - The namespace to get data under
objectId - The object to get the data for
key - The key of the piece of data to retrieve
Returns:
The value of the stored piece of data
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the object id doesn't exist
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission to get data on the object
Since:
4.3
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD