|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Stream
A proxy for a stream resource. A stream resource is an activity whose versions are baselines.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.CopyFlag |
Field Summary | |
---|---|
static PropertyNameList.PropertyName<ResourceList<Stream>> |
SOURCE_LIST
A list of all streams which are declared to merge to this stream. |
static PropertyNameList.PropertyName<Stream> |
TARGET
The stream to which changes in this stream are to be merged. |
static PropertyNameList.PropertyName<ResourceList<Version>> |
VERSION_LIST
A list of all the versions that are the current versions in this stream. |
static PropertyNameList.PropertyName<Workspace> |
WORKSPACE
A workspace that can be used to browse the contents of this stream. |
Fields inherited from interface javax.wvcm.Activity |
---|
ACTIVITY_CHECKOUT_LIST, ACTIVITY_VERSION_LIST, CURRENT_WORKSPACE_LIST, LATEST_VERSION_LIST, TASK_LIST |
Fields inherited from interface javax.wvcm.Resource |
---|
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST |
Method Summary | ||
---|---|---|
ResourceList.ResponseIterator<Baseline.CompareReport> |
doCompareReport(Baseline baseline,
Baseline.CompareFlag[] flags,
Feedback feedback)
Compare this Stream with a baseline. |
|
ResourceList.ResponseIterator<Baseline.CompareReport> |
doCompareReport(Stream stream,
Baseline.CompareFlag[] flags,
Feedback feedback)
Compare this Stream with another stream. |
|
|
doUpdate(ResourceList<T> sourceList,
Feedback feedback)
Update the VERSION_LIST of this stream to contain the versions
specified in the sourceList argument. |
|
ResourceList<Stream> |
getSourceList()
Get the SOURCE_LIST property. |
|
Stream |
getTarget()
Get the TARGET property. |
|
ResourceList<Version> |
getVersionList()
Get the VERSION_LIST property. |
|
Workspace |
getWorkspace()
Get the WORKSPACE property. |
|
void |
setTarget(Stream target)
Set the TARGET property. |
Methods inherited from interface javax.wvcm.Activity |
---|
doCreateGeneratedResource, doCreateResource, getActivityCheckoutList, getActivityVersionList, getCurrentWorkspaceList, getLatestVersionList, getTaskList, setTaskList, workspaceProvider |
Field Detail |
---|
static final PropertyNameList.PropertyName<ResourceList<Stream>> SOURCE_LIST
SOURCE_LIST
property is the computed inverse of the
TARGET
property.
getSourceList()
static final PropertyNameList.PropertyName<Stream> TARGET
getTarget()
,
setTarget(javax.wvcm.Stream)
static final PropertyNameList.PropertyName<ResourceList<Version>> VERSION_LIST
static final PropertyNameList.PropertyName<Workspace> WORKSPACE
Workspace.doUpdate(javax.wvcm.ResourceList, javax.wvcm.Feedback)
whose argument is this stream.
Method Detail |
---|
ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Baseline baseline, Baseline.CompareFlag[] flags, Feedback feedback) throws WvcmException
baseline
- the baseline being compared to this Stream.flags
- boolean flags for the compare report.feedback
- the properties available in the returned proxies.
WvcmException
- ReasonCode:
WvcmException.ReasonCode.METHOD_NOT_SUPPORTED
:
This resource does not support this report.
WvcmException.ReasonCode.BAD_ARGUMENT_TYPE
:
The resource identified by the baseline
argument must be a baseline.ResourceList.ResponseIterator<Baseline.CompareReport> doCompareReport(Stream stream, Baseline.CompareFlag[] flags, Feedback feedback) throws WvcmException
stream
- the stream being compared to this Stream.flags
- boolean flags for the compare report.feedback
- the properties available in the returned proxies.
WvcmException
- ReasonCode:
WvcmException.ReasonCode.METHOD_NOT_SUPPORTED
:
This resource does not support this report.
WvcmException.ReasonCode.BAD_ARGUMENT_TYPE
:
The resource identified by the stream
argument must be a stream.<T extends Resource> Stream doUpdate(ResourceList<T> sourceList, Feedback feedback) throws WvcmException
VERSION_LIST
of this stream to contain the versions
specified in the sourceList argument.
If VERSION_LIST
already contains a version from the same VersionHistory
as the source version already, that version is replaced by the source version.
Postconditions:
VERSION_LIST
of this Stream.
sourceList
- the list of resources specifying the versions whose target in this stream should be updated.
If a member of sourceList is an activity, it must not be a stream, and
each version in the Activity.ACTIVITY_VERSION_LIST
is a source version.
If a member of sourceList is a version-controlled resource,
the checked-in version of the member is a source version;
if that version-controlled resource is a folder, all members
of that folder are considered members of the sourceList.feedback
- Specifies optional feedback to the caller.
WvcmException
- An implementation may throw a single exception on the first error encountered,
or may attempt to update all of the source versions, with any errors accumulated in the
WvcmException.getNestedExceptions()
list.
WvcmException.ReasonCode.BAD_ARGUMENT_TYPE
:
The resources identified by the sourceList
argument must be versions, activities,
streams, or controllable resources.
WvcmException.ReasonCode.MUST_BE_CHECKED_IN
:
A version-controlled resource in the sourceList must be checked in.ResourceList<Stream> getSourceList() throws WvcmException
SOURCE_LIST
property.
SOURCE_LIST
property.
WvcmException
- if this Version was not created with
SOURCE_LIST
as a wanted property.Stream getTarget() throws WvcmException
TARGET
property.
TARGET
property.
WvcmException
- if this Version was not created with
TARGET
as a wanted property.ResourceList<Version> getVersionList() throws WvcmException
VERSION_LIST
property.
VERSION_LIST
property.
WvcmException
- if this Stream was not created with
VERSION_LIST
as a wanted property.Workspace getWorkspace() throws WvcmException
WORKSPACE
property.
WORKSPACE
property.
WvcmException
- if this Stream was not created with
WORKSPACE
as a wanted property.void setTarget(Stream target)
TARGET
property.
target
- the Stream
object that
identifies the TARGET
for this Stream.getTarget()
|
Generated Fri 14-Jan-2011 09:44 PM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |