javax.wvcm
Interface Activity

All Superinterfaces:
Resource
All Known Implementing Classes:
ActivityImpl

public interface Activity
extends Resource

Represents an activity resource. See section 13 of RFC 3253.


Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.GenericResourceImpl
 
Method Summary
 void doCheckin(boolean keepCheckedOut, boolean forkOK)
          Apply doCheckin to each member of the ActivityCheckoutList of this Activity.
 void doCreateResource()
          Create an activity on the server.
 java.util.List getActivityCheckoutList()
          Return a list of ControllableResource objects that identify all version-controlled resources that are checked out to this Activity.
 java.util.List getActivityVersionList()
          Return a list of Version objects that identify versions that were created for this Activity.
 java.util.List getCurrentWorkspaceList()
          Return a list of Workspace objects that identify workspaces that refer to this Activity in their CurrentActivityList.
 java.util.List getSubactivityList()
          Return a list of Activity objects.
 void setSubactivityList(java.util.List subactivityList)
          Update the SubactivityList property of this Activity.
 
Methods inherited from interface javax.wvcm.Resource
doBind, doCopy, doLock, doLock, doReadAccessControlList, doReadContent, doReadProperties, doRebind, doSearch, doUnbind, doUnlock, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreationUser, getCreatorDisplayName, getDisplayName, getLastModified, getLockTokens, getModificationDate, getModificationUser, getOwner, getParentBindingList, getPrincipalFolderList, getPrivilegeFolderList, getProperty, getPropertyNameList, getProviderList, getResourceIdentifier, getSupportedPrivilegeList, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setProperty
 

Method Detail

doCreateResource

void doCreateResource()
                      throws WvcmException
Create an activity on the server.

Throws:
WvcmException - Preconditions:
(resource-must-be-null): A resource MUST NOT exist at the location of this Resource.
(location-ok): The location of this Activity MUST identify a valid location to create this Resource. A client can determine the location of folders that can contain activities from the ActivityFolderList property.
WvcmException - Postconditions:
(initialize-resource): A new activity resource exists at the location of this Resource.

doCheckin

void doCheckin(boolean keepCheckedOut,
               boolean forkOK)
               throws WvcmException
Apply doCheckin to each member of the ActivityCheckoutList of this Activity.

Parameters:
keepCheckedOut - passed into each checkin request.
forkOK - passed into each checkin request.
Throws:
WvcmException - Preconditions:
(atomic-activity-checkin): The server MAY fail the request if any of the checked-out resources in the ActivityCheckoutList of either that activity or any sub-activity of that activity cannot be checked in.
WvcmException - Postconditions:
(activity-checkin): The server MUST have applied the doCheckin request to each checked-out resource in the ActivityCheckoutList of both that activity and any sub-activity of that activity.

getActivityCheckoutList

java.util.List getActivityCheckoutList()
                                       throws WvcmException
Return a list of ControllableResource objects that identify all version-controlled resources that are checked out to this Activity.

Throws:
WvcmException - if this Activity was not created with ACTIVITY_CHECKOUT_LIST as a wanted property.

getActivityVersionList

java.util.List getActivityVersionList()
                                      throws WvcmException
Return a list of Version objects that identify versions that were created for this Activity. Multiple versions of a single version history can be selected by an activity's ActivityVersionList property, but all ActivityVersionList versions from a given version history must be on a single line of descent from the root version of that version history.

Throws:
WvcmException - if this Activity was not created with ACTIVITY_VERSION_LIST as a wanted property.

getCurrentWorkspaceList

java.util.List getCurrentWorkspaceList()
                                       throws WvcmException
Return a list of Workspace objects that identify workspaces that refer to this Activity in their CurrentActivityList.

Throws:
WvcmException - if this Activity was not created with CURRENT_WORKSPACE_LIST as a wanted property.
See Also:
Workspace.getCurrentActivityList()

getSubactivityList

java.util.List getSubactivityList()
                                  throws WvcmException
Return a list of Activity objects. An activity behaves as if its ActivityVersionList is extended by the ActivityVersionList of each activity identified in the SubactivityList. In particular, the versions in this extended set MUST be on a single line of descent, and when an activity selects a version for merging, the latest version in this extended set is the one that will be merged.

Throws:
WvcmException - if this Activity was not created with SUBACTIVITY_LIST as a wanted property.
See Also:
getActivityVersionList()

setSubactivityList

void setSubactivityList(java.util.List subactivityList)
Update the SubactivityList property of this Activity. A server MAY reject attempts to modify the SubactivityList of an activity.

Parameters:
subactivityList - The list of Activity objects that will be the new value of the SubactivityList property.


Copyright (c) 2003 - Apache Software Foundation