public interface IStreamSummary extends IServerResource
In general, stream summary information excludes the stream paths, remapped, ignored, and no server-side operations can be performed against them; for full stream functionality you should use the full IStream interface.
Stream summaries are complete and not refreshable or updateable.
| Modifier and Type | Interface and Description |
|---|---|
static interface |
IStreamSummary.IOptions
Stream options are flags to configure stream behavior.
|
static class |
IStreamSummary.Type
Types of streams include 'mainline', 'release', 'development', 'virtual'
and 'task'.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Date |
getAccessed()
Get the date of the last 'integrate' using this stream.
|
java.lang.String |
getBaseParent()
Get the stream's base parent.
|
java.lang.String |
getDescription()
Get the stream's description (if any).
|
java.lang.String |
getName()
Get the alternate name of the stream.
|
IStreamSummary.IOptions |
getOptions()
Get the stream options
|
java.lang.String |
getOwnerName()
Get the name of the user who created this stream.
|
java.lang.String |
getParent()
Get the stream's parent.
|
java.lang.String |
getStream()
Get the stream's path in a stream depot.
|
IStreamSummary.Type |
getType()
Get the stream type
|
java.util.Date |
getUpdated()
Get the date specification was last modified.
|
boolean |
isChangeFlowsFromParent()
Is change flows from parent.
|
boolean |
isChangeFlowsToParent()
Is change flows to parent.
|
boolean |
isFirmerThanParent()
Is firmer than parent.
|
boolean |
isUnloaded()
Return the "unloaded" status for this stream.
|
void |
setAccessed(java.util.Date accessed)
Set the last-accessed date.
|
void |
setBaseParent(java.lang.String baseParent)
Set the stream base parent.
|
void |
setChangeFlowsFromParent(boolean changeFlowsFromParent)
Set (true/false) the stream's change flows from parent.
|
void |
setChangeFlowsToParent(boolean changeFlowsToParent)
Set (true/false) the stream's change flows to parent.
|
void |
setDescription(java.lang.String description)
Set the stream spec description.
|
void |
setFirmerThanParent(boolean firmerThanParent)
Set (true/false) the stream is firmer than parent.
|
void |
setName(java.lang.String name)
Set the name of this stream.
|
void |
setOptions(IStreamSummary.IOptions options)
Set the stream options.
|
void |
setOwnerName(java.lang.String ownerName)
Set the owner's name for this stream.
|
void |
setParent(java.lang.String parent)
Set the stream parent.
|
void |
setStream(java.lang.String stream)
Set the stream's path.
|
void |
setType(IStreamSummary.Type type)
Set the stream type.
|
void |
setUpdated(java.util.Date updated)
Set the last-updated date.
|
canRefresh, canUpdate, refresh, setServer, update, update, updatejava.lang.String getStream()
java.lang.String getName()
java.lang.String getOwnerName()
java.util.Date getUpdated()
java.util.Date getAccessed()
java.lang.String getDescription()
java.lang.String getParent()
IStreamSummary.Type getType()
IStreamSummary.IOptions getOptions()
boolean isFirmerThanParent()
boolean isChangeFlowsToParent()
boolean isChangeFlowsFromParent()
java.lang.String getBaseParent()
void setStream(java.lang.String stream)
stream - new stream's pathvoid setName(java.lang.String name)
name - new stream spec namevoid setOwnerName(java.lang.String ownerName)
ownerName - new owner's namevoid setUpdated(java.util.Date updated)
updated - new updated date.void setAccessed(java.util.Date accessed)
accessed - new accessed date.void setDescription(java.lang.String description)
description - new description string.void setParent(java.lang.String parent)
parent - new stream parent.void setType(IStreamSummary.Type type)
type - new stream type.void setOptions(IStreamSummary.IOptions options)
options - new stream options.void setFirmerThanParent(boolean firmerThanParent)
void setChangeFlowsToParent(boolean changeFlowsToParent)
void setChangeFlowsFromParent(boolean changeFlowsFromParent)
void setBaseParent(java.lang.String baseParent)
baseParent - new stream base parent.boolean isUnloaded()
Copyright © 2018 Perforce Software. All Rights Reserved.