com.microsoft.tfs.core.clients.versioncontrol
Class WorkspacePermissionProfile

java.lang.Object
  extended by com.microsoft.tfs.core.clients.versioncontrol.WorkspacePermissionProfile

public class WorkspacePermissionProfile
extends java.lang.Object

A named collection of AccessControlEntry objects.

Since:
TEE-SDK-10.1
Thread-safety:
thread-compatible

Field Summary
static int BUILTIN_PROFILE_INDEX_PRIVATE
          The order index of the built-in "private" profile.
static int BUILTIN_PROFILE_INDEX_PUBLIC
          The order index of the built-in "public" profile.
static int BUILTIN_PROFILE_INDEX_PUBLIC_LIMITED
          The order index of the built-in "public limited" profile.
static java.lang.String BUILTIN_PROFILE_NAME_PRIVATE
          The name of the built-in "private" profile.
static java.lang.String BUILTIN_PROFILE_NAME_PUBLIC
          The name of the built-in "public" profile.
static java.lang.String BUILTIN_PROFILE_NAME_PUBLIC_LIMITED
          The name of the built-in "public limited" profile.
 
Constructor Summary
WorkspacePermissionProfile(java.lang.String profileName, AccessControlEntry[] accessControlEntries)
          Creates a permission profile with the given name and access control entires.
 
Method Summary
 AccessControlEntry[] getAccessControlEntries()
           
 int getBuiltinIndex()
          The index into the BuiltInProfiles array at which this WorkspacePermissionProfile may be found.
static WorkspacePermissionProfile[] getBuiltInProfiles()
           
 java.lang.String getName()
           
static WorkspacePermissionProfile getPrivateProfile()
           
static WorkspacePermissionProfile getPublicLimitedProfile()
           
static WorkspacePermissionProfile getPublicProfile()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BUILTIN_PROFILE_NAME_PRIVATE

public static final java.lang.String BUILTIN_PROFILE_NAME_PRIVATE
The name of the built-in "private" profile.

Constant Field Value:
"Private"
See Also:
Constant Field Values

BUILTIN_PROFILE_NAME_PUBLIC_LIMITED

public static final java.lang.String BUILTIN_PROFILE_NAME_PUBLIC_LIMITED
The name of the built-in "public limited" profile.

Constant Field Value:
"PublicLimited"
See Also:
Constant Field Values

BUILTIN_PROFILE_NAME_PUBLIC

public static final java.lang.String BUILTIN_PROFILE_NAME_PUBLIC
The name of the built-in "public" profile.

Constant Field Value:
"Public"
See Also:
Constant Field Values

BUILTIN_PROFILE_INDEX_PRIVATE

public static final int BUILTIN_PROFILE_INDEX_PRIVATE
The order index of the built-in "private" profile.

Constant Field Value:
0
See Also:
Constant Field Values

BUILTIN_PROFILE_INDEX_PUBLIC_LIMITED

public static final int BUILTIN_PROFILE_INDEX_PUBLIC_LIMITED
The order index of the built-in "public limited" profile.

Constant Field Value:
1
See Also:
Constant Field Values

BUILTIN_PROFILE_INDEX_PUBLIC

public static final int BUILTIN_PROFILE_INDEX_PUBLIC
The order index of the built-in "public" profile.

Constant Field Value:
2
See Also:
Constant Field Values
Constructor Detail

WorkspacePermissionProfile

public WorkspacePermissionProfile(java.lang.String profileName,
                                  AccessControlEntry[] accessControlEntries)
Creates a permission profile with the given name and access control entires.

Parameters:
profileName - the name of the profile (must not be null or empty)
accessControlEntries - the entries (not null, but may be empty)
Method Detail

getAccessControlEntries

public AccessControlEntry[] getAccessControlEntries()
Returns:
the access control entries for this profile

getName

public java.lang.String getName()
Returns:
the name of this profile

getBuiltinIndex

public int getBuiltinIndex()
The index into the BuiltInProfiles array at which this WorkspacePermissionProfile may be found. If this WorkspacePermissionProfile is not a built-in profile, this value will be -1.

Returns:
the build-in index of this profile

getBuiltInProfiles

public static WorkspacePermissionProfile[] getBuiltInProfiles()
Returns:
the built-in profiles that cover private, public limited, and public scenarios.

getPrivateProfile

public static WorkspacePermissionProfile getPrivateProfile()

getPublicLimitedProfile

public static WorkspacePermissionProfile getPublicLimitedProfile()

getPublicProfile

public static WorkspacePermissionProfile getPublicProfile()


© 2015 Microsoft. All rights reserved.