public interface

WebAccessControlList

com.microstrategy.web.objects.WebAccessControlList

Class Overview

The WebAccessControlList interface represents an access control list of an object. The access control list(ACL) of an object determines the users and groups which have access to the object. This interface is obtained from the WebObjectSecurity interface. Any changes made to this collection will not be saved to the Intelligence Server until the owner WebObjectInfo object is saved back to metadata. WebAccessControlList for an object can be edited for all object types, even for object types that are not generally editable.

Summary

Public Methods
abstract WebAccessControlEntry add(int entryType)
Adds a new WebAccessControlEntry to the collection.
abstract void clear()
Clears all access control entries from the collection.
abstract Enumeration elements()
Returns a java.util.Enumeration containing the objects in the collection.
abstract WebAccessControlEntry get(int index)
Returns the item at the given index in the collection.
abstract boolean isEmpty()
Returns true if the collection is empty, or false otherwise.
abstract WebAccessControlEntry remove(int index)
Removes the WebAccessControlEntry object from the given index in the collection.
abstract boolean remove(WebAccessControlEntry entry)
This method removes the given WebAccessControlEntry object from the collection.
abstract int size()
Returns the number of items in the collection.

Public Methods

public abstract WebAccessControlEntry add (int entryType)

Adds a new WebAccessControlEntry to the collection. The newly created object is returned from this method; it can then be modified appropriately.

Parameters
entryType The type of entry, from EnumDSSXMLAccessEntryType.
Returns

public abstract void clear ()

Clears all access control entries from the collection.

public abstract Enumeration elements ()

Returns a java.util.Enumeration containing the objects in the collection. The items in the collection will be objects of type WebAccessControlEntry.

Returns
  • A java.util.Enumeration containing the objects in the collection. The objects in the collection will be of type WebAccessControlEntry.

public abstract WebAccessControlEntry get (int index)

Returns the item at the given index in the collection.

Parameters
index The index of the item in the collection to return.
Returns

public abstract boolean isEmpty ()

Returns true if the collection is empty, or false otherwise.

Returns
  • Whether the collection is empty.

public abstract WebAccessControlEntry remove (int index)

Removes the WebAccessControlEntry object from the given index in the collection.

Parameters
index The index of the object to remove.
Returns
  • The object which was removed from the collection.

public abstract boolean remove (WebAccessControlEntry entry)

This method removes the given WebAccessControlEntry object from the collection.

Parameters
entry The entry to remove from the collection.
Returns
  • True if the operation succeeded,false otherwise.

public abstract int size ()

Returns the number of items in the collection.

Returns
  • The size of the collection.