org.apache.wvcm
Class ActivityImpl

java.lang.Object
  extended by org.apache.wvcm.ResourceImpl
      extended by org.apache.wvcm.ActivityImpl
All Implemented Interfaces:
Activity, Resource

public class ActivityImpl
extends ResourceImpl
implements Activity

Implementation of Activity.

Version:
$Revision: 1.1.1.1.2.3 $

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.wvcm.ResourceImpl
ResourceImpl.LoadedProperties, ResourceImpl.XmlPropertyValue
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.GenericResourceImpl
 
Field Summary
 
Fields inherited from class org.apache.wvcm.ResourceImpl
dnsp, MISSING_PROPERTY_VALUE
 
Constructor Summary
ActivityImpl(Location location)
          Constructor
 
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 that identify activities whose versions are treated as if they were members of the ActivityVersionList of this Activity.
 void setSubactivityList(java.util.List subactivityList)
          Update the SubactivityList property of this Activity.
 
Methods inherited from class org.apache.wvcm.ResourceImpl
accessor, addLockToken, commit, doBind, doCopy, doLock, doLock, doReadAccessControlList, doReadContent, doReadProperties, doRebind, doSearch, doUnbind, doUnlock, doUnlock, doWriteAccessControlList, doWriteContent, doWriteProperties, equals, folderAccessor, folderAccessor, getActiveLockTokens, getAttribute, getClientHttpMethod, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreationUser, getCreatorDisplayName, getDisplayName, getHttpMethod, getLastModified, getLockTokens, getModificationDate, getModificationUser, getOwner, getParentBindingList, getPrincipalFolderList, getPrivilegeFolderList, getProperty, getPropertyContainer, getPropertyNameList, getProviderList, getResourceIdentifier, getSupportedPrivilegeList, getUpdatedPropertyList, getWorkspaceFolderList, hashCode, listOfRemovedAttributes, listOfSetProperties, loadedProperties, location, removeAttribute, removeLockToken, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setHttpMethod, setHttpMethod, setProperty, setPropertyContainer, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
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
 

Constructor Detail

ActivityImpl

public ActivityImpl(Location location)
Constructor

Method Detail

setSubactivityList

public void setSubactivityList(java.util.List subactivityList)
Update the SubactivityList property of this Activity.

Specified by:
setSubactivityList in interface Activity
Parameters:
subactivityList - The list of Activity objects that will be the new value of the SubactivityList property.

getSubactivityList

public java.util.List getSubactivityList()
                                  throws WvcmException
Return a list of Activity objects that identify activities whose versions are treated as if they were members of the ActivityVersionList of this Activity.

Specified by:
getSubactivityList in interface Activity
Throws:
WvcmException - if this Activity was not created with PropertyName.SUBACTIVITY_LIST as a wanted property.
See Also:
getActivityVersionList()

doCreateResource

public void doCreateResource()
                      throws WvcmException
Create an activity on the server. The request will fail if a resource already exists at that location.

Specified by:
doCreateResource in interface Activity
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.

getActivityCheckoutList

public 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.

Specified by:
getActivityCheckoutList in interface Activity
Throws:
WvcmException - if this Activity was not created with PropertyName.ACTIVITY_CHECKOUT_LIST as a wanted property.

getActivityVersionList

public java.util.List getActivityVersionList()
                                      throws WvcmException
Return a list of Version objects that identify versions that were created for this Activity.

Specified by:
getActivityVersionList in interface Activity
Throws:
WvcmException - if this Activity was not created with PropertyName.ACTIVITY_VERSION_LIST as a wanted property.

doCheckin

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

Specified by:
doCheckin in interface 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.

getCurrentWorkspaceList

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

Specified by:
getCurrentWorkspaceList in interface Activity
Throws:
WvcmException - if this Activity was not created with PropertyName.CURRENT_WORKSPACE_LIST as a wanted property.
See Also:
Workspace.getCurrentActivityList()


Copyright (c) 2003 - Apache Software Foundation