| org.sakaiproject.api.privacy.PrivacyManager
All known Subclasses: org.sakaiproject.component.privacy.PrivacyManagerImpl,
| PrivacyManager | | public interface PrivacyManager (Code) | | PrivacyManager maintains and queries user privacy settings
An implementation can modify the behavior of the Privacy Service within sakai.properties:
privacy.manager.defaultViewable=true|false
a 'true' value will set privacy enabled for a user whose privacy settings are unknown
a 'false' value will set privacy disabled for a user whose privacy settings are unknown
If this value is not set, the default behavior will be to show users or make them viewable.
privacy.manager.overrideViewable=true|false
a 'true' value will make all users viewable in the system
a 'false' value will make all users hidden in the system
Do not set this value for normal operation (non overridden behavior).
privacy.manager.userRecordHasPrecedence=true|false
a 'true' value indicates that a user record has precedence over a system record
a 'false' value indicates that a system record has precedence over a user record
|
| Method Summary | |
| Set | findHidden(String contextId, Set userIds)
Get a set of users who have privacy enabled within a context. | | Set | findViewable(String contextId, Set userIds)
Get a set of users who have privacy disabled within a context. | | Set | getViewableState(String contextId, Boolean value, String recordType)
Get the state of the users within the specified context filtered by a Boolean value.
Implementation should delegate to AuthzGroupService to get users from Realm. | | Map | getViewableState(String contextId, String recordType)
Get the state of the users within the specified context.
Parameters:
contextId -
Parameters:
recordType - is a UUID i.e. | | public boolean | isViewable(String contextId, String userId)
Determine user privacy within the specified context. | | void | setViewableState(String contextId, String userId, Boolean value, String recordType)
Set user's privacy setting within the specified context given a record type.
Parameters:
contextId -
Parameters:
userId - (UUID)
Parameters:
value - using three-valued logic (True, False, NULL)
Parameters:
recordType - is a UUID i.e. | | void | setViewableState(String contextId, Map userViewableState, String recordType)
Set the state for each entry in the userMap.
Parameters:
contextId -
Parameters:
userMap - is a Map {key=userId, value=Boolean}
Parameters:
recordType - is a UUID i.e. |
| SYSTEM_RECORD_TYPE | | final public static String SYSTEM_RECORD_TYPE(Code) | | |
| USER_RECORD_TYPE | | final public static String USER_RECORD_TYPE(Code) | | |
| findHidden | | Set findHidden(String contextId, Set userIds)(Code) | | Get a set of users who have privacy enabled within a context. (Hidden)
Parameters:
contextId -
Parameters:
userIds - Set of org.sakakproject.service.legacy.User.id objects (UUID) |
| findViewable | | Set findViewable(String contextId, Set userIds)(Code) | | Get a set of users who have privacy disabled within a context. (Visible)
Parameters:
contextId -
Parameters:
userIds - Set of org.sakakproject.service.legacy.User.id objects (UUID) |
| getViewableState | | Set getViewableState(String contextId, Boolean value, String recordType)(Code) | | Get the state of the users within the specified context filtered by a Boolean value.
Implementation should delegate to AuthzGroupService to get users from Realm.
Parameters:
contextId -
Parameters:
value - filter (True, False, NULL)
Parameters:
recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType()) Set of users who satisfy the criteria |
| getViewableState | | Map getViewableState(String contextId, String recordType)(Code) | | Get the state of the users within the specified context.
Parameters:
contextId -
Parameters:
recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType()) Map {key=userId, value=Boolean} |
| isViewable | | public boolean isViewable(String contextId, String userId)(Code) | | Determine user privacy within the specified context.
Parameters:
contextId -
Parameters:
userId - (UUID) true if privacy is enabled for the user, false otherwise |
| setViewableState | | void setViewableState(String contextId, String userId, Boolean value, String recordType)(Code) | | Set user's privacy setting within the specified context given a record type.
Parameters:
contextId -
Parameters:
userId - (UUID)
Parameters:
value - using three-valued logic (True, False, NULL)
Parameters:
recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType()) |
| setViewableState | | void setViewableState(String contextId, Map userViewableState, String recordType)(Code) | | Set the state for each entry in the userMap.
Parameters:
contextId -
Parameters:
userMap - is a Map {key=userId, value=Boolean}
Parameters:
recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType()) |
|
|