com.starteam

Interface ISecurable

All Known Implementing Classes:

Audit, ChangePackage, ChangeRequest, Concept, File, Filter, Folder, Item, KanbanBoard, LinkToTraceAdapter, MergePreview, Plan, Project, PromotionState, Query, RecycleBin, Requirement, Review, Sprint, Story, Swimlane, Task, Test, TestRun, Topic, Trace, TreeItem, VCMFolder, View, ViewMember, WhiteBoard

public interface ISecurable

An object that can be secured in the repository. 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

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

Method Detail

getParentContainer

ISecurableContainer getParentContainer()

If there are no access rights explicitly assigned to this object, then the effective access rights come from a parent container.

Returns:

This object's parent container.

See Also:

ISecurableContainer

getType

Type getType()

If there are no access rights explicitly assigned to this object, then the effective access rights come from a parent container. Access rights in the parent container are type-specific.

Returns:

This object's type.

See Also:

ISecurable.getParentContainer(), Type

getRights

ACE[] getRights()

Gets the access rights explicitly assigned to this object.

Returns:

The access rights explicitly assigned to this object.

See Also:

ACE

setRights

void setRights(ACE[] acl)

Sets the access rights explicitly assigned to this object.

Parameters:

acl - The new access control list to be assigned to this object, or null to remove any existing access rights.

See Also:

ACE

hasPermissions

boolean hasPermissions(PermissionCollection permissions)

Determines whether or not the given permissions are granted to the logged in user for this securable object.

Parameters:

permissions - One or more permissions to be tested.

Returns:

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

See Also:

Permission

getID

int getID()

returns the unique system ID for this securable

Returns:

the unique system ID for this securable

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