|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Activity
A proxy for an activity resource. An activity resource selects a set of versions that are on a single "line of descent", where a line of descent is a sequence of versions connected by successor relationships. Activities appear under a variety of names in existing versioning systems. When an activity is used to capture a logical change, it is commonly called a "change set". When an activity is used to capture a line of descent, it is commonly called a "branch".
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.CopyFlag |
Field Summary | |
---|---|
static PropertyNameList.PropertyName<ResourceList<ControllableResource>> |
ACTIVITY_CHECKOUT_LIST
The computed inverse of the ControllableResource.ACTIVITY property. |
static PropertyNameList.PropertyName<ResourceList<Version>> |
ACTIVITY_VERSION_LIST
The computed inverse of the Version.ACTIVITY property. |
static PropertyNameList.PropertyName<ResourceList<Workspace>> |
CURRENT_WORKSPACE_LIST
The computed inverse of the Workspace.CURRENT_ACTIVITY and Workspace.STREAM properties
(i.e., a workspace is in the {#CURRENT_WORKSPACE_LIST} if it is identified in the
Workspace.CURRENT_ACTIVITY or Workspace.STREAM of that workspace. |
static PropertyNameList.PropertyName<ResourceList<Version>> |
LATEST_VERSION_LIST
The result of VersionHistory.doLatestActivityVersionReport(javax.wvcm.Activity, javax.wvcm.Feedback)
on each VersionHistory with a version in ACTIVITY_VERSION_LIST . |
static PropertyNameList.PropertyName<ResourceList<Task>> |
TASK_LIST
The tasks that this activity is performing. |
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 | |
---|---|
Activity |
doCreateGeneratedResource(Feedback feedback)
Create a new persistent activity, where the provider can allocate the location for the new activity. |
Activity |
doCreateResource(Feedback feedback)
Create a new persistent activity. |
ResourceList<ControllableResource> |
getActivityCheckoutList()
Get the ACTIVITY_CHECKOUT_LIST property. |
ResourceList<Version> |
getActivityVersionList()
Get the ACTIVITY_VERSION_LIST property. |
ResourceList<Workspace> |
getCurrentWorkspaceList()
Get the CURRENT_WORKSPACE_LIST property. |
ResourceList<Version> |
getLatestVersionList()
Get the LATEST_VERSION_LIST property. |
ResourceList<Task> |
getTaskList()
Get the TASK_LIST property. |
void |
setTaskList(ResourceList<Task> taskList)
Set the TASK_LIST property. |
WorkspaceProvider |
workspaceProvider()
Get the workspace provider of this resource. |
Field Detail |
---|
static final PropertyNameList.PropertyName<ResourceList<ControllableResource>> ACTIVITY_CHECKOUT_LIST
ControllableResource.ACTIVITY
property.
static final PropertyNameList.PropertyName<ResourceList<Version>> ACTIVITY_VERSION_LIST
Version.ACTIVITY
property.
Multiple versions of a single version history can be selected by an activity's
ACTIVITY_VERSION_LIST
property, but all ACTIVITY_VERSION_LIST
versions
from a given version history must be on a single line of descent from
the root version of that version history.
static final PropertyNameList.PropertyName<ResourceList<Workspace>> CURRENT_WORKSPACE_LIST
Workspace.CURRENT_ACTIVITY
and Workspace.STREAM
properties
(i.e., a workspace is in the {#CURRENT_WORKSPACE_LIST} if it is identified in the
Workspace.CURRENT_ACTIVITY
or Workspace.STREAM
of that workspace.
static final PropertyNameList.PropertyName<ResourceList<Version>> LATEST_VERSION_LIST
VersionHistory.doLatestActivityVersionReport(javax.wvcm.Activity, javax.wvcm.Feedback)
on each VersionHistory with a version in ACTIVITY_VERSION_LIST
.
static final PropertyNameList.PropertyName<ResourceList<Task>> TASK_LIST
Method Detail |
---|
Activity doCreateGeneratedResource(Feedback feedback) throws WvcmException
Postconditions:
feedback
- Specifies optional feedback to the caller.
WvcmException
- ReasonCode:
WvcmException.ReasonCode.METHOD_NOT_SUPPORTED
:
If the provider does not support the creation of activities, this request MUST fail.
A client can determine a valid location for this method
with a Provider.rootLocation()
request.Activity doCreateResource(Feedback feedback) throws WvcmException
Postconditions:
feedback
- Specifies optional feedback to the caller.
WvcmException
- ReasonCode:
WvcmException.ReasonCode.RESOURCE_ALREADY_EXISTS_AT_LOCATION
:
If a resource already
exists at the location of this Resource, the request MUST fail.
WvcmException.ReasonCode.CANNOT_CREATE_AT_THIS_LOCATION
:
If the location of this Activity
does not identify a valid location to create an activity, the request MUST fail.
A client can use doCreateGeneratedResource(javax.wvcm.Feedback)
if it does not know a valid
location for creating an activity.ResourceList<ControllableResource> getActivityCheckoutList() throws WvcmException
ACTIVITY_CHECKOUT_LIST
property.
ACTIVITY_CHECKOUT_LIST
property.
WvcmException
- if this Activity was not created with
ACTIVITY_CHECKOUT_LIST
as a wanted property.ResourceList<Version> getActivityVersionList() throws WvcmException
ACTIVITY_VERSION_LIST
property.
ACTIVITY_VERSION_LIST
property.
WvcmException
- if this Activity was not created with
ACTIVITY_VERSION_LIST
as a wanted property.ResourceList<Workspace> getCurrentWorkspaceList() throws WvcmException
CURRENT_WORKSPACE_LIST
property.
CURRENT_WORKSPACE_LIST
property.
WvcmException
- if this Activity was not created with
CURRENT_WORKSPACE_LIST
as a wanted property.ResourceList<Version> getLatestVersionList() throws WvcmException
LATEST_VERSION_LIST
property.
LATEST_VERSION_LIST
property.
WvcmException
- if this Activity was not created with
LATEST_VERSION_LIST
as a wanted property.ResourceList<Task> getTaskList() throws WvcmException
TASK_LIST
property.
TASK_LIST
property.
WvcmException
- if this Activity was not created with
TASK_LIST
as a wanted property.void setTaskList(ResourceList<Task> taskList)
TASK_LIST
property.
taskList
- The list of tasks that are being performed by this activity.getTaskList()
WorkspaceProvider workspaceProvider()
WorkspaceProvider
for this Resource.
|
Generated Sat 22-Feb-2014 01:07 AM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |