com.tsgrp.opencontent.core.preferences

Interface IPreferencesService

All Known Implementing Classes:

GenericPreferencesService, S3PreferencesServiceImpl

public interface IPreferencesService

Method Summary

Modifier and Type	Method and Description
java.lang.String	deletePreferencesByName(java.lang.String ticket, java.lang.String name, java.lang.String appId) Deletes the preferences object at the given path + name.
org.json.JSONObject	getPreferencesByName(java.lang.String ticket, java.lang.String name, boolean shallow, java.lang.String appId) Gets a JSON object of the preferences at the path + name specified; if shallow is true, we remove any complex keys.
org.json.JSONObject	getPreferencesByName(java.lang.String ticket, java.lang.String name, java.lang.String appId) Gets a JSONObject of the preferences at the path + name specified
java.util.Map<java.lang.String,java.lang.Object>	getPreferencesMapByName(java.lang.String ticket, java.lang.String name, boolean latest, boolean shallow, long lastModifiedDate, java.lang.String appId, javax.servlet.http.HttpServletResponse response) Returns the preferences found with the given name, as a hashmap.
java.util.Map<java.lang.String,java.lang.Object>	savePreferencesByName(java.lang.String ticket, java.io.InputStream jsonStream, java.lang.String name, java.lang.String id, java.lang.String appId) * Saves the preferences within the given path with the given name.
java.util.Map<java.lang.String,java.lang.Object>	updatePreferencesByName(java.lang.String ticket, java.io.InputStream jsonStream, java.lang.String name, java.lang.String id, java.lang.String appId, boolean errorstate) Updates the preferences within the given path with the given name

Method Detail

getPreferencesMapByName

java.util.Map<java.lang.String,java.lang.Object> getPreferencesMapByName(java.lang.String ticket,
                                                                         java.lang.String name,
                                                                         boolean latest,
                                                                         boolean shallow,
                                                                         long lastModifiedDate,
                                                                         java.lang.String appId,
                                                                         javax.servlet.http.HttpServletResponse response)

Returns the preferences found with the given name, as a hashmap. Throws an exception if the object is not found. Returns "not-modified" as a string if the object has not been modified since last time user retrieved (using lastModifiedDate).

Parameters:

ticket -

name -

latest -

shallow -

path -

lastModifiedDate -

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

response -

Returns:

getPreferencesByName

org.json.JSONObject getPreferencesByName(java.lang.String ticket,
                                         java.lang.String name,
                                         java.lang.String appId)
                                  throws java.io.IOException,
                                         org.json.JSONException

Gets a JSONObject of the preferences at the path + name specified

Parameters:

ticket -

name -

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

Throws:

org.json.JSONException

java.io.IOException

getPreferencesByName

org.json.JSONObject getPreferencesByName(java.lang.String ticket,
                                         java.lang.String name,
                                         boolean shallow,
                                         java.lang.String appId)
                                  throws java.io.IOException,
                                         org.json.JSONException

Gets a JSON object of the preferences at the path + name specified; if shallow is true, we remove any complex keys.

Parameters:

ticket -

name -

shallow -

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

Throws:

java.io.IOException

org.json.JSONException

savePreferencesByName

java.util.Map<java.lang.String,java.lang.Object> savePreferencesByName(java.lang.String ticket,
                                                                       java.io.InputStream jsonStream,
                                                                       java.lang.String name,
                                                                       java.lang.String id,
                                                                       java.lang.String appId)

* Saves the preferences within the given path with the given name.

Parameters:

ticket -

jsonStream -

name -

id - value to prepend to the "_id" identifier for the JSON Object

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

updatePreferencesByName

java.util.Map<java.lang.String,java.lang.Object> updatePreferencesByName(java.lang.String ticket,
                                                                         java.io.InputStream jsonStream,
                                                                         java.lang.String name,
                                                                         java.lang.String id,
                                                                         java.lang.String appId,
                                                                         boolean errorstate)

Updates the preferences within the given path with the given name

Parameters:

ticket -

name -

path -

data -

id -

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns:

deletePreferencesByName

java.lang.String deletePreferencesByName(java.lang.String ticket,
                                         java.lang.String name,
                                         java.lang.String appId)

Deletes the preferences object at the given path + name.

Parameters:

ticket -

name -

appId - - This is the application ID for HPI, if multiple/separate config files are desired.

Returns: