com.starteam
Interface ISecurableContainer

All Known Implementing Classes:

Audit.Type, Change.Type, ChangePackage.Type, ChangeRequest.Type, Concept.Type, File.Type, Folder, Folder.Type, Group.Type, Item.Type, Label.Type, LiveObject.Type, MergePreview, Principal.Type, Project, Project.Type, PromotionModel.Type, PromotionState.Type, RecycleBin, Requirement.Type, Share.Type, Sprint.Type, Story.Type, Task.Type, TaskDependency.Type, Topic.Type, Trace.Type, TrackedObject.Type, TreeItem.Type, Type, TypedResource.Type, User.Type, VCMFolder, VersionedObject.Type, View, View.Type, ViewMember.Type, ViewMemberRevision.Type, WhiteBoard.Type, WorkRecord.Type

public interface ISecurableContainer

A container in the repository that can hold secured objects of a given type. Important Note: This interface is not intended to be implemented by client applications. We reserve the right to add methods in the future. Applications that implement this interface may not be compatible with future versions of the StarTeam SDK.

Method Summary

int	getID() returns the unique system ID for this securable container
ISecurableContainer	getParentContainer() If there are no container-level access rights for the given type explicitly assigned to this container, then the effective container-level access rights come from a parent container.
ACE[]	getRights(Type type) Gets the container-level access rights explicitly assigned to this container for objects of the given type.
Server	getServer() returns the server that this object belongs to
boolean	hasPermissions(PermissionCollection permissions, Type type) Determines whether or not the given permissions are granted to the logged in user for securable objects of the given type in this container.
boolean	isDeleted() determines whether or not this object has been deleted
void	setRights(Type type, ACE[] acl) Sets the container-level access rights explicitly assigned to this container for objects of the given type.

Method Detail

getParentContainer

ISecurableContainer getParentContainer()

If there are no container-level access rights for the given type explicitly assigned to this container, then the effective container-level access rights come from a parent container.

Returns:

This object's parent container.

getRights

ACE[] getRights(Type type)

Gets the container-level access rights explicitly assigned to this container for objects of the given type.

Parameters:

type - The type of the secured objects in this container.

Returns:

The container-level access rights for objects of the given type, or null if there are none assigned to this container.

See Also:

ACE, Type

setRights

void setRights(Type type,
               ACE[] acl)

Sets the container-level access rights explicitly assigned to this container for objects of the given type.

Parameters:

type - The type of the secured objects in this container.

acl - The access control list for this container, or null to remove any existing access rights.

See Also:

ACE, Type

hasPermissions

boolean hasPermissions(PermissionCollection permissions,
                       Type type)

Determines whether or not the given permissions are granted to the logged in user for securable objects of the given type in this container.

Parameters:

permissions - One or more permissions to be tested.

type - The type of the secured objects in this container.

Returns:

true if all the requested permissions are granted; false if at least one of the requested permissions is denied.

See Also:

Permission, Type

getID

int getID()

returns the unique system ID for this securable container

Returns:

the unique system ID for this securable container

getServer

Server getServer()

returns the server that this object belongs to

Returns:

the server that this object belongs to

isDeleted

boolean isDeleted()

determines whether or not this object has been deleted

Returns:

true if this object has been deleted