Package com.marklogic.client.io

Interface DocumentMetadataHandle.DocumentPermissions

All Superinterfaces:

java.util.Map<java.lang.String,java.util.Set<DocumentMetadataHandle.Capability>>

Enclosing class:

DocumentMetadataHandle

public static interface DocumentMetadataHandle.DocumentPermissions
extends java.util.Map<java.lang.String,java.util.Set<DocumentMetadataHandle.Capability>>

Represents the permissions for a database document.

Nested Class Summary

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
void	add(java.lang.String role, DocumentMetadataHandle.Capability... capabilities)	Adds a role with one or more capabilities to the metadata that can be written for the document.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

add

void add(java.lang.String role,
         DocumentMetadataHandle.Capability... capabilities)

Adds a role with one or more capabilities to the metadata that can be written for the document.

Parameters:

role - the role for users permitted to access the document

capabilities - the permissions to be granted to users with the role