IProtectionEntry (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.admin
Interface IProtectionEntry

All Superinterfaces:: IMapEntry

All Known Implementing Classes:: ProtectionEntry

public interface IProtectionEntry
extends IMapEntry
extends IMapEntry

Describes a protection entry (line) in a Perforce protection table. These are described in more detail in the various main Perforce admin documentation pages.

Note that the pathExcluded methods return whether a path is excluded or unmapped from the user's permissions; this corresponds to the "-" (minus sign) prepended to the path on the p4 command version of p4 protects, and must be used to determine whether the path is accessible or not.

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IMapEntry
`IMapEntry.EntryType`

Field Summary

Fields inherited from interface com.perforce.p4java.core.IMapEntry
`EXCLUDE_PREFIX, ORDER_UNKNOWN, OVERLAY_PREFIX`

Method Summary
`String`	`getHost()` Gets the client host.
`String`	`getMode()` Gets the protection mode for this entry.
`String`	`getName()` Gets the name of the grantee (user or group).
`String`	`getPath()` Gets the depot path.
`boolean`	`isGroup()` Checks if the grantee is a group.
`boolean`	`isPathExcluded()` Checks if the path is excluded.
`void`	`setGroup(boolean group)` Sets the group indicator (true/false).
`void`	`setHost(String host)` Sets the client host.
`void`	`setMode(String mode)` Sets the protection mode for this entry.
`void`	`setName(String name)` Sets the name of the grantee (user or group).
`void`	`setPath(String path)` Sets the depot path.
`void`	`setPathExcluded(boolean pathExcluded)` Sets the path excluded indicator (true/false).

Methods inherited from interface com.perforce.p4java.core.IMapEntry
`getLeft, getLeft, getOrder, getRight, getRight, getType, setLeft, setOrder, setRight, setType, toString, toString`

Method Detail

getMode

String getMode()

Gets the protection mode for this entry.

Returns:: the protection mode

setMode

void setMode(String mode)

Sets the protection mode for this entry.

Parameters:: mode - the protection mode

isGroup

boolean isGroup()

Checks if the grantee is a group.

Returns:: true, if the grantee is a group.

setGroup

void setGroup(boolean group)

Sets the group indicator (true/false).

Parameters:: group - the group indicator (true/false).

getName

String getName()

Gets the name of the grantee (user or group).

Returns:: the name of the grantee

setName

void setName(String name)

Sets the name of the grantee (user or group).

Parameters:: name - the name of the grantee

getHost

String getHost()

Gets the client host.

Returns:: the client host

setHost

void setHost(String host)

Sets the client host.

Parameters:: host - the client host

getPath

String getPath()

Gets the depot path.

Returns:: the depot path

setPath

void setPath(String path)

Sets the depot path.

Parameters:: path - the depot path

isPathExcluded

boolean isPathExcluded()

Checks if the path is excluded.

Returns:: true, if the path is excluded

setPathExcluded

void setPathExcluded(boolean pathExcluded)

Sets the path excluded indicator (true/false).

Parameters:: pathExcluded - the path excluded indicator (true/false)