Package com.perforce.p4java.core

Interface IBranchSpecSummary

All Superinterfaces:

IServerResource

All Known Subinterfaces:

IBranchSpec

All Known Implementing Classes:

BranchSpec, BranchSpecSummary

public interface IBranchSpecSummary
extends IServerResource

Defines the summary Perforce branch metadata typically returned by the getBranchSummaryList() method, corresponding to "p4 branches" and similar.

In general, branch summary information excludes the branch view, and no server-side operations can be performed against them; for full branch functionality you should use the full IBranchSpec interface.

Branch summaries are complete and not refreshable or updateable.

Method Summary

Modifier and Type	Method	Description
Date	getAccessed()	Get the date of the last 'integrate' using this branch.
String	getDescription()	Get the branch's description (if any).
String	getName()	Get the name of this branch.
String	getOwnerName()	Get the name of the user who created this branch.
Date	getUpdated()	Get the date specification was last modified.
boolean	isLocked()	Return true if the branch spec is locked.
void	setAccessed(Date accessed)	Set the last-accessed date.
void	setDescription(String description)	Set the branch spec description.
void	setLocked(boolean locked)	Set whether the branch spec is locked or not.
void	setName(String name)	Set the name of this branch.
void	setOwnerName(String ownerName)	Set the owner's name for this branch.
void	setUpdated(Date updated)	Set the last-updated date.

Methods inherited from interface com.perforce.p4java.core.IServerResource

canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update

Method Details

getName

String getName()

Get the name of this branch.

Returns:

name

getOwnerName

String getOwnerName()

Get the name of the user who created this branch.

Returns:

owner

getUpdated

Date getUpdated()

Get the date specification was last modified.

Returns:

date

getAccessed

Date getAccessed()

Get the date of the last 'integrate' using this branch.

Returns:

date

getDescription

String getDescription()

Get the branch's description (if any).

Returns:

description

isLocked

boolean isLocked()

Return true if the branch spec is locked.

Returns:

true if locked

setName

void setName(String name)

Set the name of this branch. This will not change the name of the associated branch spec on the Perforce server unless you arrange for the update to server.

Parameters:

name - new branch spec name

setOwnerName

void setOwnerName(String ownerName)

Set the owner's name for this branch. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.

Parameters:

ownerName - new owner's name

setUpdated

void setUpdated(Date updated)

Set the last-updated date. This generally has no effect on the associated Perforce server version of this spec.

Parameters:

updated - new updated date.

setAccessed

void setAccessed(Date accessed)

Set the last-accessed date. This generally has no effect on the associated Perforce server version of this spec.

Parameters:

accessed - new accessed date.

setDescription

void setDescription(String description)

Set the branch spec description. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.

Parameters:

description - new description string.

setLocked

void setLocked(boolean locked)

Set whether the branch spec is locked or not. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.

Parameters:

locked - boolean lock status