com.ibm.ecm.json

Class JSONPrivilegesResponse

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

com.ibm.json.java.JSONObject

com.ibm.ecm.json.JSONResponse

com.ibm.ecm.json.JSONPrivilegesResponse

All Implemented Interfaces:

com.ibm.json.java.JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class JSONPrivilegesResponse
extends JSONResponse

This class structures the JSON used to represent a privileges response. This responses is returned for a getPrivileges request for a particular repository. It describes the repository level privileges that the user has, such as the ability to add documents and use search templates.

There are two ways to use this class:

1. In plug-in response filters for getPrivileges. This class is actually the JSONObject passed to the response filter, so it can be immediately cast, as in:

    JSONPrivilegesResponse jsonPrivilegesResponse = (JSONPrivilegesResponse) jsonResponse;
    

2. In a plug-in provided repository type, to format the response JSON appropriately for the getPrivileges request.

Since:

2.0.3

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JSONPrivilegesResponse()

Method Summary

Modifier and Type	Method and Description
boolean	getPrivAddDoc()
boolean	getPrivAddItem()
boolean	getPrivAddTeamspace()
boolean	getPrivAddTeamspaceTemplate()
boolean	getPrivFoldering()
boolean	getPrivSaveAndRetrieveSavedSearches()
void	setPrivAddDoc(boolean priv)
void	setPrivAddItem(boolean priv)
void	setPrivAddTeamspace(boolean priv)
void	setPrivAddTeamspaceTemplate(boolean priv)
void	setPrivFoldering(boolean priv)
void	setPrivSaveAndRetrieveSavedSearches(boolean priv)

Methods inherited from class com.ibm.ecm.json.JSONResponse

addErrorMessage, addInfoMessage, addWarningMessage, hasErrors

Methods inherited from class com.ibm.json.java.JSONObject

isValidObject, isValidType, parse, parse, parse, put, serialize, serialize, serialize, serialize, serialize, serialize, toString

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JSONPrivilegesResponse

public JSONPrivilegesResponse()

Method Detail

setPrivFoldering

public void setPrivFoldering(boolean priv)

getPrivFoldering

public boolean getPrivFoldering()

setPrivAddItem

public void setPrivAddItem(boolean priv)

getPrivAddItem

public boolean getPrivAddItem()

setPrivAddDoc

public void setPrivAddDoc(boolean priv)

getPrivAddDoc

public boolean getPrivAddDoc()

setPrivSaveAndRetrieveSavedSearches

public void setPrivSaveAndRetrieveSavedSearches(boolean priv)

getPrivSaveAndRetrieveSavedSearches

public boolean getPrivSaveAndRetrieveSavedSearches()

setPrivAddTeamspace

public void setPrivAddTeamspace(boolean priv)

getPrivAddTeamspace

public boolean getPrivAddTeamspace()

setPrivAddTeamspaceTemplate

public void setPrivAddTeamspaceTemplate(boolean priv)

getPrivAddTeamspaceTemplate

public boolean getPrivAddTeamspaceTemplate()