com.ibm.ecm.json

Class JSONPrivilegesResponse

  1. java.lang.Object
  2. extended byjava.util.AbstractMap<K,V>
  3. extended byjava.util.HashMap
  4. extended bycom.ibm.json.java.JSONObject
  5. extended bycom.ibm.ecm.json.JSONResponse
  6. extended bycom.ibm.ecm.json.JSONPrivilegesResponse
All implemented interfaces:
JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.util.Map
  1. public class JSONPrivilegesResponse
  2. 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>

Constructor Summary

Constructor and Description
JSONPrivilegesResponse()

Method Summary

Modifier and Type Method and Description
  1. boolean
 getPrivAddDoc()
  1. boolean
 getPrivAddItem()
  1. boolean
 getPrivAddTeamspace()
  1. boolean
 getPrivAddTeamspaceTemplate()
  1. boolean
 getPrivFoldering()
  1. boolean
 getPrivSaveAndRetrieveSavedSearches()
  1. void
 setPrivAddDoc(boolean priv)
  1. void
 setPrivAddItem(boolean priv)
  1. void
 setPrivAddTeamspace(boolean priv)
  1. void
 setPrivAddTeamspaceTemplate(boolean priv)
  1. void
 setPrivFoldering(boolean priv)
  1. 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, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, 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

  1. public JSONPrivilegesResponse()

Method Detail

setPrivFoldering

  1. public void setPrivFoldering(boolean priv)

getPrivFoldering

  1. public boolean getPrivFoldering( )

setPrivAddItem

  1. public void setPrivAddItem(boolean priv)

getPrivAddItem

  1. public boolean getPrivAddItem()

setPrivAddDoc

  1. public void setPrivAddDoc(boolean priv)

getPrivAddDoc

  1. public boolean getPrivAddDoc()

setPrivSaveAndRetrieveSavedSearches

  1. public void setPrivSaveAndRetrieveSavedSearches( boolean priv)

getPrivSaveAndRetrieveSavedSearches

  1. public boolean getPrivSaveAndRetrieveSavedSearches( )

setPrivAddTeamspace

  1. public void setPrivAddTeamspace( boolean priv)

getPrivAddTeamspace

  1. public boolean getPrivAddTeamspace( )

setPrivAddTeamspaceTemplate

  1. public void setPrivAddTeamspaceTemplate( boolean priv)

getPrivAddTeamspaceTemplate

  1. public boolean getPrivAddTeamspaceTemplate( )