|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentLibraryACL
Represents the access control object for a DocumentLibrary
or the access control
object for a library resource (e.g. Authoring Templates)
Method Summary | |
---|---|
void |
addMembers(LibraryMemberRole role,
java.lang.String[] members)
Adds each member specified in the string array argument to the members of the specified LibraryMemberRole to this DocumentLibraryACL object. |
java.lang.String[] |
getInheritedMembers(LibraryMemberRole role)
Get the members who have inherited the specified role on the access control for this document library |
java.lang.String[] |
getMembers(LibraryMemberRole role)
Get the members who have the specified role explicitly granted on the access control for this document library |
boolean |
isInherited(LibraryMemberRole role)
Returns true if inheritance is enabled for the specified library member role on this DocumentLibraryACL object. |
boolean |
isPropagated(LibraryMemberRole role)
Returns true if propagation is enabled for the specified library member role on this DocumentLibraryACL object. |
void |
removeMembers(LibraryMemberRole role,
java.lang.String[] members)
Removes each member specified in the string array argument from the members of the specified LibraryMemberRole level of this DocumentLibraryACL object. |
void |
setInheritance(LibraryMemberRole role,
boolean inherit)
Sets if the LibraryMemberRole permissions will be inherited from the parent
of this DocumentLibraryACL object. |
void |
setPropagation(LibraryMemberRole role,
boolean propagate)
Sets if the LibraryMemberRole permissions will be propagated to the children
of this DocumentLibraryACL object. |
Method Detail |
---|
java.lang.String[] getMembers(LibraryMemberRole role)
role
- the library member role. See LibraryMemberRoles
for the list of available roles.
java.lang.String[] getInheritedMembers(LibraryMemberRole role)
role
- the library member role. See LibraryMemberRoles
for the list of available roles.
void addMembers(LibraryMemberRole role, java.lang.String[] members)
DocumentLibraryACL
object.
A member is only added if the element in the string array argument can be converted to a valid member.
role
- the library member role. See LibraryMemberRoles
for the list of available roles.members
- string array of members to be added under the given rolevoid removeMembers(LibraryMemberRole role, java.lang.String[] members)
DocumentLibraryACL
object.
A member is only removed if the element in the string array argument can be converted to a
valid member and already has access to this DocumentLibraryACL
object.
role
- the library member role. See LibraryMemberRoles
for the list of available roles.members
- string array of members to be removed under the given roleboolean isInherited(LibraryMemberRole role)
DocumentLibraryACL
object.
role
- the library member role. See LibraryMemberRoles
for the list of available roles.
void setInheritance(LibraryMemberRole role, boolean inherit)
LibraryMemberRole
permissions will be inherited from the parent
of this DocumentLibraryACL
object.
role
- the library member role. See LibraryMemberRoles
for the list of available roles.inherit
- a flag indicate whether inheritance is set to be enabledboolean isPropagated(LibraryMemberRole role)
DocumentLibraryACL
object.
role
- the library member role. See LibraryMemberRoles
for the list of available roles.
void setPropagation(LibraryMemberRole role, boolean propagate)
LibraryMemberRole
permissions will be propagated to the children
of this DocumentLibraryACL
object.
role
- the library member role to set propagation for. See LibraryMemberRoles
for the list of available roles.propagate
- a flag indicate whether propagation is set to be enabled
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |