|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wvcm.ResourceImpl
org.apache.wvcm.ControllableResourceImpl
org.apache.wvcm.ControllableFolderImpl
public class ControllableFolderImpl
Implementation of Folder.
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.ControllableResource |
---|
ControllableResource.Conflict, ControllableResource.Ignore, ControllableResource.MergePreviewReport, ControllableResource.Update |
Nested classes/interfaces inherited from interface javax.wvcm.Folder |
---|
Folder.Binding |
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 | |
---|---|
ControllableFolderImpl(Location location)
Constructor |
Method Summary | |
---|---|
void |
doBaselineControl()
Put this Folder under baseline control. |
void |
doBaselineControl(Baseline baseline)
Put this Folder under baseline control and initialize
it with the contents of the specified baseline. |
void |
doCreateResource()
Create a new persistent resource at the location identified by this ControllableResource . |
java.util.List |
doLocateByHistoryReport(java.util.List versionHistoryList,
PropertyNameList wantedPropertyList)
Return a list of ControllableResource objects
that identify the controllable resources that are members of
this Workspace and whose versionHistory property identifies
a member of the versionHistoryList parameter. |
java.util.Iterator |
doReadMemberList(PropertyNameList wantedPropertyList,
boolean deep)
Return an iterator of Resource objects that contain properties of
the resources that are bound members of this Folder . |
boolean |
getBaselineControllable()
Return whether the folder can be put under baseline control. |
java.util.List |
getBindingList()
Return a list of Binding objects that identify the bound members of this Folder . |
java.util.List |
getEclipsedList()
Return a list of String objects that identify the names of version-controlled resources in this Folder
that are eclipsed by non-version-controlled resources. |
java.util.Iterator |
readMemberList(PropertyNameList wantedPropertyList,
boolean deep)
Return an iterator of Resource objects that contain locally
available properties of the resources that are locally known
as members of this Folder . |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ControllableFolderImpl(Location location)
Method Detail |
---|
public void doCreateResource() throws WvcmException
ControllableResourceImpl
ControllableResource
. The request will
fail if a resource already exists at that location.
doCreateResource
in interface ControllableResource
doCreateResource
in class ControllableResourceImpl
WvcmException
- Preconditions:
public boolean getBaselineControllable() throws WvcmException
getBaselineControllable
in interface ControllableFolder
WvcmException
- if this Folder
was not created with
PropertyName.BASELINE_CONTROLLABLE
as a wanted property.doBaselineControl(javax.wvcm.Baseline)
public void doBaselineControl(Baseline baseline) throws WvcmException
Folder
under baseline control and initialize
it with the contents of the specified baseline.
doBaselineControl
in interface ControllableFolder
baseline
- The baseline used to initialize the folder.
Preconditions:
(cannot-add-to-existing-history): This Folder MUST NOT identify an existing resource.
(one-baseline-controlled-folder-per-history-per-workspace): There MUST NOT be another folder
in the workspace of this Folder whose ControlledConfiguration property
identifies a version-controlled configuration for the baseline history of that baseline.
Postconditions:
(create-controlled-configuration): A new folder is created at the location of this Folder,
and a new version-controlled configuration is created, whose RootFolder property
identifies the new folder. The ControlledConfiguration property of the new folder
identifies the new version-controlled configuration.
(select-existing-baseline): The CheckedIn property of the new version-controlled configuration
MUST have been set to identify the specified baseline.
A version-controlled member of the folder will be created for each version in the baseline,
where the version-controlled member will have the content of that version,
and will have the same name relative to the folder as the corresponding
version-controlled resource had when the baseline was created.
Any nested folders that are needed to provide the appropriate name
for a version-controlled member will be created.
WvcmException
- Preconditions:
public java.util.Iterator readMemberList(PropertyNameList wantedPropertyList, boolean deep) throws WvcmException
Resource
objects that contain locally
available properties of the resources that are locally known
as members of this Folder
. Locally available information is
information that is available on the client host
without communicating with the server.
readMemberList
in interface ControllableFolder
wantedPropertyList
- The list of properties to be retrieved.deep
- Whether to retrieve properties for all members of this Folder
.
WvcmException
doReadMemberList(javax.wvcm.PropertyNameList, boolean)
public java.util.List getEclipsedList() throws WvcmException
Folder
that are eclipsed by non-version-controlled resources.
getEclipsedList
in interface ControllableFolder
WvcmException
- if this Folder
was not created with
PropertyName.ECLIPSED_LIST
as a wanted property.public void doBaselineControl() throws WvcmException
Folder
under baseline control.
A version-controlled configuration resource is associated with
this Folder
, which allows versions of the configuration rooted at
this Folder
to be created by checking out and checking in the
version-controlled configuration resource.
A version of a configuration is called a "baseline".
doBaselineControl
in interface ControllableFolder
WvcmException
- Preconditions:
public java.util.List getBindingList() throws WvcmException
Folder
.
getBindingList
in interface Folder
WvcmException
- if this Folder
was not created with
PropertyNameList.PropertyName.BINDING_LIST
as a wanted property.public java.util.Iterator doReadMemberList(PropertyNameList wantedPropertyList, boolean deep) throws WvcmException
Resource
objects that contain properties of
the resources that are bound members of this Folder
.
If deep
is true
, then
all members of the folder (including this Folder
) are included.
doReadMemberList
in interface Folder
wantedPropertyList
- The list of properties to be retrieved.deep
- Whether to retrieve properties for
all members of this Folder
.
WvcmException
- Postconditions:
public java.util.List doLocateByHistoryReport(java.util.List versionHistoryList, PropertyNameList wantedPropertyList) throws WvcmException
ControllableResource
objects
that identify the controllable resources that are members of
this Workspace
and whose versionHistory property identifies
a member of the versionHistoryList
parameter.
doLocateByHistoryReport
in interface ControllableFolder
versionHistoryList
- A list of VersionHistory
objects that
are being located.wantedPropertyList
- The properties to be retrieved for the
returned version-controlled resources.
WvcmException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |